Power Grid Model CLI Reference

This is the CLI reference for the power-grid-model.

The Power Grid Model CLI is still experimental. We offer no guarantee on stability of CLI arguments!

See below the CLI Reference, you can also run power-grid-model --help to get them:

Power Grid Model CLI
WARNING: The Power Grid Model CLI is still experimental. We offer no guarantee
on stability of CLI arguments!
Version: 1.13



power-grid-model [OPTIONS]


OPTIONS:
  -h,     --help              Print this help message and exit
          --version           Display program version information and exit
  -i,     --input TEXT:FILE REQUIRED 
                              Input file path
  -b,     --batch-update TEXT:FILE ... 
                              Batch update file path. Can be specified multiple times.
                              If multiple files are specified, the core will intepret them as
                              the cartesian product of all combinations of all scenarios in the
                              list of batch datasets.
  -o,     --output TEXT:ExistingParentDirectory REQUIRED 
                              Output file path
          --hertz, --system-frequency FLOAT 
                              System frequency in Hz, default is 50.0 Hz.
  -c,     --calculation-type ENUM:value in {power_flow->0,short_circuit->2,state_estimation->1} OR {0,2,1} 
                              Calculation type
  -m,     --calculation-method ENUM:value in {default->-128,iec60909->5,iterative_current->3,iterative_linear->2,linear_current->4,newton_raphson->1} OR {-128,5,3,2,4,1} 
                              Calculation method
          --sym, --symmetric-calculation, --asym{false}, --asymmetric-calculation{false} 
                              Use symmetric calculation (1) or not (0)
          --error-tolerance FLOAT 
                              Error tolerance for iterative calculations
          --max-iterations INT 
                              Maximum number of iterations for iterative calculations
          --threading INT     Threading strategy: -1 runs sequentially, 0 uses available
                              machine threads, and a positive value sets the number of threads.
          --short-circuit-voltage-scaling ENUM:value in {maximum->1,minimum->0} OR {1,0} 
                              Select minimum or maximum voltage scaling for short-circuit
                              current calculations.
          --calculation-initialization ENUM:value in {average_source->3,default->0,flat->1,linear->2} OR {3,0,1,2} 
                              Choose the starting voltage estimate for supported methods:
                              default, flat (1 p.u.), linear, or average_source.
          --tap-changing-strategy ENUM:value in {any->1,disabled->0,fast_any->4,max_voltage->3,min_voltage->2} OR {1,0,4,3,2} 
                              Control automatic transformer tap adjustment during power flow:
                              disabled, any, min_voltage, max_voltage, or fast_any (faster
                              search for any valid tap).
          --msgpack, --use-msgpack-output-serialization, --json{false}, --use-json-output-serialization{false} 
                              Use MessagePack output serialization
          --indent, --output-json-indent INT 
                              Number of spaces to indent JSON output
          --compact, --use-compact-serialization, --no-compact{false}, --no-compact-serialization{false} 
                              Use compact serialization (no extra whitespace)
          --oc, --output-component TEXT ... 
                              Filter output to only include specified components (can be
                              specified multiple times)
          --oa, --output-attribute TEXT ... 
                              Filter output to only include specified attributes, in the format
                              `component.attribute` (can be specified multiple times)
          --verbose           Enable verbose output