Command line interface

rjm_config

This is an interactive script to set up Globus Transfer and Globus Compute on NeSI for use with RJM. It will create a new Globus guest collection (shared directory) on NeSI and will configure RJM to use the Globus Compute endpoint run by NeSI. Finally, all configuration values will be written to the RJM config file on the local machine and the authentication steps will be run.

While running this script, you will need to enter your NeSI username and your NeSI project code and will need to use a web browser to carry out NeSI and Globus authentication as required.

usage: rjm_config [-h] [-l LOGFILE] [-ll {debug,info,warn,error,critical}]
                  [-w] [-v]

Named Arguments

-l, --logfile

logfile. if not specified, all messages will be printed to the terminal.

-ll, --loglevel

Possible choices: debug, info, warn, error, critical

level of log verbosity (setting the level here overrides the config file)

-w, --where-config

Print location of the config file and exit

Default: False

-v, --version

show program's version number and exit

rjm_restart

rjm_health_check

Perform basic checks of the interface to the remote machine

usage: rjm_health_check [-h] [-l LOGFILE]
                        [-ll {debug,info,warn,error,critical}] [-le] [-k] [-r]
                        [-v]

Named Arguments

-l, --logfile

logfile. if not specified, all messages will be printed to the terminal.

-ll, --loglevel

Possible choices: debug, info, warn, error, critical

level of log verbosity (default: 'critical')

Default: 'critical'

-le, --logextra

Also log funcx and globus at the chosen loglevel

Default: False

-k, --keep

Keep health check files on remote system, i.e. do not delete them after completing the check (default=False)

Default: False

-r, --retries

Allow retries on function failures

Default: False

-v, --version

show program's version number and exit

rjm_batch_submit

Upload files and start jobs

usage: rjm_batch_submit [-h] -f LOCALJOBDIRFILE [-l LOGFILE]
                        [-ll {debug,info,warn,error,critical}] [-le] [--force]
                        [-n] [-c CMD] [-d REMOTEDIR] [-j JOBTYPE] [-m MEM]
                        [-p PROJECTCODE] [-w WALLTIME] [-v]

Named Arguments

-f, --localjobdirfile

file that contains the names of the local job directories, one name per line

-l, --logfile

logfile. if not specified, all messages will be printed to the terminal.

-ll, --loglevel

Possible choices: debug, info, warn, error, critical

level of log verbosity (setting the level here overrides the config file)

-le, --logextra

Also log funcx and globus at the chosen loglevel

Default: False

--force

ignore progress from previous runs stored in job directory, i.e. start from scratch

Default: False

-n, --defaultlogname

Use default log name instead of "batch_submit"

Default: False

-c, --cmd

not used; provided for compatibility with previous versions

-d, --remotedir

not used; provided for compatibility with previous versions

-j, --jobtype

not used; provided for compatibility with previous versions

-m, --mem

not used; provided for compatibility with previous versions

-p, --projectcode

not used; provided for compatibility with previous versions

-w, --walltime

not used; provided for compatibility with previous versions

-v, --version

show program's version number and exit

rjm_batch_wait

Wait for the jobs to complete and download files

usage: rjm_batch_wait [-h] -f LOCALJOBDIRFILE [-l LOGFILE]
                      [-ll {debug,info,warn,error,critical}] [-le]
                      [-z POLLINGINTERVALSEC] [-o] [-n] [-v]

Named Arguments

-f, --localjobdirfile

file that contains the names of the local job directories, one name per line

-l, --logfile

logfile. if not specified, all messages will be printed to the terminal.

-ll, --loglevel

Possible choices: debug, info, warn, error, critical

level of log verbosity (setting the level here overrides the config file)

-le, --logextra

Also log funcx and globus at the chosen loglevel

Default: False

-z, --pollingintervalsec

job status polling interval in seconds (minimum is 60 unless -o specified too)

-o, --min-polling-override

override minimum polling interval of 60 s

Default: False

-n, --defaultlogname

Use default log name instead of "batch_wait"

Default: False

-v, --version

show program's version number and exit