Settings

Type: object

Network settings to apply to the base network (i.e., all multinetwork timesteps, not a specific one), such as bus voltage bounds, load priorities, cold load pickup, and global settings such as maximum switch actions per timestep and time elapsed per time step.

Additional properties on each object are allowed, but the object types are restricted to those in the ONM model.

 No Additional Properties
Example:

{
    "switch_close_actions_ub": [
        1,
        1,
        1
    ],
    "time_elapsed": [
        0.1667,
        0.1667,
        0.1667
    ],
    "load": {
        "671": {
            "clpu_factor": 2
        }
    }
}

root settings
Type: object

root settings sbase_default
Type: number

root settings vbase_defaults
Type: object

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

Property name regular expression: ^.+$
root settings vbase_defaults ^.+$
Type: number

root generator
Type: object

generator objects indexed by name

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

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

generator object

root generator ^.+$ pg_lb
Type: array of number

real power lower bounds in kW

Each item of this array must be:

root generator ^.+$ pg_lb pg_lb items
Type: number

root generator ^.+$ pg_ub
Type: array of number

real power upper bounds in kW

Each item of this array must be:

root generator ^.+$ pg_ub pg_ub items
Type: number

root generator ^.+$ pg
Type: array of number

real power setpoint in kW

Each item of this array must be:

root generator ^.+$ pg pg items
Type: number

root generator ^.+$ qg_lb
Type: array of number

Reactive power lower bounds in kVar

Each item of this array must be:

root generator ^.+$ qg_lb qg_lb items
Type: number

root generator ^.+$ qg_ub
Type: array of number

Reactive power upper bounds in kVar

Each item of this array must be:

root generator ^.+$ qg_ub qg_ub items
Type: number

root generator ^.+$ qg
Type: array of number

Reactive power setpoint in kVar

Each item of this array must be:

root generator ^.+$ qg qg items
Type: number

root generator ^.+$ control_mode
Type: enum (of string)

The control mode, i.e. FREQUENCYDROOP (grid-following) or ISOCHRONOUS (grid-forming)

Must be one of:

  • "FREQUENCYDROOP"
  • "ISOCHRONOUS"

root generator ^.+$ status
Type: enum (of integer or string)

The status of the generation object, i.e. enabled (1) or disabled (0)

Must be one of:

  • 0
  • 1
  • "ENABLED"
  • "DISABLED"

root generator ^.+$ cost_pg_parameters
Type: array of number

Cost model polynomial or piecewise parameters

Each item of this array must be:

root generator ^.+$ cost_pg_parameters cost_pg_parameters items
Type: number

root generator ^.+$ cost_pg_model
Type: integer

Cost model type, 1 = piecewise-linear, 2 = polynomial

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

Must be one of:

  • "GRID_FOLLOWING"
  • "GRID_FORMING"

root solar
Type: object

pv solar objects, indexed by name

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

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

pv solar object

root solar ^.+$ pg_lb
Type: array of number

real power lower bounds in kW

Each item of this array must be:

root solar ^.+$ pg_lb pg_lb items
Type: number

root solar ^.+$ pg_ub
Type: array of number

real power upper bounds in kW

Each item of this array must be:

root solar ^.+$ pg_ub pg_ub items
Type: number

root solar ^.+$ pg
Type: array of number

real power setpoint in kW

Each item of this array must be:

root solar ^.+$ pg pg items
Type: number

root solar ^.+$ qg_lb
Type: array of number

Reactive power lower bounds in kVar

Each item of this array must be:

root solar ^.+$ qg_lb qg_lb items
Type: number

root solar ^.+$ qg_ub
Type: array of number

Reactive power upper bounds in kVar

Each item of this array must be:

root solar ^.+$ qg_ub qg_ub items
Type: number

root solar ^.+$ qg
Type: array of number

Reactive power setpoint in kVar

Each item of this array must be:

root solar ^.+$ qg qg items
Type: number

root solar ^.+$ control_mode
Type: enum (of string)

The control mode, i.e. FREQUENCYDROOP (grid-following) or ISOCHRONOUS (grid-forming)

Must be one of:

  • "FREQUENCYDROOP"
  • "ISOCHRONOUS"

root solar ^.+$ status
Type: enum (of integer or string)

The status of the generation object, i.e. enabled (1) or disabled (0)

Must be one of:

  • 0
  • 1
  • "ENABLED"
  • "DISABLED"

root solar ^.+$ cost_pg_parameters
Type: array of number

Cost model polynomial or piecewise parameters

Each item of this array must be:

root solar ^.+$ cost_pg_parameters cost_pg_parameters items
Type: number

root solar ^.+$ cost_pg_model
Type: integer

Cost model type, 1 = piecewise-linear, 2 = polynomial

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

Must be one of:

  • "GRID_FOLLOWING"
  • "GRID_FORMING"

root voltage_source
Type: object

voltage source objects, indexed by name

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

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

voltage source object

root voltage_source ^.+$ pg_lb
Type: array

real power lower bounds in kW

Each item of this array must be:

root voltage_source ^.+$ pg_lb pg_lb items
Type: number or null

root voltage_source ^.+$ pg_ub
Type: array

real power upper bounds in kW

Each item of this array must be:

root voltage_source ^.+$ pg_ub pg_ub items
Type: number or null

root voltage_source ^.+$ pg
Type: array of number

real power setpoint in kW

Each item of this array must be:

root voltage_source ^.+$ pg pg items
Type: number

root voltage_source ^.+$ qg_lb
Type: array

Reactive power lower bounds in kVar

Each item of this array must be:

root voltage_source ^.+$ qg_lb qg_lb items
Type: number or null

root voltage_source ^.+$ qg_ub
Type: array

Reactive power upper bounds in kVar

Each item of this array must be:

root voltage_source ^.+$ qg_ub qg_ub items
Type: number or null

root voltage_source ^.+$ qg
Type: array of number

Reactive power setpoint in kVar

Each item of this array must be:

root voltage_source ^.+$ qg qg items
Type: number

root voltage_source ^.+$ control_mode
Type: enum (of string)

The control mode, i.e. FREQUENCYDROOP (grid-following) or ISOCHRONOUS (grid-forming)

Must be one of:

  • "FREQUENCYDROOP"
  • "ISOCHRONOUS"

root voltage_source ^.+$ status
Type: enum (of integer or string)

The status of the generation object, i.e. enabled (1) or disabled (0)

Must be one of:

  • 0
  • 1
  • "ENABLED"
  • "DISABLED"

root voltage_source ^.+$ cost_pg_parameters
Type: array of number

Cost model polynomial or piecewise parameters

Each item of this array must be:

root voltage_source ^.+$ cost_pg_parameters cost_pg_parameters items
Type: number

root voltage_source ^.+$ cost_pg_model
Type: integer

Cost model type, 1 = piecewise-linear, 2 = polynomial

root voltage_source ^.+$ inverter
Type: enum (of string) Default: "GRID_FORMING"

Must be one of:

  • "GRID_FORMING"
  • "GRID_FOLLOWING"

root storage
Type: object

energy storage objects indexed by name

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

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

energy storage object

root storage ^.+$ energy_ub
Type: number

upper bound of energy that can be stored in kWhrs

root storage ^.+$ charge_ub
Type: number

upper bound of energy that can be inserted into the battery kW

root storage ^.+$ discharge_ub
Type: number

upper bound of energy that can be withdrawn from the battery in kW

root storage ^.+$ sm_ub
Type: number or null

upper bound on the power in or out of the battery

root storage ^.+$ energy
Type: number

currently stored energy in the battery in kWh

root storage ^.+$ qs_lb
Type: number or null

lower bound of reactive power that can be outputted in kvar

root storage ^.+$ qs_ub
Type: number or null

upper bound of reactive power that can be outputted in kvar

root storage ^.+$ pex
Type: number

real power losses

root storage ^.+$ qex
Type: number

reactive power losses

root storage ^.+$ status
Type: enum (of integer or string)

the status of the asset, i.e. enabled (1) or disabled (0)

Must be one of:

  • 0
  • 1
  • "ENABLED"
  • "DISABLED"

root storage ^.+$ phase_unbalance_ub
Type: number or null

Percent within which power input/output must be on between phases on the storage object

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

Must be one of:

  • "GRID_FOLLOWING"
  • "GRID_FORMING"

root bus
Type: object

bus objects indexed by name

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

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

bus object

root bus ^.+$ microgrid_id
Type: string

identifier for which microgrid the bus belongs

root bus ^.+$ vm_lb
Type: array of number

the voltage magnitude lower bounds in volts

Each item of this array must be:

root bus ^.+$ vm_lb vm_lb items
Type: number

root bus ^.+$ vm_ub
Type: array

the voltage magnitude upper bounds in volts

Each item of this array must be:

root bus ^.+$ vm_ub vm_ub items
Type: number or null

root bus ^.+$ vm
Type: array of number

the voltage magnitude setpoint of the bus, useful in cases where the bus should act as a reference, e.g., because a grid-forming inverter is connected

Each item of this array must be:

root bus ^.+$ vm vm items
Type: number

root bus ^.+$ va
Type: array of number

the voltage angle setpoint of the bus, useful in cases where the bus should act as a reference, e.g., because a grid-forming inverter is connected

Each item of this array must be:

root bus ^.+$ va va items
Type: number

root bus ^.+$ status
Type: enum (of integer or string)

the status of the asset, i.e. enabled (1) or disabled (0)

Must be one of:

  • 0
  • 1
  • "ENABLED"
  • "DISABLED"

root load
Type: object

load objects indexed by name

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

Property name regular expression: ^.+$
root load ^.+$
Type: object

load object

root load ^.+$ clpu_factor
Type: number

cold load pickup factor

root load ^.+$ clpu_duration
Type: number

cold load pickup duration in ms

root load ^.+$ dispatchable
Type: enum (of integer or string)

Indicator for whether the load is individually dispatchable (i.e., can the load be shed autonomously, as opposed to only be sheddable via block isolation)

Must be one of:

  • 0
  • 1
  • "YES"
  • "NO"

root load ^.+$ status
Type: enum (of integer or string)

the status of the asset, i.e. enabled (1) or disabled (0)

Must be one of:

  • 0
  • 1
  • "ENABLED"
  • "DISABLED"

root load ^.+$ priority
Type: number

The priority of the load, i.e. a numerical value to indicate how important it is that the load not be shed

root shunt
Type: object

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

Property name regular expression: ^.+$
root shunt ^.+$
Type: object

root shunt ^.+$ status
Type: enum (of integer or string)

Must be one of:

  • "ENABLED"
  • "DISABLED"
  • 0
  • 1

root line
Type: object

line objects indexed by name

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

Property name regular expression: ^.+$
root line ^.+$
Type: object

line object

root line ^.+$ vad_lb
Type: array of number

voltage angle different lower bound in degrees

Each item of this array must be:

root line ^.+$ vad_lb vad_lb items
Type: number

root line ^.+$ vad_ub
Type: array of number

voltage angle difference upper bound in degrees

Each item of this array must be:

root line ^.+$ vad_ub vad_ub items
Type: number

root line ^.+$ cm_ub
Type: array

upper bounds on line currents in Amps

Each item of this array must be:

root line ^.+$ cm_ub cm_ub items
Type: number or null

root line ^.+$ sm_ub
Type: array

Each item of this array must be:

root line ^.+$ sm_ub sm_ub items
Type: number or null

root line ^.+$ status
Type: enum (of integer or string)

the status of the asset, i.e. enabled (1) or disabled (0)

Must be one of:

  • 0
  • 1
  • "ENABLED"
  • "DISABLED"

root switch
Type: object

switch objects indexed by

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

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

switch object

root switch ^.+$ state
Type: enum (of string)

The default state of the switch, i.e., open or closed

Must be one of:

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

root switch ^.+$ dispatchable
Type: enum (of integer or string)

is the switch autonomously operable by the ONM algorithm, i.e., yes (1) or no (2)

Must be one of:

  • 0
  • 1
  • "YES"
  • "NO"

root switch ^.+$ status
Type: enum (of integer or string)

the status of the asset, i.e. enabled (1) or disabled (0)

Must be one of:

  • 0
  • 1
  • "ENABLED"
  • "DISABLED"

root switch ^.+$ cm_ub
Type: array

current magnitude upper bound (normamps)

Each item of this array must be:

root switch ^.+$ cm_ub cm_ub items
Type: number or null

root switch ^.+$ sm_ub
Type: array

Each item of this array must be:

root switch ^.+$ sm_ub sm_ub items
Type: number or null

root switch ^.+$ vm_delta_pu_ub
Type: number Default: null

root switch ^.+$ va_delta_deg_ub
Type: number Default: null

root transformer
Type: object

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

Property name regular expression: ^.+$
root transformer ^.+$
Type: object

root transformer ^.+$ status
Type: string or integer

root transformer ^.+$ sm_ub
Type: number or null

root transformer ^.+$ cm_ub
Type: number or null

root options
Type: object

root options data
Type: object

root options data time-elapsed
Type: number or array of number

root options data switch-close-actions-ub
Type: number, array or null Default: null

root options data fix-small-numbers
Type: boolean Default: false

root options variables
Type: object

root options variables relax-integer-variables
Type: boolean Default: false

Flag to relax an integer (binary) variables to be continuous

root options variables unbound-voltage
Type: boolean Default: false

Flag to disable the upper bounds on voltage. Voltage magnitudes will still have a lower bound of 0.0

root options variables unbound-line-power
Type: boolean Default: false

Flag to disable bounds on line (branch) power variables

root options variables unbound-line-current
Type: boolean Default: false

Flag to disable bounds on line (branch) current variables

root options variables unbound-switch-power
Type: boolean Default: false

Flag to disable bounds on switch power variables

root options variables unbound-transformer-power
Type: boolean Default: false

Flag to disable bounds on transformer power variables

root options variables unbound-generation-power
Type: boolean Default: false

Flag to disable bounds on gen (generator, solar, voltage_source) power variables

root options variables unbound-storage-power
Type: boolean Default: false

Flag to disable bounds on storage variables, including power, charge, discharge, and energy

root options constraints
Type: object

root options constraints disable-grid-forming-inverter-constraint
Type: boolean Default: false

Flag to disable the grid-forming inverter constraint, which enforces that there be exactly one grid-forming inverter in each energized connected component

root options constraints disable-block-isolation-constraint
Type: boolean Default: false

Flag to disable the block isolation constraint, which requires that switches between load blocks of differing status be open

root options constraints disable-radiality-constraint
Type: boolean Default: false

Flag to disable the radiality constraint, which requires that each energized connected component be radial in its topology (no cycles)

root options constraints disable-microgrid-networking
Type: boolean Default: false

Flag to disable microgrid networking. When enabled, microgrids are allowed to expand (pick up load), but may not network with one another

root options constraints disable-current-limit-constraints
Type: boolean Default: false

Flag to disable current limit constraints (ampacity) on lines and switches

root options constraints disable-thermal-limit-constraints
Type: boolean Default: false

Flag to disable thermal limit constraints (power) on lines, switches, and energy storage

root options constraints disable-switch-close-action-limit
Type: boolean Default: false

Flag to disable the switch close-action limit, which limits the number of closing actions that may occur in a timestep

root options constraints disable-storage-unbalance-constraint
Type: boolean Default: false

Flag to disable the storage unbalance constraint, which requires that grid-following storage devices output power within some factor of one another

root options constraints disable-microgrid-expansion
Type: boolean Default: false

Flag to disable microgrid expansion. When enabled, would prevent microgrids from growing any larger, but not prevent switching actions within the boundary of a microgrid

root options constraints enable-strictly-increasing-restoration-constraint
Type: boolean Default: false

Flag to enable a constraint that requires that load restoration be strictly increasing, that is, load blocks once energized cannot be de-energized in a later timestep

root options constraints disable-switch-open-voltage-distance-constaint
Type: boolean Default: true

Flag to disable a constraint that encourages voltages on either side of OPEN switches remain with some distance of each other

root options objective
Type: object

root options objective disable-switch-state-change-cost
Type: boolean Default: false

Flag to disable the cost term in the objective function related to change of state in switches (open-close, close-open)

root options objective enable-switch-state-open-cost
Type: boolean Default: false

Flag to enable the cost term that adds a cost for open switches based on how much load is between them and some source of energy

root options objective disable-generation-dispatch-cost
Type: boolean Default: false

Flag to disable the generation cost term

root options objective disable-storage-discharge-cost
Type: boolean Default: false

Flag to disable the storage discharge cost term, which adds a penalty for storage that is not completely charged to its upper bound

root options objective disable-load-block-weight-cost
Type: boolean Default: false

Flag to disable the weight terms on the load-block cost term (i.e., make the cost of every shed load block be equal)

root options objective disable-load-block-shed-cost
Type: boolean Default: false

Flag to disable the cost of not energizing load blocks

root options objective disable-voltage-distance-slack-cost
Type: boolean Default: true

Flag to disable the inclusion of voltage distance slack variables in the objective_mc_min_storage_utilization objective function

root options problem
Type: object

root options problem operations-algorithm
Type: enum (of string) Default: "full-lookahead"

Choice for operations optimization algorithm, 'rolling-horizon' or 'full-lookahead'

Must be one of:

  • "rolling-horizon"
  • "full-lookahead"
  • "robust"

root options problem operations-formulation
Type: enum (of string) Default: "LPUBFDiagPowerModel"

Choice for operations optimization formulation

Must be one of:

  • "lindistflow"
  • "transportation"
  • "acp"
  • "acr"
  • "nfa"
  • "lpubfdiag"
  • "LPUBFDiagPowerModel"
  • "ACPUPowerModel"
  • "ACRUPowerModel"
  • "NFAUPowerModel"

root options problem operations-problem-type
Type: enum (of string) Default: "block"

Choice for operations optimization problem type, 'block' or 'traditional'

Must be one of:

  • "block"
  • "traditional"

root options problem operations-solver
Type: enum (of string) Default: "mip_solver"

Choice for operations optimization solver

Must be one of:

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

root options problem dispatch-formulation
Type: enum (of string) Default: "LPUBFDiagPowerModel"

Choice for dispatch optimizatioin formulation

Must be one of:

  • "nfa"
  • "lindistflow"
  • "acp"
  • "acr"
  • "ivr"
  • "transportation"
  • "lpubfdiag"
  • "NFAUPowerModel"
  • "LPUBFDiagPowerModel"
  • "ACRUPowerModel"
  • "ACPUPowerModel"
  • "IVRUPowerModel"

root options problem dispatch-solver
Type: enum (of string) Default: "nlp_solver"

Choice for dispatch optimization solver

Must be one of:

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

root options problem fault-studies-solver
Type: enum (of string) Default: "nlp_solver"

Choice for fault studies optimization solver

Must be one of:

  • "nlp_solver"

root options problem stability-solver
Type: enum (of string) Default: "nlp_solver"

Choice for stability analysis optimization solver

Must be one of:

  • "nlp_solver"

root options problem stability-formulation
Type: enum (of string) Default: "ACRUPowerModel"

Choice for stability analysis formulation

Must be one of:

  • "acp"
  • "acr"
  • "ACRUPowerModel"
  • "ACPUPowerModel"

root options problem concurrent-fault-studies
Type: boolean Default: true

Flag to run the fault studies concurrently (in parallel, using Distributed)

root options problem concurrent-stability-studies
Type: boolean Default: true

Flag to run the stability studies concurrently (in parallel, using Distributed)

root options problem skip
Type: array of enum (of string)

List of optimizations or studies to skip, when running using entrypoint function

Each item of this array must be:

root options problem skip skip items
Type: enum (of string)

Must be one of:

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

root options outputs
Type: object

root options outputs log-level
Type: enum (of string) Default: "warn"

Setting to adjust the console log-level

Must be one of:

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

root options outputs pretty-print
Type: boolean Default: true

Flag to enable 'pretty printing' of JSON output

root options outputs sparse-fault-studies
Type: boolean Default: true

Flag to disable the create of sparse fault studies (if no faults are specified, one of every type will be applied at every bus

root options outputs debug-output
Type: boolean Default: false

Flag to enable debugging outputs (the full data structure), when used with entrypoint

root solvers
Type: object

Solver options

root solvers HiGHS
Type: object

These are the options used for the HiGHS optimization solver. The options below are a set of sane defaults for this solver, but users are not restricted to these options, and may use any valid options for this solver

root solvers HiGHS output_flag
Type: boolean Default: false

root solvers HiGHS presolve
Type: enum (of string) Default: "choose"

Must be one of:

  • "on"
  • "off"
  • "choose"

root solvers HiGHS primal_feasibility_tolerance
Type: number Default: 1e-06

root solvers HiGHS dual_feasibility_tolerance
Type: number Default: 1e-06

root solvers HiGHS mip_feasibility_tolerance
Type: number Default: 0.0001

root solvers HiGHS mip_rel_gap
Type: number Default: 0.0001

root solvers HiGHS small_matrix_value
Type: number Default: 1e-12

root solvers HiGHS allow_unbounded_or_infeasible
Type: boolean Default: true

root solvers Ipopt
Type: object

These are the options used for the Ipopt optimization solver. The options below are a set of sane defaults for this solver, but users are not restricted to these options, and may use any valid options for this solver

root solvers Ipopt tol
Type: number Default: 1e-06

root solvers Ipopt mumps_mem_percent
Type: number Default: 200

root solvers Ipopt mu_strategy
Type: enum (of string) Default: "adaptive"

Must be one of:

  • "adaptive"
  • "monotone"

root solvers Ipopt print_level
Type: integer Default: 0

root solvers Juniper
Type: object

These are the options used for the Juniper optimization solver. The options below are a set of sane defaults for this solver, but users are not restricted to these options, and may use any valid options for this solver

root solvers Juniper branch_strategy
Type: enum (of string) Default: ":StrongPseuoCost"

Must be one of:

  • ":MostInfeasible"
  • ":PseudoCost"
  • ":StrongPseuoCost"
  • ":Reliability"

root solvers Juniper log_levels
Type: array of enum (of string)

Each item of this array must be:

root solvers Juniper log_levels log_levels items
Type: enum (of string)

Must be one of:

  • ":Table"
  • ":Info"
  • ":Options"

root solvers Juniper mip_gap
Type: number Default: 0.0001

root solvers Juniper traverse_strategy
Type: enum (of string) Default: ":BFS"

Must be one of:

  • ":DFS"
  • ":BFS"
  • ":DBFS"

root solvers Juniper allow_almost_solved_integral
Type: boolean Default: true

root solvers Juniper allow_almost_solved
Type: boolean Default: true

root solvers Juniper atol
Type: number Default: 1e-06

root solvers Gurobi
Type: object

These are the options used for the Gurobi optimization solver. The options below are a set of sane defaults for this solver, but users are not restricted to these options, and may use any valid options for this solver

root solvers Gurobi OutputFlag
Type: integer Default: 0

root solvers Gurobi GURO_PAR_DUMP
Type: integer Default: 0

root solvers Gurobi MIPGap
Type: number Default: 0.0001

root solvers Gurobi FeasibilityTol
Type: number Default: 1e-06

root solvers Gurobi Quad
Type: integer Default: 1

root solvers Gurobi NumericFocus
Type: integer Default: 3

root solvers Gurobi MIPFocus
Type: integer Default: 2

root solvers Gurobi DualReductions
Type: integer Default: 0

Value must be greater or equal to -1 and lesser or equal to 1

root solvers Gurobi Presolve
Type: integer Default: -1

Value must be greater or equal to -1 and lesser or equal to 2

root solvers KNITRO
Type: object

These are the options used for the KNITRO optimization solver. The options below are a set of sane defaults for this solver, but users are not restricted to these options, and may use any valid options for this solver

root solvers KNITRO outlev
Type: integer Default: 0

Value must be greater or equal to 0 and lesser or equal to 6

root solvers KNITRO mip_outlevel
Type: integer Default: 0

Value must be greater or equal to 0 and lesser or equal to 3

root solvers KNITRO opttol
Type: number Default: 0.0001

root solvers KNITRO feastol
Type: number Default: 1e-06

root solvers KNITRO algorithm
Type: integer Default: 3

root solvers KNITRO presolve
Type: integer Default: 1

root solvers useGurobi
Type: boolean Default: false

Flag to enable the usage of the Gurobi commercial solver

root solvers useKNITRO
Type: boolean Default: false

Flag to enable the usage of the KNITRO commercial solver

root dss
Type: object

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

Property name regular expression: ^.+$
root dss ^.+$
Type: object
No Additional Properties

root dss ^.+$ inverter
Type: string

Must be one of:

  • "GRID_FORMING"
  • "grid_forming"
  • "gfm"
  • "GRID_FOLLOWING"
  • "grid_following"
  • "gfl"

root dss ^.+$ enabled
Type: string

Must be one of:

  • "yes"
  • "no"
  • "YES"
  • "NO"
  • "y"
  • "n"
  • "Y"
  • "N"

root max_switch_actions
Type: array, integer or null

deprecated: options/data/switch-close-actions-ub

Each item of this array must be:

root max_switch_actions max_switch_actions items
Type: integer or null

root disable_networking
Type: boolean Default: false

deprecated: options/constraints/disable-microgrid-networking

root disable_radial_constraint
Type: boolean Default: false

deprecated: options/constraints/disable-radiality-constraint

root disable_isolation_constraint
Type: boolean Default: false

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

root disable_inverter_constraint
Type: boolean Default: false

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

root disable_switch_penalty
Type: boolean

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

root apply_switch_scores
Type: boolean

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

root disable_presolver
Type: boolean Default: false

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

root time_elapsed
Type: array of number or number

deprecated: options/data/time-elapsed

Each item of this array must be:

root time_elapsed time_elapsed items
Type: number

root nlp_solver_tol
Type: number

deprecated: {solvers/Ipopt/tol,solvers/KNITRO/feastol}

root mip_solver_tol
Type: number

deprecated: {solvers/HiGHS/primalfeasibilitytolerance,solvers/HiGHS/dualfeasibilitytolerance,solvers/Gurobi/FeasibilityTol,solvers/Juniper/atol}

root mip_solver_gap
Type: numberFormat: float Default: 0.05

deprecated: {solvers/HiGHS/miprelgap,solvers/Gurobi/MIPGap,solvers/Juniper/mip_gap}

Value must be strictly greater than 0