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 ≥9.2 and ≤10.2; 11+ is not supported)

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/.

Step 3: Download and Install cryoSPARC

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. Download the cryosparc2_master package

  2. Download the cryosparc2_worker package

  3. Install the cryosparc2_master package on the master node

  4. Start cryoSPARC for the first time

  5. Create the first administrator user

  6. [Optional] Set up recurring backup of the cryoSPARC database

  7. If you chose to install cryoSPARC via the single-workstation method, at this point, you are finished installing cryoSPARC. Otherwise, continue.

  8. Log onto a worker node and install the cryosparc2_worker package (installing the cryosparc2_worker package requires an NVIDIA GPU and CUDA Toolkit 9.2+)

  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. 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 3.0 GB of space to download and install the cryosparc2_master and cryosparc2_workerpackages

With this summary in mind, please follow the exact detailed instructions on the following page to perform the installation: