power_balance.cli.session#

Source: power_balance/cli/session.py

                Power Balance Models Session

This script launches the full Power Balance Models system running the models specified within the given configuration file using any parameters specified in the given parameter directory, or model defaults.

pbm_main#

pbm_main(config: str, verbose: bool = False, no_browser: bool = False, outputdir: str = '/home/runner/work/powerbalance/powerbalance', param_dir: str = 'Default', model_dir: str = 'Default', profiles_dir: str = 'Default', from_session: Optional[str] = '', **kwargs) -> None

Runs a Power Balance Models session

Parameters#

• config: str

  address/path of configuration file

• verbose: bool, default False

  increase verbosity of output, by default False

• no_browser: bool, default False

  do not open browser on completion, by default False

• outputdir: str, default /home/runner/work/powerbalance/powerbalance

  output data directory, by default current directory

• param_dir: str, default Default

  location of model parameter files, defaults to internal parameters

• model_dir: str, default Default

  location of models, defaults to internal model directory

• profiles_dir: str, default Default

  location of profiles, defaults to internal profile directory

• from_session: typing.Optional, default ````

  start a new run from the output of a previous run, by default None