--helpflag to see full usage
cryosparcm patch: Automatically installs the latest patches on workstations or master node and connected workers. Not recommended for clusters: Use the
cryosparcm patch --force: Reinstalls the latest patches in case something went wrong with a previous attempt
cryosparcm patch --check: Shows information about the latest patches without installing
cryosparcm patch --download: Downloads the latest patches without installing them. Follow the resulting instructions to install the master and worker patches
cryosparcm patch --install: Run this command immediately after a
--downloadto install the patch on the master node.
cryosparcm cluster example <cluster_type>
cryosparcm cluster dump <name>
cryosparcm cluster connect
cluster_script.shfrom the current directory. Connects a new or updates an existing cluster configuration using the name from
cryosparcm cluster remove <name>
<cryosparcuser>(the user that installed CryoSPARC), and can only be executed on the master node. If these conditions are not met, you may see the following error:
CRYOSPARC_FORCE_HOSTNAMEvariable just before calling the command:
cryosparc_master/config.sh. You can also set
CRYOSPARC_FORCE_HOSTNAMEin this file to permanently suppress this error.
command_core, etc). Also prints out configuration environment variables.
cryosparcm stop && cryosparcm start
mongodump. By default, the function creates a folder named
backupinside the database path specified by the
CRYOSPARC_DB_PATHenvironment variable in
/u/cryosparcuser/cryosparc_db/backup) and saves the backup as an
.archivefile with the current date and time in its path (e.g.,
cryosparc_backup_2021_06_14_11h27.archive) inside this folder.
--dirflag. To change the name of the backup file, specify the
cronjob to execute the
cryosparcm backupcommand on a schedule, ensuring you always have a recent copy of the database that you can restore in case anything goes wrong.
--file=database_backup_$(date +"%A").archivewill simulate a rolling-window backup, as a backup file will be created with the day of the week in the file path (e.g.,
database_backup_Friday.archive). This allows you to keep a one-week buffer for the backup while limiting how much space the backups take, since future backups will overwrite a file if they are made on the same day.
cryosparcm changeport <port>
-yflag to proceed without confirmation.
cryosparcm log <process>
<process>which can be one of the following:
control Con your keyboard, and then
cryosparcm logusage, run
cryosparcm log -h:
command_vissupport the following arguments with the exception of
database, which also supports the date filter.
cryosparcm log command_core -n COMMAND.SCHEDULER
cryosparcm log command_core -f get_gpu_info_run
cryosparcm log command_core -l ERROR
tail. For example, to see the last 1000 lines of the log:
cryosparcm joblog PX JXX
PX. Includes the standard input and error from the python process for the job.
cryosparcm eventlog PX JXX
cryosparcm eventlog P3 J123 > P3_J123_events.log
<password>provided. Full use:
--passwordare required and can not be changed with this command.
--lastnameare used for display and do not otherwise affect CryoSPARC function.
evalto define the variables output by the
cryosparcm call <command>
eval $(cryosparcm env)followed by another shell command.