This release is a pre-release and may not be stable for production use.
VSWMC Command-Line Interface
Install with pip:
pip install --upgrade vswmc-cli
This will install a vswmc command on your system. The vswmc command uses an S2P OAuth access token for authentication. Obtain the token outside the CLI, for example with the OAuth 2.0 Client Credentials flow described in the SSO migration guide, then provide it with one of:
VSWMC_ACCESS_TOKEN
Read the access token from the environment.
--token TOKEN
Read the access token from the command line.
--token-file FILE
Read the access token from a file.
Example token request:
curl \
-d 'client_id=<M2M_CLIENT_ID>' \
-d 'client_secret=<M2M_CLIENT_SECRET>' \
-d 'grant_type=client_credentials' \
-d 'scope=<VSWMC_RESOURCE_SERVER_CLIENT_ID>' \
'https://sso.s2p.esa.int/realms/swe/protocol/openid-connect/token'
Example CLI usage:
export VSWMC_ACCESS_TOKEN=<ACCESS_TOKEN>
vswmc simulations list
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.
1 maintainer
Metadata
1 maintainer
Release files for vswmc-cli 2.2.3.dev429
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| vswmc_cli-2.2.3.dev429.tar.gz | 15.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| vswmc_cli-2.2.3.dev429-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 34.9 kB
Release files / vswmc_cli-2.2.3.dev429.tar.gz
| Download URL | vswmc_cli-2.2.3.dev429.tar.gz |
|---|---|
| Size | 15.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8c3408329fd4c446398f64b5671c1b08b22a0574f95f582c805afbc5ccbf456e
|
|
BLAKE2b-256 checksum How to use checksums |
8a14b8ee1b2cdba6f617db90adb53121b06deed6a7845684ad0b9f09fdca7e67
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.20
|
Release files / vswmc_cli-2.2.3.dev429-py2.py3-none-any.whl
| Download URL | vswmc_cli-2.2.3.dev429-py2.py3-none-any.whl |
|---|---|
| Size | 19.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
33264c2092ab82f373871ad5af66cf52f74119955cb8a529fa9d6a2679430e7a
|
|
BLAKE2b-256 checksum How to use checksums |
30aaee9b851ce6b7576fe393b1d0aa42b87296411f64d668ed69f65f1faa5cb1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.20
|
