Tutorial: CryoSPARC Live Session Data Management

In cryoSPARC v3.0.0, we've introduced a new toolset that allows you to manage the data created by your cryoSPARC Live Sessions.

Overview

To access the Session Management page, click on the "Manage Data" button at the top of the Browse Sessions Page.

CryoSPARC Live Session Management page.

Metadata Available

You will be greeted with a table that shows an overview of all Projects and Live Sessions including:

  • Project and Session UID

  • Project or Session title

  • Status of the Session (e.g., Running, Paused, Marked Completed)

  • File sizes of the following data categories (Projects show the total across all Sessions within that project)

    • Raw import data

    • Motion corrected micrographs

    • Exposure thumbnails

    • Extracted particles

    • Metadata

  • Date and time the Project or Session was created

  • Date and time the session was last Paused (if applicable)

  • Date and time the session was Marked Completed (if applicable)

  • Project actions:

    • Refresh statistics for all sessions within a Project (update file sizes)

    • Download a list of all Project statistics (all files linked to each session, organized into groups)

  • Session actions:

    • Refresh statistics for a particular Session (update file sizes)

    • Navigate to the Live Session interface

    • Additional actions than can be performed on a category of data within a session is described below

Upon first visit to the Data Management page, you will need to click the "Refresh Project Stats" or "Refresh Session Stats" action to populate the file sizes of each category.

You can only perform session actions on sessions that are in Completed status. To mark a session as completed, navigate to the session, and click the Mark Completed button in the Session Information sub-tab under the Configuration tab.

Actions

Project Actions

You can download a list of file paths (JSON format) of all sessions within a project (organized into categories) by clicking on the 'Download Project Stats' button in the 'Action' column.

Session Actions

You can perform actions on all five categories in completed sessions by clicking a cell in the table:

Clicking on a cell will open up the actions menu for each data type.
  1. Download a list of file paths (JSON format) for a particular category (such as motion corrected micrographs) via the browser for use in an external archiving utility

    • Available for all categories except for thumbnails

  2. Mark a category as 'archived', 'archiving', or 'active'

    • Available for all categories except for thumbnails

  3. Mark a category as 'deleted' (for when you have used an external tool to delete all files associated with that category)

    • Available for all categories except for thumbnails

  4. Delete data from a particular category (cryoSPARC will delete all files associated with the category)

    • Available for all categories except for raw data

    • A confirmation dialog will be presented before any data is deleted:

Interface Features

Right-clicking over any cell other than file size data will present will three options:

Interface features available
  1. Refresh table data

  2. Expand all projects (show all Sessions across all Projects)

  3. Collapse all Projects (show only Project totals)

Enabling Access to the Tool

All cryoSPARC users are able to:

  1. View the data management table and refresh file sizes via the 'Action' column → 'Refresh Project Stats'/'Refresh Session Stats'

  2. Download the JSON list of files for a category within a session or across a project

In order to mark a category as active/archiving/archived/deleted or delete data, users must have access enabled in the admin panel (in the main cryoSPARC web application):

Admin users can click on the button within the 'Live Data Management' column to toggle the ability for a user to modify Live session data:

Change whether a user can execute actions in the session management page.