CLI Interface¶

Command line interface¶

Pydss commands

Command line interface [OPTIONS] COMMAND [ARGS]...

add-post-process¶

Add post-process script to pydss scenario.

Command line interface add-post-process [OPTIONS] PROJECT_PATH SCENARIO_NAME
                                        SCRIPT CONFIG_FILE

Arguments

PROJECT_PATH¶: Required argument

SCENARIO_NAME¶: Required argument

SCRIPT¶: Required argument

CONFIG_FILE¶: Required argument

add-scenario¶

Add a new scenario to an existing project

Command line interface add-scenario [OPTIONS] PROJECT_PATH

Options

-c, --controller-mapping <controller_mapping>¶: Required JSON file that maps controller type to controller definition files

-s, --scenario_name <scenario_name>¶: Required name of the new scenario

Arguments

PROJECT_PATH¶: Required argument

controllers¶

Manage registered pydss controllers.

Command line interface controllers [OPTIONS] COMMAND [ARGS]...

register¶

Command line interface controllers register [OPTIONS] CONTROLLER_TYPE FILENAME

Arguments

CONTROLLER_TYPE¶: Required argument

FILENAME¶: Required argument

reset-defaults¶

Reset defaults.

Command line interface controllers reset-defaults [OPTIONS]

show¶

Show the registered controllers.

Command line interface controllers show [OPTIONS]

unregister¶

Unregister a controller.

Command line interface controllers unregister [OPTIONS] CONTROLLER_TYPE NAME

Arguments

CONTROLLER_TYPE¶: Required argument

NAME¶: Required argument

convert¶

Convert input files to new formats.

Command line interface convert [OPTIONS] COMMAND [ARGS]...

excel-to-toml¶

Convert an Excel configuration file to TOML.

Command line interface convert excel-to-toml [OPTIONS] [FILENAMES]...

Options

-n, --name <name>¶: new filename; default is to use the basename of the XLSX file

Arguments

FILENAMES¶: Optional argument(s)

simulation-file¶

Convert a legacy simulation TOML file to the new format.

Command line interface convert simulation-file [OPTIONS] [FILENAMES]...

Options

-n, --name <name>¶: new filename; default is Exports.toml

Arguments

FILENAMES¶: Optional argument(s)

create-project¶

Create pydss project.

Command line interface create-project [OPTIONS]

Options

--force¶

Overwrite directory if it already exists.

Default:: False

-o, --options <options>¶: dict-formatted simulation settings that override the config file. Example: pydss run ./project –options “{"Simulation Type": "QSTS"}”

-e, --export-modes <export_modes>¶: comma-delimited list of export modes

-c, --controller-types <controller_types>¶: comma-delimited list of controller types

-S, --simulation-config <simulation_config>¶: simulation configuration settings

-m, --master-dss-file <master_dss_file>¶: simulation file name

-F, --opendss-project-folder <opendss_project_folder>¶: simulation file name

-f, --simulation-file <simulation_file>¶

simulation file name

Default:: 'simulation.toml'

-s, --scenarios <scenarios>¶: Required comma-delimited scenario names

-p, --project <project>¶: Required project name

-P, --path <path>¶: Required path in which to create project

edit-scenario¶

Edit scenario in a pydss project.

Command line interface edit-scenario [OPTIONS] COMMAND [ARGS]...

Options

-s, --scenario <scenario>¶: Required Project name (should exist)

-p, --project-path <project_path>¶: Required project path

update-controllers¶

Update a scenario’s controllers from an OpenDSS file.

Command line interface edit-scenario update-controllers [OPTIONS]

Options

-t, --controller-type <controller_type>¶

Required controller type

Options:: FaultController | GenController | MotorStall | MotorStallSimple | PvController | PvDynamic | PvFrequencyRideThru | PvVoltageRideThru | SocketController | StorageController | ThermostaticLoad | xmfrController | DynamicVoltageSupport

-f, --dss-file <dss_file>¶: Required OpenDSS file containing elements

-c, --controller <controller>¶: Required controller name

export¶

Export data from a pydss project.

Command line interface export [OPTIONS] PROJECT_PATH

Options

--verbose¶

Enable verbose log output.

Default:: False

-o, --output-dir <output_dir>¶: Output directory. Default is project exports directory.

-c, --compress¶

Compress output files.

Default:: False

-f, --fmt <fmt>¶: Output file format (csv or h5).

Arguments

PROJECT_PATH¶: Required argument

extract¶

Extract a file from an archived pydss project.

Command line interface extract [OPTIONS] PROJECT_PATH FILE_PATH

Options

--verbose¶

Enable verbose log output.

Default:: False

-o, --output-dir <output_dir>¶: Output directory. Default is the project path.

Arguments

PROJECT_PATH¶: Required argument

FILE_PATH¶: Required argument

extract-element-files¶

Extract the element info files from an archived pydss project.

Command line interface extract-element-files [OPTIONS] PROJECT_PATH

Options

--verbose¶

Enable verbose log output.

Default:: False

-o, --output-dir <output_dir>¶: Output directory. Default is the project path.

Arguments

PROJECT_PATH¶: Required argument

reports¶

Explore and print pydss reports.

Command line interface reports [OPTIONS] PROJECT_PATH

Options

-r, --report <report>¶: Pydss report name.

-s, --scenario <scenario>¶: Pydss scenario name.

-i, --index <index>¶

View report by index (use -l flag to see list of available reports)

Default:: 0

-l, --list-reports¶

List all reports for a given project path

Default:: False

Arguments

PROJECT_PATH¶: Required argument

run¶

Run a pydss simulation.

Command line interface run [OPTIONS] PROJECT_PATH

Options

--dry-run¶

Dry run for getting estimated space.

Default:: False

--verbose¶

Enable verbose log output.

Default:: False

-z, --zip-project¶

Zip project files after successful execution.

Default:: False

-t, --tar-project¶

Tar project files after successful execution.

Default:: False

-s, --simulations-file <simulations_file>¶

scenario toml file to run (over rides default)

Default:: 'simulation.toml'

-o, --options <options>¶: dict-formatted simulation settings that override the config file. Example: pydss run ./project –options “{"Exports": {"Export Compression": "true"}}”

Arguments

PROJECT_PATH¶: Required argument