Assume CLI

Assume CLI#

Submodules#

Command Line Interface#

There is a command line interface available to assume which makes it easy to run simulations from the CLI. It takes an input folder relative from the place it was run from.

The following command line parameters are available in the CLI:

Command Line Interface for ASSUME simulations

usage: assume [-h] [-s SCENARIO] [-c CASE_STUDY] [-csv CSV_EXPORT_PATH]
              [-db DB_URI] [-i INPUT_PATH] [-l LOGLEVEL] [-p]

Named Arguments#

-s, --scenario

name of the scenario file which should be used

Default: 'example_01a'

-c, --case-study

name of the case in that scenario which should be simulated

Default: ''

-csv, --csv-export-path

optional path to the csv export

Default: ''

-db, --db-uri

uri string for a database

Default: ''

-i, --input-path

path to the input folder

Default: 'examples/inputs'

-l, --loglevel

Possible choices: ERROR, WARNING, DEBUG, FATAL, INFO, CRITICAL, NOTSET, WARN

logging level used for file log

Default: 'INFO'

-p, --parallel

run simulation with multiple processes

Default: False

Contents