Command line tools¶
After installing RoGeR, you can call these scripts from the command line from any location on your system.
roger¶
This is a wrapper script that provides easy access to all RoGeR command line tools.
Usage: roger [OPTIONS] COMMAND [ARGS]...
roger command-line tools
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
copy-model Copy a standard setup to another directory.
create-mask Creates a mask image from a given netCDF file
resubmit Re-run a roger setup several times
run Runs a roger setup from given file
roger-create-mask¶
Usage: roger create-mask [OPTIONS] INFILE
Creates a mask image from a given netCDF file
Options:
-v, --variable TEXT Variable holding topography data (default: catchment)
-o, --outfile TEXT Output filename (default: catchment.png)
--help Show this message and exit.
roger-copy-model¶
Usage: roger copy-model [OPTIONS] MODEL
Copy a standard setup to another directory.
Available models:
oneD, oneD_event, svat, svat_bromide, svat_crop, svat_crop_bromide,
svat_crop_nitrate, svat_oxygen18
Example:
$ roger copy-model svat--to ~/roger-models/svat
Further directories containing model templates can be added to this command
via the ROGER_MODEL_DIR environment variable.
Options:
--to PATH Target directory, must not exist (default: copy to current working
directory)
--help Show this message and exit.
roger-resubmit¶
Usage: roger resubmit [OPTIONS]
Performs several runs of roger back to back, using the previous run as restart
input.
Intended to be used with scheduling systems (e.g. SLURM or PBS).
Options:
-i, --identifier TEXT Base identifier of the simulation [required]
-n, --num-runs INTEGER Total number of iterations to execute [required]
-c, --roger-cmd COMMAND The command that is used to call roger (quoted)
[required]
--callback CMD Command to call after each run has finished (quoted,
default: call self)
--help Show this message and exit.
roger-run¶
Usage: roger run [OPTIONS] SETUP_FILE
Runs a roger setup from given file
Options:
-b, --backend [numpy|jax] Backend to use for computations [default:
numpy]
--device [cpu|gpu|tpu] Hardware device to use (JAX backend only)
[default: cpu]
-v, --loglevel [trace|debug|info|warning|error]
Log level used for output [default: info]
-s, --override SETTING VALUE Override model setting, may be specified
multiple times
-p, --profile-mode Write a performance profile for debugging
--force-overwrite Silently overwrite existing outputs
--diskless-mode Supress all output to disk
--float-type [float64|float32] Floating point precision to use [default:
float64]
-n, --num-proc INTEGER... Number of processes in x and y dimension
--help Show this message and exit.