Skip to content

Command Line Interface#

Most analysis can be performed using the command line interface (CLI). The commands below are added to your PATH after installation.

powerbalance#

Power Balance Models CLI for running models, as well as generating and viewing profiles.

Usage:

powerbalance [OPTIONS] COMMAND [ARGS]...

Options:

  --version  Show the version and exit.
  --help     Show this message and exit.

generate-profiles#

Generate profiles used as model inputs

Usage:

powerbalance generate-profiles [OPTIONS]

Options:

  --outdir TEXT  Profile output directory
  --help         Show this message and exit.

new#

Create a new project folder with modifiable a parameter set

Usage:

powerbalance new [OPTIONS] OUTPUT_DIR

Options:

  --help  Show this message and exit.

plugins#

Commands relating to plugins

Usage:

powerbalance plugins [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

install#

Installs a plugin from the given directory

Usage:

powerbalance plugins install [OPTIONS] PLUGIN_DIRECTORY

Options:

  --help  Show this message and exit.

list#

Lists all available plugins

Usage:

powerbalance plugins list [OPTIONS]

Options:

  --help  Show this message and exit.

remove#

Remove a plugin by name

Usage:

powerbalance plugins remove [OPTIONS] PLUGIN_NAME

Options:

  --help  Show this message and exit.

run#

Launch and run a PBM simulation session

Usage:

powerbalance run [OPTIONS]

Options:

  --config TEXT             TOML configuration file.
  --verbose / --no-verbose  Run in Debug Mode
  --no-browser / --browser  Run without launching result browser  [default:
                            browser]
  --outputdir TEXT          Output directory, default is current directory
  --param-dir TEXT          Location of parameter files
  --model-dir TEXT          Modelica model file directory
  --profiles-dir TEXT       Directory containing profiles
  --from-session TEXT       Run Power Balance using an existing session output
                            directory
  --help                    Show this message and exit.

view-profile#

View a profile within a '.mat' file

Usage:

powerbalance view-profile [OPTIONS] INPUT_MAT_FILE

Options:

  --head INTEGER  display head n rows
  --tail INTEGER  display tail n rows
  --help          Show this message and exit.

view-results#

Launch browser window from output directory

Usage:

powerbalance view-results [OPTIONS] OUTPUT_DIR

Options:

  --help  Show this message and exit.
Last update: February 23, 2022