Command line tools¶
After installing Veros, you can call these scripts from the command line from any location on your system.
veros¶
This is a wrapper script that provides easy access to all Veros command line tools.
usage: veros COMMAND
available commands:
copy-setup Copies a Veros setup to another directory
create-mask Creates a mask image from a given netCDF file
resubmit Performs several runs of Veros back to back, using the
previous run as restart input. Intended to be used
with scheduling systems (e.g. SLURM or PBS).
veros-create-mask¶
usage: veros-create-mask.py [-h] [-v V] [-o OUT] [-s SCALE SCALE] file
Creates a mask image from a given netCDF file
positional arguments:
file Input file holding topography information
optional arguments:
-h, --help show this help message and exit
-v V Variable holding topography data (defaults to 'z')
-o OUT, --out OUT Output filename (default 'topography')
-s SCALE SCALE, --scale SCALE SCALE
Standard deviation in grid cells for Gaussian smoother
veros-copy-setup¶
usage: veros-copy-setup.py [-h]
{global_4deg,wave_propagation,acc,global_1deg,eady,north_atlantic}
[target_dir]
Copies a Veros setup to another directory
positional arguments:
{global_4deg,wave_propagation,acc,global_1deg,eady,north_atlantic}
Set-up to copy
target_dir Target directory (defaults to current directory)
optional arguments:
-h, --help show this help message and exit
veros-resubmit¶
usage: veros-resubmit.py [-h] [--callback CMD]
IDENTIFIER N_RUNS LENGTH_PER_RUN VEROS_CMD
Performs several runs of Veros back to back, using the previous run as restart
input. Intended to be used with scheduling systems (e.g. SLURM or PBS).
positional arguments:
IDENTIFIER base identifier of the simulation
N_RUNS total number of runs
LENGTH_PER_RUN length (in seconds) of each run
VEROS_CMD the command that is used to call veros (in quotes)
optional arguments:
-h, --help show this help message and exit
--callback CMD command to call after each run has finished (defaults to
calling itself)