Skip to main content

VSWMC Command-Line Tools

Project description

VSWMC Command-Line Interface

Install with pip:

pip install --upgrade vswmc-cli

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


    SSA Username


    SSA Password

List available simulations

vswmc simulations list

This shows the parameters that a run requires.

Start a run

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

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


--param-file PARAM_FILE
Read parameters from a file.
--param PARAM=VALUE ...
Set parameters.

Each simulation supports different parameters. To know what parameters you need for a particular simulation, run:

vswmc simulations describe SIMULATION

List runs

vswmc ps [--simulation SIMULATION] [-a, --all]


--simulation SIMULATION
Filter on simulation.
-a, --all
List all runs (default shows only ongoing)

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


Print long listing

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.

Stop one or more runs

vswmc stop RUN ...

Remove one or more runs

vswmc rm RUN ...

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for vswmc-cli, version 2.0.1
Filename, size File type Python version Upload date Hashes
Filename, size vswmc_cli-2.0.1-py2.py3-none-any.whl (17.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size vswmc-cli-2.0.1.tar.gz (12.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page