Outputs

Type: object

This is the schema for the output statistics and analytics from the ONM workflow using entrypoint and analyze_results!

 No Additional Properties
Example:

{
    "Events": [
        {
            "event_data": {
                "status": 1,
                "dispatchable": false,
                "type": "breaker",
                "state": "open"
            },
            "timestep": 1,
            "affected_asset": "line.671700",
            "event_type": "switch"
        }
    ],
    "Generator profiles": {
        "Diesel DG (kW)": [
            0,
            0,
            0
        ],
        "Energy storage (kW)": [
            0,
            0,
            0
        ],
        "Solar DG (kW)": [
            200,
            175,
            100
        ],
        "Grid mix (kW)": [
            1750,
            2000,
            3000
        ]
    },
    "Fault currents": [
        {
            "701_lg_1": {
                "fault": {
                    "susceptance (S)": [
                        [
                            0,
                            0
                        ],
                        [
                            0,
                            0
                        ]
                    ],
                    "connections": [
                        1,
                        4
                    ],
                    "conductance (S)": [
                        [
                            100,
                            -100
                        ],
                        [
                            -100,
                            100
                        ]
                    ],
                    "bus": "701",
                    "type": "lg"
                },
                "switch": {
                    "671692": {
                        "|I| (A)": null,
                        "|I2| (A)": 0.8,
                        "|I0| (A)": 1.2,
                        "|I1| (A)": 90.1,
                        "|V| (V)": [
                            2.5,
                            2.5,
                            2.5
                        ]
                    }
                }
            }
        }
    ],
    "Runtime timestamp": "2021-01-01T00:00:00.000",
    "Switch changes": [
        [],
        [
            "671700"
        ],
        [
            "701702"
        ]
    ],
    "Runtime arguments": {
        "events": "../test/data/ieee13_events.json",
        "faults": "../test/data/ieee13_faults.json",
        "voltage-angle-difference": 5,
        "network": "../test/data/ieee13_feeder.dss",
        "settings": "../test/data/ieee13_settings.json",
        "voltage-lower-bound": 0.8,
        "quiet": true,
        "inverters": "../test/data/ieee13_inverters.json",
        "max-switch-actions": 1,
        "voltage-upper-bound": 1.2
    },
    "Simulation time steps": [
        1,
        2,
        3
    ],
    "Voltages": {
        "Min voltage (p.u.)": [
            1,
            1,
            1
        ],
        "Max voltage (p.u.)": [
            1.2,
            1,
            1.1
        ],
        "Mean voltage (p.u.)": [
            1.1,
            1,
            1
        ]
    },
    "Additional statistics": {},
    "Storage SOC (%)": [
        null,
        null,
        null
    ],
    "Powerflow output": [
        {
            "voltage_source": {
                "source": {
                    "real power setpoint (kW)": [
                        581.8173560045832,
                        468.8619242602074,
                        708.8039492196247
                    ],
                    "reactive power setpoint (kVar)": [
                        244.09972136399347,
                        32.25338488759224,
                        40.35427973972425
                    ]
                }
            },
            "solar": {
                "pv1": {
                    "real power setpoint (kW)": [
                        64.49371884320102,
                        64.507863885424,
                        64.49849984139108
                    ],
                    "reactive power setpoint (kVar)": [
                        41.23181415943054,
                        41.23340639500285,
                        41.23312440672468
                    ]
                }
            },
            "bus": {
                "611": {
                    "voltage (V)": [
                        2.5217499128997907
                    ]
                }
            }
        }
    ],
    "Small signal stable": [
        false,
        false,
        false
    ],
    "Load served": {
        "Bonus load via microgrid (%)": [
            0,
            0,
            0
        ],
        "Feeder load (%)": [
            85.8,
            91.2,
            96.7
        ],
        "Microgrid load (%)": [
            9.4,
            9,
            3.2
        ]
    },
    "Device action timeline": [
        {
            "Shedded loads": [
                "701",
                "700"
            ],
            "Switch configurations": {
                "671692": "closed",
                "671700": "open",
                "701702": "open"
            }
        },
        {
            "Shedded loads": [],
            "Switch configurations": {
                "671692": "closed",
                "671700": "closed",
                "701702": "open"
            }
        },
        {
            "Shedded loads": [],
            "Switch configurations": {
                "671692": "closed",
                "671700": "closed",
                "701702": "closed"
            }
        }
    ]
}

root Runtime timestamp
Type: stringFormat: date-time Default: "string(Dates.now())"

Time at which ONM algorithm was executed

root Simulation time steps
Type: array

The actual timesteps, either in datetime strings, or as numbers

Each item of this array must be:

root Simulation time steps Simulation time steps items
Type: string or numberFormat: date-time

root Load served
Type: object

Statistics about the load served, in percent, either by the Grid (feeder), or by the microgrids

 No Additional Properties

root Load served Feeder load (%)
Type: array of number

The percent of load served by the feeder (grid)

Each item of this array must be:

root Load served Feeder load (%) Feeder load (%) items
Type: numberFormat: float

root Load served Feeder customers (%)
Type: array of number

The percent of customers served by the feeder (grid)

Each item of this array must be:

root Load served Feeder customers (%) Feeder customers (%) items
Type: numberFormat: float

root Load served Total load (%)
Type: array of number

The percent of total load served by any resource

Each item of this array must be:

root Load served Total load (%) Total load (%) items
Type: numberFormat: float

root Load served Total customers (%)
Type: array of number

The percent of total customers served by any resource

Each item of this array must be:

root Load served Total customers (%) Total customers (%) items
Type: numberFormat: float

root Load served Microgrid load (%)
Type: array of number

The percent of load served by the microgrids

Each item of this array must be:

root Load served Microgrid load (%) Microgrid load (%) items
Type: numberFormat: float

root Load served Microgrid customers (%)
Type: array of number

The percent of customers served by the microgrids

Each item of this array must be:

root Load served Microgrid customers (%) Microgrid customers (%) items
Type: numberFormat: float

root Load served Bonus load via microgrid (%)
Type: array of number

The percent of additional load that microgrids are supporting outside of their predefined microgrid zones

Each item of this array must be:

root Load served Bonus load via microgrid (%) Bonus load via microgrid (%) items
Type: numberFormat: float

root Load served Bonus customers via microgrid (%)
Type: array of number

The percent of additional customers that microgrids are supporting outside of their predefined microgrid zones

Each item of this array must be:

root Load served Bonus customers via microgrid (%) Bonus customers via microgrid (%) items
Type: numberFormat: float

root Generator profiles
Type: object

Statistics about the sources of generation, including solar PV, energy storage, traditional diesel, and from the grid (feeder)

 No Additional Properties

root Generator profiles Grid mix (kW)
Type: array of number

The amount of power provided from the grid (feeder) in kW

Each item of this array must be:

root Generator profiles Grid mix (kW) Grid mix (kW) items
Type: number

root Generator profiles Solar DG (kW)
Type: array of number

The amount of power provided by solar PV sources kW

Each item of this array must be:

root Generator profiles Solar DG (kW) Solar DG (kW) items
Type: number

root Generator profiles Energy storage (kW)
Type: array of number

The amount of power provided by energy storage sources in kW

Each item of this array must be:

root Generator profiles Energy storage (kW) Energy storage (kW) items
Type: number

root Generator profiles Diesel DG (kW)
Type: array of number

The amount of power provided by tranditional diesel generation in kW

Each item of this array must be:

root Generator profiles Diesel DG (kW) Diesel DG (kW) items
Type: number

root Voltages
Type: object

Statistics about the voltage magnitudes at each timestep

 No Additional Properties

root Voltages Min voltage (p.u.)
Type: array of number

The minimum voltage over the whole feeder at each timestep in per-unit representation

Each item of this array must be:

root Voltages Min voltage (p.u.) Min voltage (p.u.) items
Type: number

root Voltages Mean voltage (p.u.)
Type: array of number

The mean voltage over the whole feeder at each timestep in per-unit representation

Each item of this array must be:

root Voltages Mean voltage (p.u.) Mean voltage (p.u.) items
Type: number

root Voltages Max voltage (p.u.)
Type: array of number

The maximum voltage over the whole feeder at each timestep in per-unit representation

Each item of this array must be:

root Voltages Max voltage (p.u.) Max voltage (p.u.) items
Type: number

root Storage SOC (%)
Type: array

List of lists of switches whose state changed between timesteps

Each item of this array must be:

root Storage SOC (%) Storage SOC (%) items
Type: number or null

List of switches whose state changed from the previous timestep

root Device action timeline
Type: array of object

Object for each timestep, in order, containing information about the switch topology and a list of each load that has been shed at that timestep.

Each item of this array must be:

root Device action timeline device actions timestep
Type: object

Timestep object containing information about shedded loads and switch configurations

 No Additional Properties

root Device action timeline device actions timestep Shedded loads
Type: array of string

A list of loads that have been shed at the current timestep

Each item of this array must be:

root Device action timeline device actions timestep Shedded loads Shedded loads items
Type: string

root Device action timeline device actions timestep Switch configurations
Type: object

Object containing all switches at their corresponding states at the current timestep

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Device action timeline device actions timestep Switch configurations switch state
Type: enum (of string)

switch_name: state

Must be one of:

  • "open"
  • "closed"

root Device action timeline device actions timestep Microgrid networks
Type: array of array

List of microgrid networks

Each item of this array must be:

root Device action timeline device actions timestep Microgrid networks Microgrid networks items
Type: array of string

List of microgrids that are networked together

Each item of this array must be:

root Device action timeline device actions timestep Microgrid networks Microgrid networks items Microgrid networks items items
Type: string

Example:

[
    {
        "Shedded loads": [
            "load.123"
        ],
        "Switch configurations": {
            "switch.123": "open",
            "switch.456": "closed"
        }
    },
    {
        "Shedded loads": [],
        "Switch configurations": {
            "switch.123": "closed",
            "switch.456": "closed"
        }
    }
]

root Powerflow output
Type: array of object

The schema for the powerflow outputs from optimize_dispatch, which include real and reactive power setpoints at generation objects, which include diesel generators (generator), substations/grid/feeder (voltage_source), solar PV (solar), or energy storage (storage), and voltage magnitudes at buses. All values are in SI units.

Each item of this array must be:

root Powerflow output Powerflow output items
Type: object

Timestep object

 No Additional Properties

root Powerflow output Powerflow output items voltage_source
Type: object

Generation types: diesel generators (generator), or substations (voltage_source), or solar PV (solar), or energy storage (storage)

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Powerflow output Powerflow output items voltage_source ^.+$
Type: object

generation object

 No Additional Properties

root Powerflow output Powerflow output items voltage_source ^.+$ connections
Type: array of integer

The connections (terminals) that the voltage source is connected to, in order

Each item of this array must be:

root Powerflow output Powerflow output items voltage_source ^.+$ connections connections items
Type: integer

root Powerflow output Powerflow output items voltage_source ^.+$ inverter
Type: enum (of string)

Indicator for whether the generation object is grid-forming or grid-following

Must be one of:

  • "GRID_FOLLOWING"
  • "GRID_FORMING"

root Powerflow output Powerflow output items generator
Type: object

Generation types: diesel generators (generator), or substations (voltage_source), or solar PV (solar), or energy storage (storage)

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Powerflow output Powerflow output items generator ^.+$
Type: object

generation object

 No Additional Properties

root Powerflow output Powerflow output items generator ^.+$ connections
Type: array of integer

The connections (terminals) that the generator is connected to, in order

Each item of this array must be:

root Powerflow output Powerflow output items generator ^.+$ connections connections items
Type: integer

root Powerflow output Powerflow output items generator ^.+$ inverter
Type: enum (of string)

Must be one of:

  • "GRID_FOLLOWING"
  • "GRID_FORMING"

root Powerflow output Powerflow output items solar
Type: object

Generation types: diesel generators (generator), or substations (voltage_source), or solar PV (solar), or energy storage (storage)

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Powerflow output Powerflow output items solar ^.+$
Type: object

generation object

 No Additional Properties

root Powerflow output Powerflow output items solar ^.+$ real power setpoint (kW)
Type: array of number

real power setpoints in kW

Each item of this array must be:

root Powerflow output Powerflow output items solar ^.+$ real power setpoint (kW) real power setpoint (kW) items
Type: number

root Powerflow output Powerflow output items solar ^.+$ connections
Type: array of integer

The connections (terminals) that the solar PV is connected to, in order

Each item of this array must be:

root Powerflow output Powerflow output items solar ^.+$ connections connections items
Type: integer

root Powerflow output Powerflow output items solar ^.+$ inverter
Type: enum (of string)

Must be one of:

  • "GRID_FOLLOWING"
  • "GRID_FORMING"

root Powerflow output Powerflow output items storage
Type: object

Generation types: diesel generators (generator), or substations (voltage_source), or solar PV (solar), or energy storage (storage)

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Powerflow output Powerflow output items storage ^.+$
Type: object

storage object

 No Additional Properties

root Powerflow output Powerflow output items storage ^.+$ connections
Type: array of integer

The connections (terminals) that the storage is connected to, in order

Each item of this array must be:

root Powerflow output Powerflow output items storage ^.+$ connections connections items
Type: integer

root Powerflow output Powerflow output items storage ^.+$ inverter
Type: enum (of string)

Must be one of:

  • "GRID_FOLLOWING"
  • "GRID_FORMING"

root Powerflow output Powerflow output items bus
Type: object

Bus objects indexed by name

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Powerflow output Powerflow output items bus ^.+$
Type: object

Bus object

 No Additional Properties

root Powerflow output Powerflow output items bus ^.+$ voltage (V)
Type: array of number

Voltage magnitudes in Volts

Each item of this array must be:

root Powerflow output Powerflow output items bus ^.+$ voltage (V) voltage (V) items
Type: number

root Powerflow output Powerflow output items bus ^.+$ terminals
Type: array of integer

The active terminals on the bus, in order

Each item of this array must be:

root Powerflow output Powerflow output items bus ^.+$ terminals terminals items
Type: integer

root Powerflow output Powerflow output items switch
Type: object

Switch objects indexed by name

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Powerflow output Powerflow output items switch ^.+$
Type: object

Switch object

root Powerflow output Powerflow output items switch ^.+$ real power flow (kW)
Type: array of number

The real power flow on the switch, coming from the from-side, in kW

Each item of this array must be:

root Powerflow output Powerflow output items switch ^.+$ real power flow (kW) real power flow (kW) items
Type: number

root Powerflow output Powerflow output items switch ^.+$ reactive power flow (kVar)
Type: array of number

The reactive power flow through the switch coming from the from-side, in kVar

Each item of this array must be:

root Powerflow output Powerflow output items switch ^.+$ reactive power flow (kVar) reactive power flow (kVar) items
Type: number

root Powerflow output Powerflow output items switch ^.+$ current (A)
Type: array of number

The current flow through the switch coming from the from-side, in Amps

Each item of this array must be:

root Powerflow output Powerflow output items switch ^.+$ current (A) current (A) items
Type: number

root Powerflow output Powerflow output items switch ^.+$ connections
Type: array of integer

The connections (terminals) that the switch is connected to on the from-side, in order

Each item of this array must be:

root Powerflow output Powerflow output items switch ^.+$ connections connections items
Type: integer

root Powerflow output Powerflow output items switch ^.+$ voltage (V)
Type: array of number

The voltage on the from-side bus in Volts

Each item of this array must be:

root Powerflow output Powerflow output items switch ^.+$ voltage (V) voltage (V) items
Type: number

root Powerflow output Powerflow output items protection
Type: object

Protection monitored objects indexed by type.name

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Powerflow output Powerflow output items protection ^.+$
Type: object

Protection monitored object

root Powerflow output Powerflow output items protection ^.+$ real power flow (kW)
Type: array of number

The real power flow on the protection-monitored-object, coming from the from-side, in kW

Each item of this array must be:

root Powerflow output Powerflow output items protection ^.+$ real power flow (kW) real power flow (kW) items
Type: number

root Powerflow output Powerflow output items protection ^.+$ reactive power flow (kVar)
Type: array of number

The reactive power flow through the protection-monitored-object coming from the from-side, in kVar

Each item of this array must be:

root Powerflow output Powerflow output items protection ^.+$ reactive power flow (kVar) reactive power flow (kVar) items
Type: number

root Powerflow output Powerflow output items protection ^.+$ connections
Type: array of integer

The connections (terminals) that the protection-monitored-object is connected to on the from-side, in order

Each item of this array must be:

root Powerflow output Powerflow output items protection ^.+$ connections connections items
Type: integer

root Powerflow output Powerflow output items protection ^.+$ voltage (kV)
Type: array of number

The voltage magnitude on the from-side bus in kilovolts

Each item of this array must be:

root Powerflow output Powerflow output items protection ^.+$ voltage (kV) voltage (kV) items
Type: number

root Powerflow output Powerflow output items protection ^.+$ phi (deg)
Type: array of number

The voltage angle on the from-side bus in degrees

Each item of this array must be:

root Powerflow output Powerflow output items protection ^.+$ phi (deg) phi (deg) items
Type: number

Example:

[
    {
        "voltage_source": {
            "source": {
                "real power setpoint (kW)": [
                    581.8173560045832,
                    468.8619242602074,
                    708.8039492196247
                ],
                "reactive power setpoint (kVar)": [
                    244.09972136399347,
                    32.25338488759224,
                    40.35427973972425
                ]
            }
        },
        "solar": {
            "pv1": {
                "real power setpoint (kW)": [
                    64.49371884320102,
                    64.507863885424,
                    64.49849984139108
                ],
                "reactive power setpoint (kVar)": [
                    41.23181415943054,
                    41.23340639500285,
                    41.23312440672468
                ]
            }
        },
        "bus": {
            "611": {
                "voltage (V)": [
                    2.5217499128997907
                ]
            }
        }
    }
]

root Additional statistics
Type: object

A place for additional statistics and analytics, which can be specified arbitrarily.
Example:

{
    "Protection settings": [
        {
            "primary pickup (A)": [
                0
            ],
            "TDS": [
                0
            ],
            "to": [
                "string"
            ],
            "from": [
                "string"
            ],
            "TOC": [
                "string"
            ],
            "operating time (s)": [
                0
            ]
        }
    ]
}

root Events
Type: array of object

A list of events, ordered (i.e., later events will overwrite earlier ones if there is a conflict), that can either be a switching action, or a fault.

Must contain a minimum of 0 items

Each item of this array must be:

root Events Events items
Type: object

Event definition

 No Additional Properties

root Events Events items timestep
Type: string, integer or number

Timestep, in string, integer, or float, that identifies the timestep at which this event is applied.

Must match regular expression: ^\d+\.*\d*

root Events Events items event_type
Type: enum (of string)

The type of event (switch or fault)

Must be one of:

  • "fault"
  • "switch"

root Events Events items affected_asset
Type: string

The asset that is being affected by the event

Must match regular expression: ^[Ll][Ii][Nn][Ee]\..+$

Must be at least 5 characters long

root Events Events items event_data

The event data

root Events Events items event_data anyOf item 0
Type: object

Switch event data

 No Additional Properties

root Events Events items event_data anyOf item 0 type
Type: string

Type of switch, e.g., "fuse", "breaker", "recloser", etc.

root Events Events items event_data anyOf item 0 state
Type: enum (of string)

What is the state of the switch, "open" or "closed"? Only used if "event_type" is "switch".

Must be one of:

  • "open"
  • "closed"
  • "OPEN"
  • "CLOSED"

root Events Events items event_data anyOf item 0 dispatchable
Type: enum (of string or boolean) Default: false

Is the affected object dispatchable? (i.e., can be opened or closed), default is false

Must be one of:

  • "YES"
  • "NO"
  • "yes"
  • "no"
  • true
  • false

root Events Events items event_data anyOf item 0 status
Type: enum (of integer or string) Default: 1

Status of the object, if 0, completely outaged from the model. Default 1.

Must be one of:

  • 0
  • 1
  • "DISABLED"
  • "ENABLED"
  • "enabled"
  • "disabled"
root Events Events items event_data anyOf item 1
Type: object

Fault event data

 No Additional Properties

root Events Events items event_data anyOf item 1 duration_ms
Type: numberFormat: float

Duration of a fault, in milliseconds, -1 ==> permanent fault

Value must be greater or equal to -1


Example:

[
    {
        "timestep": 1,
        "event_type": "switch",
        "affected_asset": "line.switch_name",
        "event_data": {
            "type": "breaker",
            "state": "open",
            "dispatchable": false,
            "status": 1
        }
    }
]

root Runtime arguments
Type: object

The allowed runtime arguments for PowerModelsONM's entrypoint.

 No Additional Properties
Example:

{
    "network": "../test/data/ieee13_feeder.dss",
    "gurobi": false,
    "settings": "../test/data/ieee13_settings.json",
    "faults": "../test/data/ieee13_faults.json",
    "inverters": "../test/data/ieee13_inverters.json",
    "events": "../test/data/ieee13_events.json",
    "log-level": "error",
    "opt-disp-formulation": "acr"
}

root Runtime arguments network
Type: string

The network file path (DSS format)

root Runtime arguments settings
Type: string

The path to the settings input file (JSON format)

root Runtime arguments events
Type: string

The path to the events input file (JSON format)

root Runtime arguments faults
Type: string

The path to the faults input file (JSON format)

root Runtime arguments inverters
Type: string

The path to the inverters input file (JSON format)

root Runtime arguments output
Type: string

The path to the output file (JSON format)

root Runtime arguments gurobi
Type: boolean

deprecated: solvers/useGurobi

root Runtime arguments knitro
Type: boolean

deprecated: solvers/useKNITRO

root Runtime arguments skip
Type: array of enum (of string)

deprecated: options/problem/skip

All items must be unique

Each item of this array must be:

root Runtime arguments skip skip items
Type: enum (of string)

Must be one of:

  • "stability"
  • "faults"
  • "dispatch"
  • "switching"

root Runtime arguments log-level
Type: enum (of string)

deprecated: options/outputs/log-level

Must be one of:

  • "debug"
  • "info"
  • "warn"
  • "error"

root Runtime arguments quiet
Type: boolean

missing

root Runtime arguments verbose
Type: boolean

missing

root Runtime arguments debug
Type: boolean

missing

root Runtime arguments nprocs
Type: integer Default: 1

Number of processors to utilize for parallel computations (Fault studies and Stability Analysis)

root Runtime arguments pretty-print
Type: boolean Default: false

deprecated: options/output/pretty-print

root Runtime arguments opt-switch-formulation
Type: enum (of string)

deprecated: options/problem/operations-formulation

Must be one of:

  • "lindistflow"
  • "nfa"
  • "fbs"
  • "fot"

root Runtime arguments opt-switch-algorithm
Type: enum (of string)

deprecated: options/problem/operations-algorithm

Must be one of:

  • "iterative"
  • "global"

root Runtime arguments opt-switch-solver
Type: enum (of string)

deprecated: options/problem/operations-solver

Must be one of:

  • "misocp_solver"
  • "nlp_solver"
  • "minlp_solver"
  • "mip_solver"

root Runtime arguments opt-switch-problem
Type: enum (of string)

deprecated: options/problem/operations-problem-type

Must be one of:

  • "traditional"
  • "block"

root Runtime arguments opt-disp-formulation
Type: enum (of string)

deprecated: options/problem/dispatch-formulation

Must be one of:

  • "acp"
  • "acr"
  • "lindistflow"
  • "nfa"
  • "fbs"
  • "fot"

root Runtime arguments opt-disp-algorithm
Type: enum (of string)

deprecated: missing

Must be one of:

  • "opf"
  • "mld"
  • "oltc"

root Runtime arguments opt-disp-solver
Type: enum (of string)

deprecated: options/problem/dispatch-solver

Must be one of:

  • "nlp_solver"
  • "misocp_solver"
  • "minlp_solver"
  • "mip_solver"

root Runtime arguments fix-small-numbers
Type: boolean

deprecated: options/data/fix-small-numbers

root Runtime arguments disable-switch-penalty
Type: boolean

deprecated: options/objective/disable-switch-state-change-cost

root Runtime arguments apply-switch-scores
Type: boolean

deprecated: options/objective/enable-switch-state-open-cost

root Runtime arguments disable-radial-constraint
Type: boolean

deprecated: options/constraints/disable-radiality-constraint

root Runtime arguments disable-isolation-constraint
Type: boolean

deprecated: options/constraints/disable-block-isolation-constraint

root Runtime arguments disable-inverter-constraint
Type: boolean

deprecated: options/constraints/disable-grid-forming-inverter-constraint

root Runtime arguments disable-networking
Type: boolean

deprecated: options/constraints/disable-microgrid-networking

root Runtime arguments disable-presolver
Type: boolean

deprecated: {solvers/HiGHS/presolve,solvers/Gurobi/Presolve,solvers/KNITRO/presolve}

root Fault currents
Type: array of object

Collection of data about fault currents collected from the outputs of fault studies using PowerModelsProtection

Each item of this array must be:

root Fault currents Fault currents items
Type: object

fault studies results

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Fault currents Fault currents items ^.+$
Type: object

Bus on which the faults apply

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[3p|3pg|ll|llg|lg]$
root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$
Type: object

collection of faults of type {}

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^\d+$
root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$
Type: object

Results enumerated by keys of the format busName_faultType_faultID

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault
Type: object

The fault object which idenifies the details about the fault that was applied in this particular study

 No Additional Properties

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault bus
Type: string

The bus at which the fault was applied

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault type
Type: enum (of string)

The type of fault, i.e., three-phase (3p), three-phase-to-ground (3pg), line-to-line-to-ground (llg), line-to-line (ll), line-to-ground (lg)

Must be one of:

  • "3p"
  • "3pg"
  • "ll"
  • "lg"
  • "llg"

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault conductance (S)
Type: array of array

conductance matrix of the fault in Siemens

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault conductance (S) conductance (S) items
Type: array of number

row vector of the conductance matrix

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault conductance (S) conductance (S) items conductance (S) items items
Type: number

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault susceptance (S)
Type: array of array

Susceptance matrix of the fault in Siemens, usually all zeros

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault susceptance (S) susceptance (S) items
Type: array of number

Row vector of the susceptance matrix

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault susceptance (S) susceptance (S) items susceptance (S) items items
Type: number

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault connections
Type: array of integer

connections (phases) over which the fault applies

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ fault connections connections items
Type: integer

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch
Type: object

switch objects indexed by name

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$
Type: object

switch (protection) object

 No Additional Properties

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ |I| (A)
Type: array of number

Fault current magnitude in amps

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ |I| (A) |I| (A) items
Type: number

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ |V| (V)
Type: array of number

Bus voltage magnitude in volts

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ |V| (V) |V| (V) items
Type: number

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ phi (deg)
Type: array of number

Bus voltage angles in degrees

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ phi (deg) phi (deg) items
Type: number

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ theta (deg)
Type: array of number

Fault current angles in degrees

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ theta (deg) theta (deg) items
Type: number

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ Re(I0) (A)
Type: number

Real part of the zero sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ Re(I1) (A)
Type: number

Real part of the positive sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ Re(I2) (A)
Type: number

Real part of the negative sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ Im(I0) (A)
Type: number

Imaginary part of the zero sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ Im(I1) (A)
Type: number

Imaginary part of the positive sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ Im(I2) (A)
Type: number

Imaginary part of the negative sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ |I0| (A)
Type: number

magnitude of zero sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ |I1| (A)
Type: number

magnitude of positive sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ switch ^.+$ |I2| (A)
Type: number

magnitude of negative sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line
Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$
Type: object

switch (protection) object

 No Additional Properties

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ |I| (A)
Type: array of number

Fault current magnitude in amps

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ |I| (A) |I| (A) items
Type: number

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ |V| (V)
Type: array of number

Bus voltage magnitude in volts

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ |V| (V) |V| (V) items
Type: number

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ phi (deg)
Type: array of number

Bus voltage angles in degrees

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ phi (deg) phi (deg) items
Type: number

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ theta (deg)
Type: array of number

Fault current angles in degrees

Each item of this array must be:

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ theta (deg) theta (deg) items
Type: number

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ Re(I0) (A)
Type: number

Real part of the zero sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ Re(I1) (A)
Type: number

Real part of the positive sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ Re(I2) (A)
Type: number

Real part of the negative sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ Im(I0) (A)
Type: number

Imaginary part of the zero sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ Im(I1) (A)
Type: number

Imaginary part of the positive sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ Im(I2) (A)
Type: number

Imaginary part of the negative sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ |I0| (A)
Type: number

magnitude of zero sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ |I1| (A)
Type: number

magnitude of positive sequence current in amps

root Fault currents Fault currents items ^.+$ ^[3p|3pg|ll|llg|lg]$ ^\d+$ line ^.+$ |I2| (A)
Type: number

magnitude of negative sequence current in amps

Example:

[
    {
        "701_lg_1": {
            "fault": {
                "susceptance (S)": [
                    [
                        0,
                        0
                    ],
                    [
                        0,
                        0
                    ]
                ],
                "connections": [
                    1,
                    4
                ],
                "conductance (S)": [
                    [
                        100,
                        -100
                    ],
                    [
                        -100,
                        100
                    ]
                ],
                "bus": "701",
                "type": "lg"
            },
            "switch": {
                "671692": {
                    "|I| (A)": null,
                    "|I2| (A)": 0.8,
                    "|I0| (A)": 1.2,
                    "|I1| (A)": 90.1,
                    "|V| (V)": [
                        2.5,
                        2.5,
                        2.5
                    ]
                }
            }
        }
    }
]

root Small signal stable
Type: array of boolean

Output from small signal stability analysis

Each item of this array must be:

root Small signal stable Small signal stable items
Type: boolean

root Switch changes
Type: array of array

List of lists of switches whose state changed between timesteps

Each item of this array must be:

root Switch changes Switch changes items
Type: array of string

Each item of this array must be:

root Switch changes Switch changes items Switch changes items items
Type: string

root Optimal switching metadata
Type: array

Results (not the solutions) from the optimal switching alogrithm, including information about the solver, solve time, mip_gap, etc. If opt-switch-algorithm=global is used, there will only be a single dict

Each item of this array must be:

root Optimal switching metadata output-optimization_metadata.schema.json
Type: object

Information about the optimization results

root Optimal switching metadata optimization_metadata solve_time
Type: number

Duration of time spent in solver

root Optimal switching metadata optimization_metadata optimizer
Type: string

Name of the optimizer used

root Optimal switching metadata optimization_metadata termination_status
Type: string

The status of the solve from the optimizer

root Optimal switching metadata optimization_metadata dual_status
Type: string

the Dual Status from the optimizer

root Optimal switching metadata optimization_metadata primal_status
Type: string

The primal status from the optimizer

root Optimal switching metadata optimization_metadata objective
Type: number

The final value of the problem objective

root Optimal switching metadata optimization_metadata mip_gap
Type: number

The MIP (optimality) gap, if available

root Optimal switching metadata optimization_metadata objective_lb
Type: number

The lower bound on the objective, if exists, from the solver

root Optimal dispatch metadata
Type: object

Information about the optimization results

Same definition as optimization_metadata

root Fault studies metadata
Type: array of object

Outputs from fault studies

Each item of this array must be:

root Fault studies metadata Fault studies metadata items
Type: object

Fault study per time step

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Fault studies metadata Fault studies metadata items ^.+$
Type: object

Fault study at bus

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[3p|3pg|llg|lg|ll]$
root Fault studies metadata Fault studies metadata items ^.+$ ^[3p|3pg|llg|lg|ll]$
Type: object

Fault study with fault type of

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^\d+$
root Fault studies metadata Fault studies metadata items ^.+$ ^[3p|3pg|llg|lg|ll]$ output-optimization_metadata.schema.json
Type: object

Information about the optimization results

Same definition as optimization_metadata

root System metadata
Type: object

Metadata about the system that ran the ONM process

root System metadata platform
Type: string Default: "string(Sys.MACHINE)"

output of Julia Sys.MACHINE

root System metadata cpu_info
Type: string Default: "string(first(Sys.cpu_info()).model)"

Output of Julia first(Sys.cpu_info()).model

root System metadata physical_cores
Type: integer Default: "Hwloc.num_physical_cores()"

Output of Julia Hwloc.num_physical_cores()

root System metadata logical_processors
Type: integer Default: "Hwloc.num_virtual_cores()"

Output of Julia Hwloc.num_virtual_cores()

root System metadata system_memory
Type: number Default: "round(Int, Sys.total_memory() / 2^20 / 1024)"

Output of Julia Sys.total_memory() in GB

root System metadata julia_max_threads
Type: integer Default: "Threads.nthreads()"

Output of Julia Threads.nthreads()

root System metadata julia_max_procs
Type: integer Default: "Distributed.nprocs()"

Number of processors available to Julia

root System metadata julia_version
Type: string Default: "string(Base.VERSION)"

Output of Julia.VERSION

root Protection settings
Type: object

Protection settings outputs

root Protection settings network_model
Type: object

Network data model used for computing optimal protection settings

root Protection settings network_model bus
Type: array of object

list of buses in the network model

Each item of this array must be:

root Protection settings network_model bus bus items
Type: object

Bus object

root Protection settings network_model bus bus items name
Type: string

Name of the bus

root Protection settings network_model bus bus items phases
Type: array of integer

Terminals on the bus

Each item of this array must be:

root Protection settings network_model bus bus items phases phases items
Type: integer

root Protection settings network_model bus bus items nphases
Type: integer

Number of phases on the bus

root Protection settings network_model bus bus items status
Type: enum (of integer)

Must be one of:

  • 0
  • 1

root Protection settings network_model line
Type: array of object

list of lines (including switches) in the network model

Each item of this array must be:

root Protection settings network_model line line items
Type: object

Line object

root Protection settings network_model line line items name
Type: string

name of the line or switch

root Protection settings network_model line line items f_bus
Type: string

bus on the from-side of the line

root Protection settings network_model line line items t_bus
Type: string

bus on the to-side of the line

root Protection settings network_model line line items f_connections
Type: array of integer

Phase connections on the from-side of the line

Each item of this array must be:

root Protection settings network_model line line items f_connections f_connections items
Type: integer

root Protection settings network_model line line items t_connections
Type: array of integer

Phase connections on the to-side of the line

Each item of this array must be:

root Protection settings network_model line line items t_connections t_connections items
Type: integer

root Protection settings network_model line line items rs
Type: array of array

Series resistance of the line in ohm/meter of size (fconnections, tconnections)

Each item of this array must be:

root Protection settings network_model line line items rs rs items
Type: array of number

Each item of this array must be:

root Protection settings network_model line line items rs rs items rs items items
Type: number

root Protection settings network_model line line items xs
Type: array of array

Series reactance of the line in ohm/meter of size (fconnections, tconnections)

Each item of this array must be:

root Protection settings network_model line line items xs xs items
Type: array of number

Each item of this array must be:

root Protection settings network_model line line items xs xs items xs items items
Type: number

root Protection settings network_model line line items nphases
Type: integer

number of phases in the line

root Protection settings network_model line line items switch
Type: boolean

Is the line a switch?

root Protection settings network_model line line items status
Type: enum (of integer)

Must be one of:

  • 0
  • 1

root Protection settings network_model transformer
Type: array of object

List of transformers in the network model

Each item of this array must be:

root Protection settings network_model transformer transformer items
Type: object

Transformer object

root Protection settings network_model transformer transformer items name
Type: string

Name of the transformer

root Protection settings network_model transformer transformer items buses
Type: array of string

List of buses (each winding)

Each item of this array must be:

root Protection settings network_model transformer transformer items buses buses items
Type: string

root Protection settings network_model transformer transformer items connections
Type: array of array

List of phase connections in the in the transformer (each winding)

Each item of this array must be:

root Protection settings network_model transformer transformer items connections connections items
Type: array of integer

Each item of this array must be:

root Protection settings network_model transformer transformer items connections connections items connections items items
Type: integer

root Protection settings network_model transformer transformer items configuration
Type: array of enum (of string)

List of configurations for each winding (WYE/DELTA)

Each item of this array must be:

root Protection settings network_model transformer transformer items configuration configuration items
Type: enum (of string)

Must be one of:

  • "WYE"
  • "DELTA"

root Protection settings network_model transformer transformer items vbase (kV)
Type: array of number

List of voltage bases for each winding in kV

Each item of this array must be:

root Protection settings network_model transformer transformer items vbase (kV) vbase (kV) items
Type: number

root Protection settings network_model transformer transformer items rating (kVA)
Type: number

Thermal rating of the transformer in kVA

root Protection settings network_model transformer transformer items status
Type: enum (of integer)

Must be one of:

  • 0
  • 1

root Protection settings network_model source
Type: array of object

List of generation sources, i.e., generators, storage, pvsystems, and vsources in the network model

Each item of this array must be:

root Protection settings network_model source source items
Type: object

Source object

root Protection settings network_model source source items name
Type: string

name of the source object

root Protection settings network_model source source items bus
Type: string

bus to which the source object is connected

root Protection settings network_model source source items type
Type: enum (of string)

type of the source object (generator, storage, vsource, pvsystem)

Must be one of:

  • "generator"
  • "pvsystem"
  • "storage"
  • "vsource"

root Protection settings network_model source source items connections
Type: array of integer

Phase connections of the source object

Each item of this array must be:

root Protection settings network_model source source items connections connections items
Type: integer

root Protection settings network_model source source items nphases
Type: integer

Number of phases in the source object

root Protection settings network_model source source items status
Type: enum (of integer)

Must be one of:

  • 0
  • 1

root Protection settings network_model protection
Type: array of object

List of protection devices, i.e., relays, fuses, and reclosers, in the network model

Each item of this array must be:

root Protection settings network_model protection protection items
Type: object

Protection object

root Protection settings network_model protection protection items name
Type: string

name of the protection object

root Protection settings network_model protection protection items type
Type: enum (of string)

type of protection (relay, fuse, recloser)

Must be one of:

  • "recloser"
  • "relay"
  • "fuse"

root Protection settings network_model protection protection items location
Type: string

location of the protection object (monitoredobj)

root Protection settings bus_types
Type: array of object

Output from Protection optimization algorithm

Each item of this array must be:

root Protection settings bus_types bus_types items
Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Protection settings bus_types bus_types items ^.+$
Type: enum (of string)

Must be one of:

  • "pq"
  • "pv"
  • "ref"
  • "isolated"

root Protection settings settings
Type: array of object

Output from Protection optimization algorithm

Each item of this array must be:

root Protection settings settings settings items
Type: object

root Protection settings settings settings items TDS
Type: array of number

Each item of this array must be:

root Protection settings settings settings items TDS TDS items
Type: number

root Protection settings settings settings items to
Type: array of string

Each item of this array must be:

root Protection settings settings settings items to to items
Type: string

root Protection settings settings settings items from
Type: array of string

Each item of this array must be:

root Protection settings settings settings items from from items
Type: string

root Protection settings settings settings items TOC
Type: array of string

Each item of this array must be:

root Protection settings settings settings items TOC TOC items
Type: string