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:
-u USER
SSA Username
-p PASSWORD
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.
OPTIONS
- --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]
OPTIONS
- --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
OPTIONS
- -l
- 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 ...
Create a product
vswmc products create [--metadata-file FILE] [--metadata PARAM=VALUE ...] [--attach FILE ...] -- PRODUCT_TYPE
OPTIONS
- --param-file PARAM_FILE
- Read parameters from a file.
- --param PARAM=VALUE ...
- Set parameters.
- --attach FILE ...
- Attach product files
EXAMPLE
vswmc products create --metadata test=123 --attach ../testdata/solar_wind_boundary.dat -- MHD0.1-1
Returns the ID of the created product.
Start a run using a product as input
vswmc run --param corona=6273ce7678eeb43c60d2eb8f \
--param grid=test_light \
--param cmes=examples/resources/cme_list.dat \
-- euhforia-heliosphere-standalone
The corona
parameter expects a product identifier.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for vswmc_cli-2.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea38b2ddf950268716b601486db78995513399b3dd7b93d8c5723e597aeb848c |
|
MD5 | b240ec009251268c7cdff530b05115b2 |
|
BLAKE2b-256 | 9f8c4d4c89b2b0e7a64bae3eb513ab36bbf868195bbe0d820578ad0b322cddb8 |