CryoSPARC Guide
Search…
CryoSPARC Guide
About cryoSPARC
Current Version
Licensing
Setup, Configuration and Management
Hardware and System Requirements
cryoSPARC Installation Prerequisites
How to Download, Install and Configure
Obtaining A License ID
Downloading and Installing cryoSPARC
cryoSPARC Cluster Integration Script Examples
Accessing the cryoSPARC User Interface
Software Updates
Management and Monitoring
Performance Metrics
Troubleshooting
Deployment Guides
Deploying cryoSPARC on AWS
Processing Data in cryoSPARC
Cryo-EM Data Processing in cryoSPARC: Introductory Tutorial
User Interface and Usage Guide
All Job Types in cryoSPARC
Tutorial Videos and Webinars
Tutorials and Usage Guides
Real-time processing in cryoSPARC Live
About cryoSPARC Live
Prerequisites and Compute Resources Setup
How to Access cryoSPARC Live
UI Overview
Live Jobs and Session-Level Functions
New Live Session: Start to Finish Guide
Tutorial Videos
Performance Metrics
FAQs and Troubleshooting
Cryo-EM Data Processing Explained
Questions and Support
cryoSPARC Discussion Forum
cryoSPARC Blog
cryoSPARC Homepage
Powered By GitBook
How to Download, Install and Configure
Meeting system requirements, obtaining a License ID, and downloading & installing cryoSPARC.

Step 1: Confirm Prerequisites

Ensure you have reviewed and completed the pre-requisites before downloading and installing cryoSPARC:
Once you have confirmed the prerequisites, you should have completed the following:
  • Create a shared user
  • Configure SSH access
  • Ensure all required ports are open
  • Set up a shared file system
  • Install CUDA (requires version ≥10)
In addition, make sure that the hardware to which you are installing meets system requirements:

Step 2: Obtain a cryoSPARC License ID

CryoSPARC is available free of charge for non-profit academic use. To download the software, you will need a cryoSPARC License ID, which can be requested via the form at https://cryosparc.com/download/.
Please contact [email protected] for inquiries relating to for-profit or industry licensing, including academic-industry collaborations on proprietary projects and fee-for-service data processing.

Step 3: Download and Install cryoSPARC

Summary

Once you've reviewed the cryoSPARC Installation Prerequisites and have decided on an architecture suitable for your situation, the installation process can be distilled to a few main steps:
  1. 1.
    Download the cryosparc_master package
  2. 2.
    Download the cryosparc_worker package
  3. 3.
    Install the cryosparc_master package on the master node
  4. 4.
    Start cryoSPARC for the first time
  5. 5.
    Create the first administrator user
  6. 6.
    [Optional] Set up recurring backup of the cryoSPARC database
  7. 7.
    If you chose to install cryoSPARC via the single-workstation method, at this point, you are finished installing cryoSPARC. Otherwise, continue.
  8. 8.
    Log onto a worker node and install the cryosparc_worker package (installing the cryosparc_worker package requires an NVIDIA GPU and CUDA Toolkit 10+)
  9. 9.
    Depending on whether you're installing cryoSPARC on a cluster or on a standalone worker machine, connect the worker node to cryoSPARC via cryosparcm cluster connect or cryosparcw connect
  10. 10.
    CryoSPARC is now fully installed. You may also choose to add more standalone worker machines at any time by using the cryosparcw connect utility.
You will need at least 15 GB of space to download and install the cryosparc_master and cryosparc_workerpackages

Detailed Installation Steps

Setup, Configuration and Management - Previous
cryoSPARC Installation Prerequisites
Next
Obtaining A License ID
Last modified 8mo ago
Copy link
Outline
Step 1: Confirm Prerequisites
Step 2: Obtain a cryoSPARC License ID
Step 3: Download and Install cryoSPARC
Summary
Detailed Installation Steps