API interfaces

create-project

Create a new PyPSSE project.

Usage:

create-project [OPTIONS] PATH

Options:

  -o, --overwrite                 Overwrite project is it already exists
                                  [default: True]
  -a, --autofill                  Attempt to auto fill settings. (Verify
                                  manually settings file is correct)
                                  [default: True]
  -m, --profile-mapping TEXT      Path to a valid Profile_mapping.toml file
                                  (used to map profile to PSSE elements)
  -s, --profile-store TEXT        Path to a valid Profiles.hdf5 file (Contains
                                  profiles for time series simulations)
  -e, --export-settings-file TEXT
                                  Export settings toml file path
  -f, --simulation-file TEXT      Simulation settings toml file path
  -F, --psse-project-folder PATH  PSS/E project folder path
  -p, --project TEXT              project name  [required]
  --help                          Show this message and exit.

run

Runs a valid PyPSSE simulation.

Usage:

run [OPTIONS] PROJECT_PATH

Options:

  -s, --simulations-file TEXT  scenario toml file to run (over rides default)
                               [default: simulation_settings.toml]
  --help                       Show this message and exit.

explore

Runs a valid PyPSSE simulation.

Usage:

explore [OPTIONS] PROJECT_PATH

Options:

  --gen-bounds TEXT               bounds for generation   [default: 0/10000]
  --load-bounds TEXT              bounds for load [example 10/100]  [default:
                                  0/10000]
  -b, --apply-bounds              applies load and generation limit bounds if
                                  set to true
  --comp-load / --no-comp-load    filter by composite load models [bool]
                                  [default: no-comp-load]
  --generation / --no-generation  filter by generation [bool]  [default: no-
                                  generation]
  -g, --gen-filter                applies generator filters if set to true
  --load / --no-load              filter by load [bool]  [default: no-load]
  -l, --load-filter               applies load filters if set to true
  -e, --export-file-path TEXT     path for exporting filtered results
                                  [default: ./filtered_results.csv]
  -s, --simulations-file TEXT     scenario toml file to run (over rides
                                  default)  [default:
                                  simulation_settings.toml]
  --help                          Show this message and exit.

create-profiles

Creates profiles for PyPSSE project.

Usage:

create-profiles [OPTIONS] PROJECT_PATH

Options:

  -i, --profile-info TEXT    Profile time resolution in seconds
  -r, --profile-res FLOAT    Profile time resolution in seconds  [default:
                             1.0]
  -T, --start-time TEXT      Time index for the first time step, format =
                             Y-m-d H:M:S.f  [default: 2020-01-01 00:00:00.00]
  -t, --profile-type TEXT    Profile type; Possible values:
                             [<ProfileTypes.LOAD: 'Load'>,
                             <ProfileTypes.INDUCTION_MACHINE:
                             'Induction_machine'>, <ProfileTypes.MACHINE:
                             'Machine'>, <ProfileTypes.PLANT: 'Plant'>]
                             [default: Load]
  -n, --profile-name TEXT    Profile name  [default: Default]
  -p, --profile-folder TEXT  Path to folder containing csv profiles. CSV file
                             names should follow the following format:
                             {profile-type}_{profile-name}
  -f, --csv-file-path TEXT   Path to a csv valid file
  --help                     Show this message and exit.

serve

Run a PyPSSE RESTful API server.

Usage:

serve [OPTIONS]

Options:

  -h, --host-ip TEXT  IP for the server  [default: 127.0.0.1]
  -p, --port INTEGER  Socket port for the server  [default: 9090]
  --help              Show this message and exit.