Initialize Parameters Folder¶
Breaking change
This command is no longer functional since 1.3.0
Equivalent commands have been added to csm-data a part of CosmoTech-Acceleration-Library.
Trying to run this command will give you the equivalent command to use with csm-data.
Install csm-data
This command will be fully removed in a future version.
pip install CosmoTech-Acceleration-Library~=0.7.0
Help command
> csm-orc init-parameters --help
Usage: csm-orc init-parameters [OPTIONS] COMMAND [ARGS]...
(Deprecated)
Base command to initialize parameter folders
Will create:
• A parameters.json/parameters.csv in the folder with all parameters
• A folder per %DATASETID% datasets with the name of the parameter
Check the help of the sub commands for more information:
• cloud requires access to a fully deployed solution
• solution requires a Solution.yaml file
╭─ OPTIONS ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --web-help Open the web documentation │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ cloud Initialize parameter folder for given run template from CosmoTech cloud API │
│ solution Initialize parameter folder for given run template from a Solution yaml file │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Initialize using Solution.yaml
> csm-orc init-parameters solution --help
Usage: csm-orc init-parameters solution [OPTIONS] SOLUTION_FILE OUTPUT_FOLDER RUN_TEMPLATE_ID
(Deprecated)
Initialize parameter folder for given run template from a Solution yaml file
╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * SOLUTION_FILE FILE [required] │
│ * OUTPUT_FOLDER PATH [required] │
│ * RUN_TEMPLATE_ID TEXT [required] │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ OPTIONS ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --write-json/--no-write-json Toggle writing of parameters in json format │
│ ENV: WRITE_JSON │
│ DEFAULT: no-write-json │
│ --write-csv/--no-write-csv Toggle writing of parameters in csv format │
│ ENV: WRITE_CSV │
│ DEFAULT: write-csv │
│ --web-help Open the web documentation │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Initialize using Cosmo Tech API
> csm-orc init-parameters cloud --help
Usage: csm-orc init-parameters cloud [OPTIONS] OUTPUT_FOLDER
(Deprecated)
Initialize parameter folder for given run template from CosmoTech cloud API
╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * OUTPUT_FOLDER PATH [required] │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ OPTIONS ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * --api-url URL The url to a Cosmotech API │
│ ENV: CSM_API_URL │
│ [required] │
│ * --api-scope URI The identification scope of a Cosmotech API │
│ ENV: CSM_API_SCOPE │
│ [required] │
│ * --organization-id o-########## The id of an organization in the cosmotech api │
│ ENV: CSM_ORGANIZATION_ID │
│ [required] │
│ * --workspace-id w-########## The id of a solution in the cosmotech api │
│ ENV: CSM_WORKSPACE_ID │
│ [required] │
│ * --run-template-id NAME The name of the run template in the cosmotech api │
│ ENV: CSM_RUN_TEMPLATE_ID │
│ [required] │
│ --write-json/--no-write-json Toggle writing of parameters in json format │
│ ENV: WRITE_JSON │
│ DEFAULT: no-write-json │
│ --write-csv/--no-write-csv Toggle writing of parameters in csv format │
│ ENV: WRITE_CSV │
│ DEFAULT: write-csv │
│ --web-help Open the web documentation │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯