CryoSPARC v4.1 Updates

4 releases from December 12, 2022 to January 23, 2023

New

Added a new Restack Particles job for consolidating particle files. More information available in the guide.

New

New 3D Classification parameters

  • Added an option (default: on) to re-order classes by number of particles at the end of processing
  • Added maximum F-EM iterations which will terminate classification even if convergence criteria are not met
New

In addition to CPU memory used, available CPU memory can now be displayed in the job event log. It is also displayed in the job log PDF.

New

Added options to sort projects by their size.

New

Added a new project-level action to delete detached projects from the CryoSPARC database. More information is available in the updated data management guide.

New

Exposure preview context menus in CryoSPARC Live now feature a button to reject/unreject the exposure.

Update

Additional timestamp information added to job output log.

Update

The job preview dialog project and workspace breadcrumbs have been updated to native browser links to allow them to be opened in a new window or tab.

Update

Buttons with a corresponding keyboard shortcut will now show that shortcut in their tooltips.

Update

The tree view now supports using the shift key to toggle the outputs view on all job cards.

Update

Multi-select context menu improvements

  • The job card action menu trigger button will now always display that job's specific action menu even with multiple jobs selected
  • Opening the action menu on a job card not included in a multi-selection will show that job's specific action menu instead of the multi-select action menu
  • The multi-select action menu can now be opened by right clicking the workspace background and not just jobs within the selection
Fixed

In 3D classification, ensure solvent mask is generated from consensus volume if (only) a focus mask is supplied.

Fixed

Fix a memory leak in 3D Classification related to plotting. With the fix applied, peak memory usage should be significantly reduced, with jobs that have a large number (50+) of classes seeing the most benefit (up to a 75% reduction).

Fixed

Fix incorrect batch size during class ESS tuning in 3D Classification that required excessive amounts of GPU memory.

Fixed

Errors reading TIFF files during import movies could cause abnormal termination.

Fixed

Event log would flash and jump in a perpetual loading state in some cases.

Fixed

Job description would automatically close while being edited in some cases.

Fixed

Clearing intermediate results on jobs with empty output result groups would cause an error.

Fixed

Jobs exported from this version may now be correctly imported in older versions of CryoSPARC.

Fixed

Added a guard against creating redundant outputs in Extract From Micrographs (CPU).

Patch Release
Update

Improved database startup reliability following updates.

Fixed

Prevent wrong generation dataset error for some jobs that process a large amount of micrographs or particles.

Fixed

Prevent Extract From Micrographs (GPU) job from using too much GPU memory, causing exposures to fail with cufftAllocFailed or cufftInternalError.

Fixed

Fixed a bug affecting some OSEs in the dependency installation for 3DFlex jobs (cryosparcw install-3dflex) that caused a gcc compilation error during the PyCUDA build.

Fixed

Fixed a bug that caused 3DVA display to fail when using a subset of variability components.

Fixed

Fixed a bug causing restarted jobs with GPU requirements to override the scheduler and jump to the front of the queue on the specified lane.

New

3D Flexible Refinement (3DFlex) (Beta) is a motion-based deep generative model for continuous heterogeneity. It can model non-rigid motion and flexibility of a protein molecule across its conformational landscape, and can use the motion model to combine signal from particle images in different conformations to improve refinement resolution in flexible regions.

3DFlex
New

cryosparc-tools (Beta) is an open-source Python library that enables powerful scripting access to CryoSPARC.

  • Programmatically read and write exposure, particle and volume data
  • Easily perform advanced operations on metadata (alignments, CTF, etc) and programmatically insert modified data back into CryoSPARC
  • Access project, workspace and job data
  • Build and run jobs to orchestrate custom cryo-EM workflows
  • Extend CryoSPARC functionality with third-party software packages
  • cryosparc-tools is on GitHub and available via pip and can be used outside of the CryoSPARC environment in your own programs and tools
  • Read the full documentation including example usage
CryoSPARC Tools Architecture Diagram
New

Multi-select actions allow for cloning multiple jobs at once, cloning a chain of jobs between two selections, queuing, clearing or deleting multiple jobs at once, and more. Learn more about multi actions here.

CryoSPARC multi-select actions menu
New

Restart job action allows a job to be restarted from a killable or clearable state. This new action kills, clears, and queues the job to the same lane with the same parameters with which it was initially run.

CryoSPARC restart job action
New
New

Ability for admins to restrict users to view and run jobs on specific lanes using the Lane Restrictions Tab on the Admin Panel. See Guide: Lane Assignments and Restrictions for more details. By default, when a CryoSPARC user is created, they are assigned all existing lanes.

CryoSPARC user lane restrictions panel
Update

Multiple updates to Job: 3D Classification. Refer to the job guide and updated Tutorial: 3D Classification for details.

  • Per-particle scale optimization is now built-in to the job
  • New 'class flow matrix' diagram helps to visualize class changes across F-EM iterations
  • New 'Δ' text column lists class size differences across F-EM iterations
  • Updated aesthetics for class flow diagram to improve clarity of edges
  • Unique volumes are no longer required for initialization
CryoSPARC 3D Classification flow matrix
Update
Update

Job: Symmetry Expansion now includes a parameter that enables splitting the output particle stack by the applied symmetry operator.

Update
Update

Job: Select 2D Classes now exports an .mrc stack containing only selected classes, and an .mrc stack containing only rejected classes.

Update

Job: 2D Classification now by default removes duplicate particles after classification based on a minimum separation distance between pick locations.

Update

2D Classification jobs that perform binary class re-centering now show the binary masks used, generated from the specified threshold.

Update
Update
Update
Update

Ability to prevent CryoSPARC from requesting external resources external HTTPS resources used to display information modules on the homepage by setting CRYOSPARC_DISABLE_EXTERNAL_REQUESTS environment variable to true. Details.

Update

The CryoSPARC updater (cryosparcm update) has several enhancements, including:

  • Ability to only download the master and worker update packages without doing a full update. Read more here
  • Ability to skip downloading the master and worker update packages, and update using the previously-downloaded packages. Read more here
  • The CryoSPARC instance is only shut down after confirming the master and worker update packages are downloaded and valid, reducing downtime during an update
  • The output log of the update process is now written to cryosparc_master/run/update.log, and can be read any time using cryosparcm log update.
Update

Ability for instances with the CRYOSPARC_DISABLE_IMPORT_ON_MASTER environment variable to queue jobs to the master node.

Update
Update

Project directories can now be renamed by using the edit button beside the "directory" field in the details section of the project sidebar.

Update

Job: Reassign Particles to Micrographs will now copy the exposure group data from the micrographs to the particles if the particles.ctf slot and the exposure.ctf or exposure.mscope_params slots are connected.

Update

Job: Import Movies info tag now displays the size of each exposure and number of frames.

Update

When viewing jobs in a flattened view (e.g., all jobs in a project) the clone job action sub-menu now provides all workspaces as options to clone into.

Update

Restrict some cryosparcm commands to owner UNIX account, including createuser, updateuser, resetpassword and patch.

Update

Close open file handles during Import jobs.

Update

User IDs are now visible in the output of cryosparcm listusers

Update

job_type variable is now added to available cluster submission script variables provided by CryoSPARC. This value can be used for tracking which CryoSPARC job types are running on a cluster lane or for determining resource requirements for a cluster script.

Update

qstat_cmd_tpl and qdel_cmd_tpl will have access to the same variables that are injected into send_cmd_tpl, including any user-configured custom variables.

Update

Additional logging for master cache functions.

Update

Interactive jobs now print out more informative errors in a scrollable, clearable log at the top of the interactive panel in the job dialog.

Fixed

Resolved an issue where when viewing all parameters of a job within the comparison dialog incorrect custom parameter values were shown.

Fixed

Jobs created via quick actions are no longer created in a different workspace or session than the one currently selected.

Fixed

NCC score slider in CryoSPARC Live no longer loses all picks when set to 0.

Fixed
Fixed
Fixed

Fixed bug in Job: 3D Variability Analysis that prevented job from completing when number of components is set to 1.

Fixed

The job dialog outputs tab now correctly displays the name of low-level results.

Fixed

Fixed a bug that prevented correct download links for each output group of a job from being displayed within the sidebar details panel when a job is selected.

Fixed

Fixed a bug that prevented multiple entities from being selected via the checkbox within the table view.

Fixed

Scroll bars are no longer shown overtop of menus and dialogs in Safari.

Fixed

Hostname no longer appears twice on instance management cards.

Fixed

The sidebar action panel now collapses automatically after an option has been selected.

Fixed

Fixed issue where a "Not Found" message would flash in the sidebar on load.

Fixed

Fixed bug that resulted in incorrect cropping of some PNG figures in the event log.

Fixed

Fixed bug in Job: Simulate Data that caused incorrect particles' CTF parameters when "apply CTF" was disabled.

Fixed
Fixed
Fixed
Fixed
Fixed

Fixed bug in CryoSPARC Live that caused failed exposures to be double-counted as queued exposures.

Fixed

Fixed issue where retrieving CryoSPARC Live sessions via the CLI would fail.

Fixed

Fixed issue where slow database command response times would cause problems when configuring the database (e.g., updating CryoSPARC).

Fixed

Extensive Workflow now runs on a worker with 32GB of RAM.

Fixed

Installation and update are now cancelled if Python dependency installation fails.

Fixed

Prevent job heartbeat failures following multiple disconnects and reconnects.

Fixed

Fixed bug that raised a JSONDecodeError when calling cryosparcm eventlog on Job: 3D Variability Display.

Fixed

Fixed bug that caused command_core, command_rtp and command_vis logs to not be properly rotated.

Fixed

Event logs for motion correction and extraction jobs now count movies/micrographs starting from one instead of starting from zero (e.g. "completed 20/20" instead of "completed 19/20").

Fixed

Fixed bug whereby ice thickness reported by Patch CTF (including in CryoSPARC Live) can be NaN.

Fixed

Prevent file reading operations from failing on systems that incorrectly seek

Fixed

Fixed bug that caused extracted particle count not to be displayed on the details panel when viewing a Live session