CryoSPARC v4.1.0
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 jointly learns a single canonical 3D density map of the particle, latent coordinates for each particle image, and a flow generator network. Given a latent position, the flow generator outputs a 3D deformation field mapping the canonical density to a particular conformation
- 3DFlex requires tuning of some parameters and optionally can take custom inputs defining geometry and topology of the target molecule
- Read an in-depth guide, including new example results using 3DFlex
- Watch a walkthrough video covering how to using the new algorithm in CryoSPARC
- Read the bioRxiv preprint from April 2021. An updated paper will be made available soon.
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
pipand can be used outside of the CryoSPARC environment in your own programs and tools - Read the full documentation including example usage
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.
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.
Ability to configure custom variables for use in cluster submission scripts directly through the Cluster Configuration Tab in the Admin Panel. Custom variables can be configured at the instance level, target level and job level. See Guide: Configuring Custom Variables for Cluster Job Submission Scripts for more details.
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.
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
Job: Remove Duplicate Particles now allows for duplicate rejection based on 2D and 3D alignment error, in addition to NCC score.
Job: Symmetry Expansion now includes a parameter that enables splitting the output particle stack by the applied symmetry operator.
Job: Volume Alignment Tools now allows for application of arbitrary rotations to input volumes, particles, and masks.
Job: Select 2D Classes now exports an .mrc stack containing only selected classes, and an .mrc stack containing only rejected classes.
Job: 2D Classification now by default removes duplicate particles after classification based on a minimum separation distance between pick locations.
2D Classification jobs that perform binary class re-centering now show the binary masks used, generated from the specified threshold.
New project-level option to set the default path to a DeepEMhancer executable. If set, all new DeepEMhancer jobs will automatically be populated with the project-level path.
Job: Import Particle Stack now copies rlnAutopickFigureOfMerit into CryoSPARC's pick_stats/ncc_score upon import, if available.
Job: Global CTF Refinement now allows for initializing the spherical aberration to a custom value, prior to fitting.
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.
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 usingcryosparcm log update.
Ability for instances with the CRYOSPARC_DISABLE_IMPORT_ON_MASTER environment variable to queue jobs to the master node.
The signatures for the CLI functions delete_project and delete_workspace have changed. Please see the cryosparcm cli reference page on the CryoSPARC Guide for more information.
Project directories can now be renamed by using the edit button beside the "directory" field in the details section of the project sidebar.
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.
Job: Import Movies info tag now displays the size of each exposure and number of frames.
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.
Restrict some cryosparcm commands to owner UNIX account, including createuser, updateuser, resetpassword and patch.
Close open file handles during Import jobs.
User IDs are now visible in the output of cryosparcm listusers
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.
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.
Additional logging for master cache functions.
Interactive jobs now print out more informative errors in a scrollable, clearable log at the top of the interactive panel in the job dialog.
Resolved an issue where when viewing all parameters of a job within the comparison dialog incorrect custom parameter values were shown.
Jobs created via quick actions are no longer created in a different workspace or session than the one currently selected.
NCC score slider in CryoSPARC Live no longer loses all picks when set to 0.
Fixed ValueError in Manually Curate Exposures due to outliers during histogram creation.
Fixed bugs in Job: Gctf (Wrapper) that caused local CTF refinement to fail.
Fixed bug in Job: 3D Variability Analysis that prevented job from completing when number of components is set to 1.
The job dialog outputs tab now correctly displays the name of low-level results.
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 a bug that prevented multiple entities from being selected via the checkbox within the table view.
Scroll bars are no longer shown overtop of menus and dialogs in Safari.
Hostname no longer appears twice on instance management cards.
The sidebar action panel now collapses automatically after an option has been selected.
Fixed issue where a "Not Found" message would flash in the sidebar on load.
Fixed bug that resulted in incorrect cropping of some PNG figures in the event log.
Fixed bug in Job: Simulate Data that caused incorrect particles' CTF parameters when "apply CTF" was disabled.
Job: Simulate Data no longer requires the SSD cache
Residual plots in Job: Global CTF Refinement now properly account for phase ambiguities of 2π.
Fixed KeyError in Inspect Particle Picks caused by micrographs that contain no particle picks.
Fixed bug in Job: Homogeneous Reconstruction Only with helical symmetry enforced and custom box size.
Fixed bug in CryoSPARC Live that caused failed exposures to be double-counted as queued exposures.
Fixed issue where retrieving CryoSPARC Live sessions via the CLI would fail.
Fixed issue where slow database command response times would cause problems when configuring the database (e.g., updating CryoSPARC).
Extensive Workflow now runs on a worker with 32GB of RAM.
Installation and update are now cancelled if Python dependency installation fails.
Prevent job heartbeat failures following multiple disconnects and reconnects.
Fixed bug that raised a JSONDecodeError when calling cryosparcm eventlog on Job: 3D Variability Display.
Fixed bug that caused command_core, command_rtp and command_vis logs to not be properly rotated.
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 bug whereby ice thickness reported by Patch CTF (including in CryoSPARC Live) can be NaN.
Prevent file reading operations from failing on systems that incorrectly seek
Fixed bug that caused extracted particle count not to be displayed on the details panel when viewing a Live session