Restoring cryoSPARC Database After System Upgrade and Reinstallation

Dear cryoSPARC Community,

I recently upgraded the hardware on my Linux machine, which necessitated reinstalling to the latest version of cryoSPARC.

I have a complete back-up of the cryoSPARC database from the previous installation off the old hardware (copied the whole cryoSPARC home directory and the CryoSPARC projects folder onto external storage). Now, I am seeking guidance on how to link this previous database to the new cryoSPARC installation in order to access my old workspaces and jobs.

Could someone kindly provide instructions or guidance on the appropriate steps to take in order to achieve this? Any insights or advice would be greatly appreciated.

Thank you in advance for your assistance

As it happens, I just did this after upgrading the operating system. My steps are below:

Notes

  • Ensure you are doing this as the user that runs CryoSPARC.
  • The $ in the commands below merely indicate a user prompt and should not be included when running the commands.
  • I’m assuming the cryosparcm command is in the CryoSPARC user’s PATH

Documentation

My Steps

  1. Ensure CryoSPARC is stopped
    $ cryosparcm stop
    
  2. Determine the database directory
    $ grep "CRYOSPARC_DB_PATH" /the/path/to/cryosparc_master/config.sh
    export CRYOSPARC_DB_PATH="/the/path/to/cryosparc_database"
    
  3. Delete all the files and directories in the path returned by the command above that were initially created by the fresh CryoSPARC install.
    $ rm -rf /the/path/to/cryosparc_database/*
    
  4. Run the restore command
    $ cryosparcm restore --file=/the/path/to/your/cryosparc_backup_file.archive
    
  5. Once complete verify functionality