vswmc-cli 2.0.0b1

VSWMC Command-Line Tools

VSWMC Command-Line Interface

The vswmc command-line interface is a tool for remote execution via can be installed using pip:

pip install --upgrade vswmc

This will install a vswmc command on your system. The vswmc command has a few global options:

-u USER

    SSA Username

-p PASSWORD

    SSA Password

List configurations

vswmc configurations list

Delete one or more configurations

vswmc configurations delete CONFIGURATION ...

Copy a result file to disk

vswmc cp SRC DST

Downloads a remote result file to local disk. The source should be specified in the format RUN:FILE. The DST argument can be a local file or directory.

Fetch the logs of a run

vswmc logs RUN

List the results of a run

vswmc ls [-l] RUN

OPTIONS

-l

Print long listing

List runs

vswmc ps [--configuration CONFIGURATION] [-a, --all]

OPTIONS

--configuration CONFIGURATION

Filter on configuration.

-a, --all

List all runs (default shows only ongoing)

Remove one or more runs

vswmc rm RUN ...

Start a run

vswmc run [--param-file PARAM_FILE] [--param PARAM=VALUE ...] -- CONFIGURATION

OPTIONS

--param-file PARAM_FILE

Read parameters from a file.

--param PARAM=VALUE ...

Set parameters.

Each model supports different parameters.

euhforia_corona
euhforia_corona.magnetogram	File path to a local magnetogram file

Example:

vswmc -u myuser run --param euhforia_corona.magnetogram=/some/magnetogram.tar.gz -- "My configuration"

This commands returns the ID of the new run via stdout. You can use this ID to fetch the log or fetch result files.

euhforia_helio
TODO

Save all results of a run

vswmc save RUN

Saves all result files of a run. The results of each individual task in this run are compressed and saved into a zip archive named after the model for that task.