Update

Follow the steps below to update an existing CryoSPARC installation. Before starting the update, ensure that all running jobs have finished or have been terminated. Updating an active installation may interrupt running jobs.

1. Shut down the CryoSPARC instance

Before updating, fully shut down the CryoSPARC instance:

Bash

cryosparc-merlin cryosparcm stop

The -d / --cryosparc-path option

If the CryoSPARC installation is not located in the default directory /data/user/$USER/cryosparc, specify the installation path using the -d option.

2. Check for available updates

Check whether a new CryoSPARC version is available:

Bash

cryosparc-merlin cryosparcm update --check

This command checks for available updates without installing them.

3. Update the CryoSPARC master

Start the master update with:

Bash

cryosparc-merlin cryosparcm update

The update process will:

1. Stop the CryoSPARC instance if it is still running.
2. Download the required software updates.
3. Install the update on the CryoSPARC master.
4. Restart the CryoSPARC instance automatically if the update completes successfully.

After the update, verify that the CryoSPARC instance is running correctly:

Bash

cryosparc-merlin cryosparcm status

4. Update the CryoSPARC worker

After updating the master, the worker installation must also be updated.

First, change to the worker installation directory, for example:

Bash

cd /data/user/$USER/cryosparc/cryosparc_worker/

Worker Architecture

Make sure you access the correct worker installation. For installations with version 5 or above, the path to the worker installation has the architecture in the directory path.

Bash

/data/user/$USER/cryosparc/cryosparc_worker_x86_64

or

Bash

/data/user/$USER/cryosparc/cryosparc_worker_aarch64

Copy the updated worker package from the master installation:

Bash

cp ../cryosparc_master/cryosparc_worker.tar.gz ./

Then run the worker update command:

Bash

cryosparc-merlin cryosparcw update