Parameters
balance_type
A selector for how the
nodal_balance
constraint should be handled.
Default value: balance_type_node
Related Object Classes: node
A selector for how the nodal_balance
constraint should be handled.
benders_starting_connections_invested
Fixes the number of connections invested during the first Benders iteration
Default value: nothing
Related Object Classes: connection
benders_starting_storages_invested
Fixes the number of storages invested during the first Benders iteration
Default value: nothing
Related Object Classes: node
benders_starting_units_invested
Fixes the number of units invested during the first Benders iteration
Default value: nothing
Related Object Classes: unit
big_m
Sufficiently large number used for linearization bilinear terms, e.g. to enforce bidirectional flow for gas pipielines
Default value: 1000000
Related Object Classes: model
Sufficiently large number used for linearization bilinear terms, e.g. to enforce bidirectional flow for gas pipielines
block_end
The end time for the
temporal_block
. Can be given either as aDateTime
for a static end point, or as aDuration
for an end point relative to the start of the current optimization.
Default value: nothing
Related Object Classes: temporal_block
The end time for the temporal_block
. Can be given either as a DateTime
for a static end point, or as a Duration
for an end point relative to the start of the current optimization.
block_start
The start time for the
temporal_block
. Can be given either as aDateTime
for a static start point, or as aDuration
for an start point relative to the start of the current optimization.
Default value: nothing
Related Object Classes: temporal_block
The start time for the temporal_block
. Can be given either as a DateTime
for a static start point, or as a Duration
for an start point relative to the start of the current optimization.
candidate_connections
The number of connections that may be invested in
Default value: nothing
Related Object Classes: connection
The number of connections that may be invested in
candidate_storages
Determines the maximum number of new storages which may be invested in
Default value: nothing
Related Object Classes: node
Determines the maximum number of new storages which may be invested in
candidate_units
Number of units which may be additionally constructed
Default value: nothing
Related Object Classes: unit
Number of units which may be additionally constructed
commodity_lodf_tolerance
The minimum absolute value of the line outage distribution factor (LODF) that is considered meaningful.
Default value: 0.1
Related Object Classes: commodity
The minimum absolute value of the line outage distribution factor (LODF) that is considered meaningful.
commodity_physics
Defines if the
commodity
follows lodf or ptdf physics.
Default value: commodity_physics_none
Related Object Classes: commodity
Defines if the commodity
follows lodf or ptdf physics.
commodity_physics_duration
For how long the
commodity_physics
should apply relative to the start of the window.
Default value: nothing
Related Object Classes: commodity
For how long the commodity_physics
should apply relative to the start of the window.
commodity_ptdf_threshold
The minimum absolute value of the power transfer distribution factor (PTDF) that is considered meaningful.
Default value: 0.001
Related Object Classes: commodity
The minimum absolute value of the power transfer distribution factor (PTDF) that is considered meaningful.
compression_factor
The compression factor establishes a compression from an origin node to a receiving node, which are connected through a connection. The first node corresponds to the origin node, the second to the (compressed) destination node. Typically the value is >=1.
Default value: nothing
The compression factor establishes a compression from an origin node to a receiving node, which are connected through a connection. The first node corresponds to the origin node, the second to the (compressed) destination node. Typically the value is >=1.
connection_availability_factor
Availability of the
connection
, acting as a multiplier on itsconnection_capacity
. Typically between 0-1.
Default value: 1.0
Related Object Classes: connection
Availability of the connection
, acting as a multiplier on its connection_capacity
. Typically between 0-1.
connection_capacity
- For
connection__from_node
: Limits theconnection_flow
variable from thefrom_node
.from_node
can be a group ofnodes
, in which case the sum of theconnection_flow
is constrained.- For
connection__to_node
: Limits theconnection_flow
variable to theto_node
.to_node
can be a group ofnodes
, in which case the sum of theconnection_flow
is constrained.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
- For
connection__from_node
: Limits theconnection_flow
variable from thefrom_node
.from_node
can be a group ofnodes
, in which case the sum of theconnection_flow
is constrained.- For
connection__to_node
: Limits theconnection_flow
variable to theto_node
.to_node
can be a group ofnodes
, in which case the sum of theconnection_flow
is constrained.
connection_contingency
A boolean flag for defining a contingency
connection
.
Default value: nothing
Related Object Classes: connection
A boolean flag for defining a contingency connection
.
connection_conv_cap_to_flow
- For
connection__from_node
: Optional coefficient forconnection_capacity
unit conversions in the case that theconnection_capacity
value is incompatible with the desiredconnection_flow
units.- For
connection__to_node
: Optional coefficient forconnection_capacity
unit conversions in the case theconnection_capacity
value is incompatible with the desiredconnection_flow
units.
Default value: 1.0
Related Relationship Classes: connection__from_node and connection__to_node
- For
connection__from_node
: Optional coefficient forconnection_capacity
unit conversions in the case that theconnection_capacity
value is incompatible with the desiredconnection_flow
units.- For
connection__to_node
: Optional coefficient forconnection_capacity
unit conversions in the case theconnection_capacity
value is incompatible with the desiredconnection_flow
units.
connection_decommissioning_cost
Costs associated with decommissioning a power plant. The costs will b discounted to the
discount_year
`at distribted equally over the decommissioning time.
Default value: nothing
Related Object Classes: connection
connection_decommissioning_time
A connection's decommissioning time, i.e., the time between the moment at which a connection decommissioning decision is takien, and the moment at which decommissioning is complete.
Default value: Dict{String, Any}("data" => "0h", "type" => "duration")
Related Object Classes: connection
connection_discount_rate_technology_specific
connection-specific discount rate used to calculate the connection's investment costs. If not specified, the model discount rate is used.
Default value: 0.0
Related Object Classes: connection
connection_emergency_capacity
- For
connection__from_node
: Post contingency flow capacity of aconnection
. Sometimes referred to as emergency rating- For
connection__to_node
: The maximum post-contingency flow on a monitoredconnection
.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
- For
connection__from_node
: Post contingency flow capacity of aconnection
. Sometimes referred to as emergency rating- For
connection__to_node
: The maximum post-contingency flow on a monitoredconnection
.
connection_flow_coefficient
- For
connection__from_node__user_constraint
: defines the user constraint coefficient on the connection flow variable in the from direction- For
connection__to_node__user_constraint
: defines the user constraint coefficient on the connection flow variable in the to direction
Default value: 0.0
Related Relationship Classes: connection__from_node__user_constraint and connection__to_node__user_constraint
- For
connection__from_node__user_constraint
: defines the user constraint coefficient on the connection flow variable in the from direction- For
connection__to_node__user_constraint
: defines the user constraint coefficient on the connection flow variable in the to direction
connection_flow_cost
Variable costs of a flow through a
connection
. E.g. EUR/MWh of energy throughput.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
Variable costs of a flow through a connection
. E.g. EUR/MWh of energy throughput.
connection_flow_delay
Delays the
connection_flows
associated with the latternode
in respect to theconnection_flows
associated with the firstnode
.
Default value: Dict{String, Any}("data" => "0h", "type" => "duration")
Delays the connection_flows
associated with the latter node
in respect to the connection_flows
associated with the first node
.
connection_flow_non_anticipativity_margin
Margin by which
connection_flow
variable can differ from the value in the previous window duringnon_anticipativity_time
.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
connection_flow_non_anticipativity_time
Period of time where the value of the
connection_flow
variable has to be fixed to the result from the previous window.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
connection_intact_flow_non_anticipativity_margin
Margin by which
connection_intact_flow
variable can differ from the value in the previous window duringnon_anticipativity_time
.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
connection_intact_flow_non_anticipativity_time
Period of time where the value of the
connection_intact_flow
variable has to be fixed to the result from the previous window.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
connection_investment_cost
The per unit investment cost for the connection over the
connection_investment_tech_lifetime
Default value: nothing
Related Object Classes: connection
The per unit investment cost for the connection over the connection_investment_tech_lifetime
connection_investment_econ_lifetime
Determines the minimum economical investment lifetime of a connection.
Default value: nothing
Related Object Classes: connection
connection_investment_lifetime_sense
A selector for
connection_lifetime
constraint sense.
Default value: >=
Related Object Classes: connection
connection_investment_tech_lifetime
Determines the maximum technical lifetime of a connection. Once invested, it remains in service for this long
Default value: nothing
Related Object Classes: connection
connection_investment_variable_type
Determines whether the investment variable is integer
variable_type_integer
or continuousvariable_type_continuous
Default value: connection_investment_variable_type_integer
Uses Parameter Value Lists: connection_investment_variable_type_list
Related Object Classes: connection
Determines whether the investment variable is integer variable_type_integer
or continuous variable_type_continuous
connection_lead_time
A connection's lead time, i.e., the time between the moment at which a connection investment decision is takien, and the moment at which the connection investment becomes operational.
Default value: Dict{String, Any}("data" => "0h", "type" => "duration")
Related Object Classes: connection
connection_linepack_constant
The linepack constant is a property of gas pipelines and relates the linepack to the pressure of the adjacent nodes.
Default value: nothing
The linepack constant is a property of gas pipelines and relates the linepack to the pressure of the adjacent nodes.
connection_monitored
A boolean flag for defining a contingency
connection
.
Default value: false
Related Object Classes: connection
A boolean flag for defining a contingency connection
.
connection_reactance
The per unit reactance of a
connection
.
Default value: nothing
Related Object Classes: connection
The per unit reactance of a connection
.
connection_reactance_base
If the reactance is given for a p.u. (e.g. p.u. = 100MW), the
connection_reactance_base
can be set to perform this conversion (e.g. *100).
Default value: 1
Related Object Classes: connection
If the reactance is given for a p.u. (e.g. p.u. = 100MW), the connection_reactance_base
can be set to perform this conversion (e.g. *100).
connection_resistance
The per unit resistance of a
connection
.
Default value: nothing
Related Object Classes: connection
The per unit resistance of a connection
.
connection_type
A selector between a normal and a lossless bidirectional
connection
.
Default value: connection_type_normal
Related Object Classes: connection
A selector between a normal and a lossless bidirectional connection
.
connections_invested_available_coefficient
coefficient of
connections_invested_available
in the specificuser_constraint
Default value: 0.0
connections_invested_big_m_mga
bigmmga should be chosen as small as possible but sufficiently large. For unitsinvestedmga an appropriate bigmmga would be twice the candidate connections.
Default value: nothing
Related Object Classes: connection
bigmmga should be chosen as small as possible but sufficiently large. For unitsinvestedmga an appropriate bigmmga would be twice the candidate connections.
connections_invested_coefficient
coefficient of
connections_invested
in the specificuser_constraint
Default value: 0.0
coefficient of connections_invested
in the specific user_constraint
connections_invested_mga
Defines whether a certain variable (here: connections_invested) will be considered in the maximal-differences of the mga objective
Default value: false
Related Object Classes: connection
Defines whether a certain variable (here: connections_invested) will be considered in the maximal-differences of the mga objective
connections_invested_mga_weight
Used to scale mga variables. For weightd sum mga method, the length of this weight given as an Array will determine the number of iterations.
Default value: 1
Related Object Classes: connection
constraint_sense
A selector for the sense of the
user_constraint
.
Default value: ==
Related Object Classes: user_constraint
A selector for the sense of the user_constraint
.
curtailment_cost
Costs for curtailing generation. Essentially, accrues costs whenever
unit_flow
not operating at its maximum available capacity. E.g. EUR/MWh
Default value: nothing
Related Object Classes: unit
Costs for curtailing generation. Essentially, accrues costs whenever unit_flow
not operating at its maximum available capacity. E.g. EUR/MWh
cyclic_condition
If the cyclic condition is set to true for a storage node, the
node_state
at the end of the optimization window has to be larger than or equal to the initial storage state.
Default value: false
Related Relationship Classes: node__temporal_block
If the cyclic condition is set to true for a storage node, the node_state
at the end of the optimization window has to be larger than or equal to the initial storage state.
db_lp_solver
Solver for MIP problems. Solver package must be added and pre-configured in Julia. Overrides lp_solver RunSpineOpt kwarg
Default value: HiGHS.jl
Related Object Classes: model
Solver for MIP problems. Solver package must be added and pre-configured in Julia. Overrides lp_solver RunSpineOpt kwarg
db_lp_solver_options
Map parameter containing LP solver option name option value pairs. See solver documentation for supported solver options
Default value: Dict{String, Any}("data" => Any[Any["HiGHS.jl", Dict{String, Any}("data" => Any[Any["presolve", "on"], Any["time_limit", 300.01]], "type" => "map", "index_type" => "str")], Any["Clp.jl", Dict{String, Any}("data" => Any[Any["LogLevel", 0.0]], "type" => "map", "index_type" => "str")]], "type" => "map", "index_type" => "str")
Related Object Classes: model
Map parameter containing LP solver option name option value pairs. See solver documentation for supported solver options
db_mip_solver
Solver for MIP problems. Solver package must be added and pre-configured in Julia. Overrides mip_solver RunSpineOpt kwarg
Default value: HiGHS.jl
Related Object Classes: model
Solver for MIP problems. Solver package must be added and pre-configured in Julia. Overrides mip_solver RunSpineOpt kwarg
db_mip_solver_options
Map parameter containing MIP solver option name option value pairs for MIP. See solver documentation for supported solver options
Default value: Dict{String, Any}("data" => Any[Any["HiGHS.jl", Dict{String, Any}("data" => Any[Any["presolve", "on"], Any["mip_rel_gap", 0.01], Any["threads", 0.0], Any["time_limit", 300.01]], "type" => "map", "index_type" => "str")], Any["Cbc.jl", Dict{String, Any}("data" => Any[Any["ratioGap", 0.01], Any["logLevel", 0.0]], "type" => "map", "index_type" => "str")], Any["CPLEX.jl", Dict{String, Any}("data" => Any[Any["CPX_PARAM_EPGAP", 0.01]], "type" => "map", "index_type" => "str")]], "type" => "map", "index_type" => "str")
Related Object Classes: model
Map parameter containing MIP solver option name option value pairs for MIP. See solver documentation for supported solver options
demand
Demand for the
commodity
of anode
. Energy gains can be represented using negativedemand
.
Default value: 0.0
Related Object Classes: node
Demand for the commodity
of a node
. Energy gains can be represented using negative demand
.
demand_coefficient
coefficient of the specified node's demand in the specified user constraint
Default value: 0.0
coefficient of the specified node's demand in the specified user constraint
diff_coeff
Commodity diffusion coefficient between two
nodes
. Effectively, denotes the diffusion power per unit of state from the firstnode
to the second.
Default value: 0.0
Related Relationship Classes: node__node
Commodity diffusion coefficient between two nodes
. Effectively, denotes the diffusion power per unit of state from the first node
to the second.
discount_rate
The discount rate used for the discounting of future cashflows
Default value: 0
Related Object Classes: model
discount_year
The year to which all cashflows are discounted.
Default value: nothing
Related Object Classes: model
downward_reserve
Identifier for
node
s providing downward reserves
Default value: false
Related Object Classes: node
Identifier for node
s providing downward reserves
duration_unit
Defines the base temporal unit of the
model
. Currently supported values are either anhour
or aminute
.
Default value: hour
Related Object Classes: model
Defines the base temporal unit of the model
. Currently supported values are either an hour
or a minute
.
equal_investments
Whether all entities in the group must have the same investment decision.
Default value: false
Related Object Classes: investment_group
fix_binary_gas_connection_flow
Fix the value of the
connection_flow_binary
variable, and hence pre-determine the direction of flow in the connection.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
Fix the value of the connection_flow_binary
variable, and hence pre-determine the direction of flow in the connection.
fix_connection_flow
Fix the value of the
connection_flow
variable.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
Fix the value of the connection_flow
variable.
fix_connection_intact_flow
Fix the value of the
connection_intact_flow
variable.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
Fix the value of the connection_intact_flow
variable.
fix_connections_invested
Setting a value fixes the connections_invested variable accordingly
Default value: nothing
Related Object Classes: connection
Setting a value fixes the connections_invested variable accordingly
fix_connections_invested_available
Setting a value fixes the connectionsinvestedavailable variable accordingly
Default value: nothing
Related Object Classes: connection
Setting a value fixes the connectionsinvestedavailable variable accordingly
fix_node_pressure
Fixes the corresponding
node_pressure
variable to the provided value
Default value: nothing
Related Object Classes: node
Fixes the corresponding node_pressure
variable to the provided value
fix_node_state
Fixes the corresponding
node_state
variable to the provided value. Can be used for e.g. fixing boundary conditions.
Default value: nothing
Related Object Classes: node
Fixes the corresponding node_state
variable to the provided value. Can be used for e.g. fixing boundary conditions.
fix_node_voltage_angle
Fixes the corresponding
node_voltage_angle
variable to the provided value
Default value: nothing
Related Object Classes: node
Fixes the corresponding node_voltage_angle
variable to the provided value
fix_nonspin_units_shut_down
Fix the
nonspin_units_shut_down
variable.
Default value: nothing
Related Relationship Classes: unit__to_node
Fix the nonspin_units_shut_down
variable.
fix_nonspin_units_started_up
Fix the
nonspin_units_started_up
variable.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Fix the nonspin_units_started_up
variable.
fix_ratio_in_in_unit_flow
Fix the ratio between two
unit_flows
coming into theunit
from the twonodes
.
Default value: nothing
Related Relationship Classes: unit__node__node
Fix the ratio between two unit_flows
coming into the unit
from the two nodes
.
fix_ratio_in_out_unit_flow
Fix the ratio between an incoming
unit_flow
from the firstnode
and an outgoingunit_flow
to the secondnode
.
Default value: nothing
Related Relationship Classes: unit__node__node
Fix the ratio between an incoming unit_flow
from the first node
and an outgoing unit_flow
to the second node
.
fix_ratio_out_in_connection_flow
Fix the ratio between an outgoing
connection_flow
to the firstnode
and an incomingconnection_flow
from the secondnode
.
Default value: nothing
Fix the ratio between an outgoing connection_flow
to the first node
and an incoming connection_flow
from the second node
.
fix_ratio_out_in_unit_flow
Fix the ratio between an outgoing
unit_flow
to the firstnode
and an incomingunit_flow
from the secondnode
.
Default value: nothing
Related Relationship Classes: unit__node__node
Fix the ratio between an outgoing unit_flow
to the first node
and an incoming unit_flow
from the second node
.
fix_ratio_out_out_unit_flow
Fix the ratio between two
unit_flows
going from theunit
into the twonodes
.
Default value: nothing
Related Relationship Classes: unit__node__node
Fix the ratio between two unit_flows
going from the unit
into the two nodes
.
fix_storages_invested
Used to fix the value of the storages_invested variable
Default value: nothing
Related Object Classes: node
Used to fix the value of the storages_invested variable
fix_storages_invested_available
Used to fix the value of the storagesinvestedavailable variable
Default value: nothing
Related Object Classes: node
Used to fix the value of the storagesinvestedavailable variable
fix_unit_flow
Fix the
unit_flow
variable.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Fix the unit_flow
variable.
fix_unit_flow_op
Fix the
unit_flow_op
variable.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Fix the unit_flow_op
variable.
fix_units_invested
Fix the value of the
units_invested
variable.
Default value: nothing
Related Object Classes: unit
Fix the value of the units_invested
variable.
fix_units_invested_available
Fix the value of the
units_invested_available
variable
Default value: nothing
Related Object Classes: unit
Fix the value of the units_invested_available
variable
fix_units_on
Fix the value of the
units_on
variable.
Default value: nothing
Related Object Classes: unit
Fix the value of the units_on
variable.
fix_units_on_coefficient_in_in
Optional coefficient for the
units_on
variable impacting thefix_ratio_in_in_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the fix_ratio_in_in_unit_flow
constraint.
fix_units_on_coefficient_in_out
Optional coefficient for the
units_on
variable impacting thefix_ratio_in_out_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the fix_ratio_in_out_unit_flow
constraint.
fix_units_on_coefficient_out_in
Optional coefficient for the
units_on
variable impacting thefix_ratio_out_in_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the fix_ratio_out_in_unit_flow
constraint.
fix_units_on_coefficient_out_out
Optional coefficient for the
units_on
variable impacting thefix_ratio_out_out_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the fix_ratio_out_out_unit_flow
constraint.
fix_units_out_of_service
Fix the value of the
units_out_of_service
variable.
Default value: nothing
Related Object Classes: unit
fixed_pressure_constant_0
Fixed pressure points for pipelines for the outer approximation of the Weymouth approximation. The direction of flow is the first node in the relationship to the second node in the relationship.
Default value: nothing
Fixed pressure points for pipelines for the outer approximation of the Weymouth approximation. The direction of flow is the first node in the relationship to the second node in the relationship.
fixed_pressure_constant_1
Fixed pressure points for pipelines for the outer approximation of the Weymouth approximation. The direction of flow is the first node in the relationship to the second node in the relationship.
Default value: nothing
Fixed pressure points for pipelines for the outer approximation of the Weymouth approximation. The direction of flow is the first node in the relationship to the second node in the relationship.
fom_cost
Fixed operation and maintenance costs of a
unit
. Essentially, a cost coefficient on the existing units (incl.number_of_units
andunits_invested_available
) andunit_capacity
parameters. Currently, the value needs to be defined per duration unit (i.e. 1 hour), E.g. EUR/MW/h
Default value: nothing
Related Object Classes: unit
Fixed operation and maintenance costs of a unit
. Essentially, a cost coefficient on the existing units (incl. number_of_units
and units_invested_available
) and unit_capacity
parameters. Currently, the value needs to be defined per duration unit (i.e. 1 hour), E.g. EUR/MW/h
frac_state_loss
Self-discharge coefficient for
node_state
variables. Effectively, represents the loss power per unit of state.
Default value: 0.0
Related Object Classes: node
Self-discharge coefficient for node_state
variables. Effectively, represents the loss power per unit of state.
fractional_demand
The fraction of a
node
group'sdemand
applied for thenode
in question.
Default value: 0.0
Related Object Classes: node
The fraction of a node
group's demand
applied for the node
in question.
fuel_cost
Variable fuel costs than can be attributed to a
unit_flow
. E.g. EUR/MWh
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Variable fuel costs than can be attributed to a unit_flow
. E.g. EUR/MWh
graph_view_position
An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View.
Default value: nothing
Related Object Classes: connection, node and unit
Related Relationship Classes: connection__from_node, connection__to_node, unit__from_node__user_constraint, unit__from_node, unit__to_node__user_constraint and unit__to_node
An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View.
has_binary_gas_flow
This parameter needs to be set to
true
in order to represent bidirectional pressure drive gas transfer.
Default value: false
Related Object Classes: connection
This parameter needs to be set to true
in order to represent bidirectional pressure drive gas transfer.
has_pressure
A boolean flag for whether a
node
has anode_pressure
variable.
Default value: false
Related Object Classes: node
A boolean flag for whether a node
has a node_pressure
variable.
has_state
A boolean flag for whether a
node
has anode_state
variable.
Default value: false
Related Object Classes: node
A boolean flag for whether a node
has a node_state
variable.
has_voltage_angle
A boolean flag for whether a
node
has anode_voltage_angle
variable.
Default value: false
Related Object Classes: node
A boolean flag for whether a node
has a node_voltage_angle
variable.
initial_binary_gas_connection_flow
Initialize the value of the
connection_flow_binary
variable, and hence pre-determine the direction of flow in the connection.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
initial_connection_flow
Initialize the value of the
connection_flow
variable.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
initial_connection_intact_flow
Initialize the value of the
connection_intact_flow
variable.
Default value: nothing
Related Relationship Classes: connection__from_node and connection__to_node
initial_connections_invested
Setting a value fixes the connections_invested variable at the beginning
Default value: nothing
Related Object Classes: connection
initial_connections_invested_available
Setting a value fixes the connectionsinvestedavailable variable at the beginning
Default value: nothing
Related Object Classes: connection
initial_node_pressure
Initializes the corresponding
node_pressure
variable to the provided value
Default value: nothing
Related Object Classes: node
initial_node_state
Initializes the corresponding
node_state
variable to the provided value.
Default value: nothing
Related Object Classes: node
initial_node_voltage_angle
Initializes the corresponding
node_voltage_angle
variable to the provided value
Default value: nothing
Related Object Classes: node
initial_nonspin_units_shut_down
Initialize the
nonspin_units_shut_down
variable.
Default value: nothing
Related Relationship Classes: unit__to_node
initial_nonspin_units_started_up
Initialize the
nonspin_units_started_up
variable.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
initial_storages_invested
Used to initialze the value of the storages_invested variable
Default value: nothing
Related Object Classes: node
initial_storages_invested_available
Used to initialze the value of the storagesinvestedavailable variable
Default value: nothing
Related Object Classes: node
initial_unit_flow
Initialize the
unit_flow
variable.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
initial_unit_flow_op
Initialize the
unit_flow_op
variable.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
initial_units_invested
Initialize the value of the
units_invested
variable.
Default value: nothing
Related Object Classes: unit
initial_units_invested_available
Initialize the value of the
units_invested_available
variable
Default value: nothing
Related Object Classes: unit
initial_units_on
Initialize the value of the
units_on
variable.
Default value: nothing
Related Object Classes: unit
initial_units_out_of_service
Initialize the value of the
units_out_of_service
variable.
Default value: nothing
Related Object Classes: unit
is_active
If false, the object is excluded from the model if the tool filter object activity control is specified
Default value: true
Related Object Classes: commodity, connection, model, node, output, report, stage, stochastic_scenario, stochastic_structure, temporal_block, unit and user_constraint
Related Relationship Classes: node__stochastic_structure, node__temporal_block, unit__from_node, unit__to_node, units_on__stochastic_structure and units_on__temporal_block
If false, the object is excluded from the model if the tool filter object activity control is specified
is_non_spinning
A boolean flag for whether a
node
is acting as a non-spinning reserve
Default value: false
Related Object Classes: node
A boolean flag for whether a node
is acting as a non-spinning reserve
is_renewable
Whether the unit is renewable - used in the minimum renewable generation constraint within the Benders master problem
Default value: false
Related Object Classes: unit
Whether the unit is renewable - used in the minimum renewable generation constraint within the Benders master problem
is_reserve_node
A boolean flag for whether a
node
is acting as areserve_node
Default value: false
Related Object Classes: node
A boolean flag for whether a node
is acting as a reserve_node
max_cum_in_unit_flow_bound
Set a maximum cumulative upper bound for a
unit_flow
Default value: nothing
Related Relationship Classes: unit__commodity
Set a maximum cumulative upper bound for a unit_flow
max_gap
Specifies the maximum optimality gap for the model. Currently only used for the master problem within a decomposed structure
Default value: 0.05
Related Object Classes: model
Specifies the maximum optimality gap for the model. Currently only used for the master problem within a decomposed structure
max_iterations
Specifies the maximum number of iterations for the model. Currently only used for the master problem within a decomposed structure
Default value: 10.0
Related Object Classes: model
Specifies the maximum number of iterations for the model. Currently only used for the master problem within a decomposed structure
max_mga_iterations
Define the number of mga iterations, i.e. how many alternative solutions will be generated.
Default value: nothing
Related Object Classes: model
Define the number of mga iterations, i.e. how many alternative solutions will be generated.
max_mga_slack
Defines the maximum slack by which the alternative solution may differ from the original solution (e.g. 5% more than initial objective function value)
Default value: 0.05
Related Object Classes: model
Defines the maximum slack by which the alternative solution may differ from the original solution (e.g. 5% more than initial objective function value)
max_node_pressure
Maximum allowed gas pressure at
node
.
Default value: nothing
Related Object Classes: node
Maximum allowed gas pressure at node
.
max_ratio_in_in_unit_flow
Maximum ratio between two
unit_flows
coming into theunit
from the twonodes
.
Default value: nothing
Related Relationship Classes: unit__node__node
Maximum ratio between two unit_flows
coming into the unit
from the two nodes
.
max_ratio_in_out_unit_flow
Maximum ratio between an incoming
unit_flow
from the firstnode
and an outgoingunit_flow
to the secondnode
.
Default value: nothing
Related Relationship Classes: unit__node__node
Maximum ratio between an incoming unit_flow
from the first node
and an outgoing unit_flow
to the second node
.
max_ratio_out_in_connection_flow
Maximum ratio between an outgoing
connection_flow
to the firstnode
and an incomingconnection_flow
from the secondnode
.
Default value: nothing
Maximum ratio between an outgoing connection_flow
to the first node
and an incoming connection_flow
from the second node
.
max_ratio_out_in_unit_flow
Maximum ratio between an outgoing
unit_flow
to the firstnode
and an incomingunit_flow
from the secondnode
.
Default value: nothing
Related Relationship Classes: unit__node__node
Maximum ratio between an outgoing unit_flow
to the first node
and an incoming unit_flow
from the second node
.
max_ratio_out_out_unit_flow
Maximum ratio between two
unit_flows
going from theunit
into the twonodes
.
Default value: nothing
Related Relationship Classes: unit__node__node
Maximum ratio between two unit_flows
going from the unit
into the two nodes
.
max_total_cumulated_unit_flow_from_node
Bound on the maximum cumulated flows of a unit group from a node group e.g max consumption of certain commodity.
Default value: nothing
Related Relationship Classes: unit__from_node
Bound on the maximum cumulated flows of a unit group from a node group e.g max consumption of certain commodity.
max_total_cumulated_unit_flow_to_node
Bound on the maximum cumulated flows of a unit group to a node group, e.g. total GHG emissions.
Default value: nothing
Related Relationship Classes: unit__to_node
Bound on the maximum cumulated flows of a unit group to a node group, e.g. total GHG emissions.
max_units_on_coefficient_in_in
Optional coefficient for the
units_on
variable impacting themax_ratio_in_in_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the max_ratio_in_in_unit_flow
constraint.
max_units_on_coefficient_in_out
Optional coefficient for the
units_on
variable impacting themax_ratio_in_out_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the max_ratio_in_out_unit_flow
constraint.
max_units_on_coefficient_out_in
Optional coefficient for the
units_on
variable impacting themax_ratio_out_in_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the max_ratio_out_in_unit_flow
constraint.
max_units_on_coefficient_out_out
Optional coefficient for the
units_on
variable impacting themax_ratio_out_out_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the max_ratio_out_out_unit_flow
constraint.
max_voltage_angle
Maximum allowed voltage angle at
node
.
Default value: nothing
Related Object Classes: node
Maximum allowed voltage angle at node
.
maximum_capacity_invested_available
Upper bound on the capacity invested available in the group at any point in time.
Default value: nothing
Related Object Classes: investment_group
maximum_entities_invested_available
Upper bound on the number of entities invested available in the group at any point in time.
Default value: nothing
Related Object Classes: investment_group
min_capacity_margin
minimum capacity margin applying to the
node
ornode_group
Default value: nothing
Related Object Classes: node
minimum capacity margin applying to the node
or node_group
min_capacity_margin_penalty
penalty to apply to violations of the min capacitymargin constraint of the
node
or `nodegroup`
Default value: nothing
Related Object Classes: node
penalty to apply to violations of the min capacitymargin constraint of the node
or `nodegroup`
min_down_time
Minimum downtime of a
unit
after it shuts down.
Default value: nothing
Related Object Classes: unit
Minimum downtime of a unit
after it shuts down.
min_iterations
Specifies the minimum number of iterations for the model. Currently only used for the master problem within a decomposed structure
Default value: 1.0
Related Object Classes: model
min_node_pressure
Minimum allowed gas pressure at
node
.
Default value: nothing
Related Object Classes: node
Minimum allowed gas pressure at node
.
min_ratio_in_in_unit_flow
Minimum ratio between two
unit_flows
coming into theunit
from the twonodes
.
Default value: nothing
Related Relationship Classes: unit__node__node
Minimum ratio between two unit_flows
coming into the unit
from the two nodes
.
min_ratio_in_out_unit_flow
Minimum ratio between an incoming
unit_flow
from the firstnode
and an outgoingunit_flow
to the secondnode
.
Default value: nothing
Related Relationship Classes: unit__node__node
Minimum ratio between an incoming unit_flow
from the first node
and an outgoing unit_flow
to the second node
.
min_ratio_out_in_connection_flow
Minimum ratio between an outgoing
connection_flow
to the firstnode
and an incomingconnection_flow
from the secondnode
.
Default value: nothing
Minimum ratio between an outgoing connection_flow
to the first node
and an incoming connection_flow
from the second node
.
min_ratio_out_in_unit_flow
Minimum ratio between an outgoing
unit_flow
to the firstnode
and an incomingunit_flow
from the secondnode
.
Default value: nothing
Related Relationship Classes: unit__node__node
Minimum ratio between an outgoing unit_flow
to the first node
and an incoming unit_flow
from the second node
.
min_ratio_out_out_unit_flow
Minimum ratio between two
unit_flows
going from theunit
into the twonodes
.
Default value: nothing
Related Relationship Classes: unit__node__node
Minimum ratio between two unit_flows
going from the unit
into the two nodes
.
min_total_cumulated_unit_flow_from_node
Bound on the minimum cumulated flows of a unit group from a node group.
Default value: nothing
Related Relationship Classes: unit__from_node
Bound on the minimum cumulated flows of a unit group from a node group.
min_total_cumulated_unit_flow_to_node
Bound on the minimum cumulated flows of a unit group to a node group, e.g. total renewable production.
Default value: nothing
Related Relationship Classes: unit__to_node
Bound on the minimum cumulated flows of a unit group to a node group, e.g. total renewable production.
min_unit_flow
Set lower bound of the
unit_flow
variable.
Default value: 0.0
Related Relationship Classes: unit__from_node and unit__to_node
min_units_on_coefficient_in_in
Optional coefficient for the
units_on
variable impacting themin_ratio_in_in_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the min_ratio_in_in_unit_flow
constraint.
min_units_on_coefficient_in_out
Optional coefficient for the
units_on
variable impacting themin_ratio_in_out_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the min_ratio_in_out_unit_flow
constraint.
min_units_on_coefficient_out_in
Optional coefficient for the
units_on
variable impacting themin_ratio_out_in_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the min_ratio_out_in_unit_flow
constraint.
min_units_on_coefficient_out_out
Optional coefficient for the
units_on
variable impacting themin_ratio_out_out_unit_flow
constraint.
Default value: 0.0
Related Relationship Classes: unit__node__node
Optional coefficient for the units_on
variable impacting the min_ratio_out_out_unit_flow
constraint.
min_up_time
Minimum uptime of a
unit
after it starts up.
Default value: nothing
Related Object Classes: unit
Minimum uptime of a unit
after it starts up.
min_voltage_angle
Minimum allowed voltage angle at
node
.
Default value: nothing
Related Object Classes: node
Minimum allowed voltage angle at node
.
minimum_capacity_invested_available
Lower bound on the capacity invested available in the group at any point in time.
Default value: nothing
Related Object Classes: investment_group
minimum_entities_invested_available
Lower bound on the number of entities invested available in the group at any point in time.
Default value: nothing
Related Object Classes: investment_group
minimum_operating_point
Minimum level for the
unit_flow
relative to theunits_on
online capacity.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Minimum level for the unit_flow
relative to the units_on
online capacity.
minimum_reserve_activation_time
Duration a certain reserve product needs to be online/available
Default value: nothing
Related Object Classes: node
Duration a certain reserve product needs to be online/available
model_algorithm
The algorithm to run (e.g., basic, MGA)
Default value: basic_algorithm
Related Object Classes: model
model_end
Defines the last timestamp to be modelled. Rolling optimization terminates after passing this point.
Default value: Dict{String, Any}("data" => "2000-01-02T00:00:00", "type" => "date_time")
Related Object Classes: model
Defines the last timestamp to be modelled. Rolling optimization terminates after passing this point.
model_start
Defines the first timestamp to be modelled. Relative
temporal_blocks
refer to this value for their start and end.
Default value: Dict{String, Any}("data" => "2000-01-01T00:00:00", "type" => "date_time")
Related Object Classes: model
Defines the first timestamp to be modelled. Relative temporal_blocks
refer to this value for their start and end.
model_type
The model type which gives the solution method (e.g. standerd, Benders)
Default value: spineopt_standard
Related Object Classes: model
The model type which gives the solution method (e.g. standerd, Benders)
mp_min_res_gen_to_demand_ratio
Minimum ratio of renewable generation to demand for this commodity - used in the minimum renewable generation constraint within the Benders master problem
Default value: nothing
Related Object Classes: commodity
Minimum ratio of renewable generation to demand for this commodity - used in the minimum renewable generation constraint within the Benders master problem
mp_min_res_gen_to_demand_ratio_slack_penalty
Penalty for violating the minimum renewable generation to demand ratio.
Default value: nothing
Related Object Classes: commodity
Penalty for violating the minimum renewable generation to demand ratio.
nodal_balance_sense
A selector for
nodal_balance
constraint sense.
Default value: ==
Related Object Classes: node
A selector for nodal_balance
constraint sense.
node_opf_type
A selector for the reference
node
(slack bus) when PTDF-based DC load-flow is enabled.
Default value: node_opf_type_normal
Related Object Classes: node
A selector for the reference node
(slack bus) when PTDF-based DC load-flow is enabled.
node_slack_penalty
A penalty cost for
node_slack_pos
andnode_slack_neg
variables. The slack variables won't be included in the model unless there's a cost defined for them.
Default value: nothing
Related Object Classes: node
A penalty cost for node_slack_pos
and node_slack_neg
variables. The slack variables won't be included in the model unless there's a cost defined for them.
node_state_cap
The maximum permitted value for a
node_state
variable.
Default value: nothing
Related Object Classes: node
The maximum permitted value for a node_state
variable.
node_state_coefficient
Coefficient of the specified node's state variable in the specified user constraint.
Default value: 0.0
Coefficient of the specified node's state variable in the specified user constraint.
node_state_min
The minimum permitted value for a
node_state
variable.
Default value: 0.0
Related Object Classes: node
The minimum permitted value for a node_state
variable.
number_of_connections
Denotes the number of 'sub connections' aggregated to form the modelled
connection
.
Default value: 1.0
Related Object Classes: connection
number_of_storages
Denotes the number of 'sub storages' aggregated to form the modelled
node
.
Default value: 1.0
Related Object Classes: node
number_of_units
Denotes the number of 'sub units' aggregated to form the modelled
unit
.
Default value: 1.0
Related Object Classes: unit
Denotes the number of 'sub units' aggregated to form the modelled unit
.
online_variable_type
A selector for how the
units_on
variable is represented within the model.
Default value: unit_online_variable_type_linear
Related Object Classes: unit
A selector for how the units_on
variable is represented within the model.
operating_points
- For
unit__from_node
: Operating points for piecewise-linearunit
efficiency approximations.- For
unit__to_node
: Decomposes the flow variable into a number of separate operating segment variables. Used to in conjunction withunit_incremental_heat_rate
and/oruser_constraint
s
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
- For
unit__from_node
: Operating points for piecewise-linearunit
efficiency approximations.- For
unit__to_node
: Decomposes the flow variable into a number of separate operating segment variables. Used to in conjunction withunit_incremental_heat_rate
and/oruser_constraint
s
ordered_unit_flow_op
Defines whether the segments of this unit flow are ordered as per the rank of their operating points.
Default value: false
Related Relationship Classes: unit__from_node and unit__to_node
Defines whether the segments of this unit flow are ordered as per the rank of their operating points.
outage_variable_type
Determines whether the outage variable is integer or continuous or none(no optimisation of maintenance outages).
Default value: unit_online_variable_type_none
Related Object Classes: unit
Determines whether the outage variable is integer or continuous or none(no optimisation of maintenance outages).
output_db_url
Database url for SpineOpt output.
Default value: nothing
Related Object Classes: report
Database url for SpineOpt output.
output_resolution
- For
output
: Temporal resolution of the output variables associated with thisoutput
.- For
stage__output__connection
,stage__output__node
,stage__output__unit
: A duration or array of durations indicating the points in time where the output of this stage should be fixed in the children. If not specified, then the output is fixed at the end of each child's roling window (EXPERIMENTAL).
Default value: nothing
Related Object Classes: output
Related Relationship Classes: stage__output__connection, stage__output__node and stage__output__unit
- For
output
: Temporal resolution of the output variables associated with thisoutput
.- For
stage__output__connection
,stage__output__node
,stage__output__unit
: A duration or array of durations indicating the points in time where the output of this stage should be fixed in the children. If not specified, then the output is fixed at the end of each child's roling window (EXPERIMENTAL).
overwrite_results_on_rolling
Whether or not results from further windows should overwrite results from previous ones.
Default value: true
Related Relationship Classes: report__output
Whether or not results from further windows should overwrite results from previous ones.
ramp_down_limit
Limit the maximum ramp-down rate of an online unit, given as a fraction of the unitcapacity. [rampdown_limit] = %/t, e.g. 0.2/h
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Limit the maximum ramp-down rate of an online unit, given as a fraction of the unitcapacity. [rampdown_limit] = %/t, e.g. 0.2/h
ramp_up_limit
Limit the maximum ramp-up rate of an online unit, given as a fraction of the unitcapacity. [rampup_limit] = %/t, e.g. 0.2/h
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Limit the maximum ramp-up rate of an online unit, given as a fraction of the unitcapacity. [rampup_limit] = %/t, e.g. 0.2/h
representative_periods_mapping
Map from date time to representative temporal block name
Default value: nothing
Related Object Classes: temporal_block
Map from date time to representative temporal block name
reserve_procurement_cost
Procurement cost for reserves
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Procurement cost for reserves
resolution
Temporal resolution of the
temporal_block
. Essentially, divides the period betweenblock_start
andblock_end
intoTimeSlices
with the inputresolution
.
Default value: Dict{String, Any}("data" => "1h", "type" => "duration")
Related Object Classes: temporal_block
Temporal resolution of the temporal_block
. Essentially, divides the period between block_start
and block_end
into TimeSlices
with the input resolution
.
right_hand_side
The right-hand side, constant term in a
user_constraint
. Can be time-dependent and used e.g. for complicated efficiency approximations.
Default value: 0.0
Related Object Classes: user_constraint
The right-hand side, constant term in a user_constraint
. Can be time-dependent and used e.g. for complicated efficiency approximations.
roll_forward
Defines how much the model moves ahead in time between solves in a rolling optimization. If null, everything is solved in as a single optimization.
Default value: nothing
Related Object Classes: model
Defines how much the model moves ahead in time between solves in a rolling optimization. If null, everything is solved in as a single optimization.
scheduled_outage_duration
Specifies the amount of time a unit must be out of service for maintenance as a single block over the course of the optimisation window
Default value: nothing
Related Object Classes: unit
shut_down_cost
Costs of shutting down a 'sub unit', e.g. EUR/shutdown.
Default value: nothing
Related Object Classes: unit
Costs of shutting down a 'sub unit', e.g. EUR/shutdown.
shut_down_limit
Maximum ramp-down during shutdowns
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Maximum ramp-down during shutdowns
stage_scenario
The scenario that this
stage
should run (EXPERIMENTAL).
Default value: nothing
Related Object Classes: stage
start_up_cost
Costs of starting up a 'sub unit', e.g. EUR/startup.
Default value: nothing
Related Object Classes: unit
Costs of starting up a 'sub unit', e.g. EUR/startup.
start_up_limit
Maximum ramp-up during startups
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Maximum ramp-up during startups
state_coeff
Represents the
commodity
content of anode_state
variable in respect to theunit_flow
andconnection_flow
variables. Essentially, acts as a coefficient on thenode_state
variable in thenode_injection
constraint.
Default value: 1.0
Related Object Classes: node
Represents the commodity
content of a node_state
variable in respect to the unit_flow
and connection_flow
variables. Essentially, acts as a coefficient on the node_state
variable in the node_injection
constraint.
stochastic_scenario_end
A
Duration
for when astochastic_scenario
ends and itschild_stochastic_scenarios
start. Values are interpreted relative to the start of the current solve, and if no value is given, thestochastic_scenario
is assumed to continue indefinitely.
Default value: nothing
Related Relationship Classes: stochastic_structure__stochastic_scenario
A Duration
for when a stochastic_scenario
ends and its child_stochastic_scenarios
start. Values are interpreted relative to the start of the current solve, and if no value is given, the stochastic_scenario
is assumed to continue indefinitely.
storage_decommissioning_cost
Costs associated with decommissioning a power plant. The costs will b discounted to the
discount_year
`at distribted equally over the decommissioning time.
Default value: nothing
Related Object Classes: node
storage_decommissioning_time
A storage's decommissioning time, i.e., the time between the moment at which a storage decommissioning decision is takien, and the moment at which decommissioning is complete.
Default value: Dict{String, Any}("data" => "0h", "type" => "duration")
Related Object Classes: node
storage_discount_rate_technology_specific
storage-specific discount rate used to calculate the storage's investment costs. If not specified, the model discount rate is used.
Default value: 0.0
Related Object Classes: node
storage_fom_cost
Fixed operation and maintenance costs of a
node
. Essentially, a cost coefficient on the number of installed units andnode_state_cap
parameters. E.g. EUR/MWh
Default value: nothing
Related Object Classes: node
storage_investment_cost
Determines the investment cost per unit state_cap over the investment life of a storage
Default value: nothing
Related Object Classes: node
Determines the investment cost per unit state_cap over the investment life of a storage
storage_investment_econ_lifetime
Economic lifetime for storage investment decisions.
Default value: nothing
Related Object Classes: node
storage_investment_lifetime_sense
A selector for
storage_lifetime
constraint sense.
Default value: >=
Related Object Classes: node
storage_investment_tech_lifetime
Maximum technical lifetime for storage investment decisions.
Default value: nothing
Related Object Classes: node
storage_investment_variable_type
Determines whether the storage investment variable is continuous (usually representing capacity) or integer (representing discrete units invested)
Default value: storage_investment_variable_type_integer
Uses Parameter Value Lists: storage_investment_variable_type_list
Related Object Classes: node
Determines whether the storage investment variable is continuous (usually representing capacity) or integer (representing discrete units invested)
storage_lead_time
A storage's lead time, i.e., the time between the moment at which a storage investment decision is takien, and the moment at which the storage investment becomes operational.
Default value: Dict{String, Any}("data" => "0h", "type" => "duration")
Related Object Classes: node
storages_invested_available_coefficient
Coefficient of the specified node's storages invested available variable in the specified user constraint.
Default value: 0.0
storages_invested_big_m_mga
bigmmga should be chosen as small as possible but sufficiently large. For unitsinvestedmga an appropriate bigmmga would be twice the candidate storages.
Default value: nothing
Related Object Classes: node
bigmmga should be chosen as small as possible but sufficiently large. For unitsinvestedmga an appropriate bigmmga would be twice the candidate storages.
storages_invested_coefficient
Coefficient of the specified node's storage investment variable in the specified user constraint.
Default value: 0.0
Coefficient of the specified node's storage investment variable in the specified user constraint.
storages_invested_mga
Defines whether a certain variable (here: storages_invested) will be considered in the maximal-differences of the mga objective
Default value: false
Related Object Classes: node
Defines whether a certain variable (here: storages_invested) will be considered in the maximal-differences of the mga objective
storages_invested_mga_weight
Used to scale mga variables. For weighted-sum mga method, the length of this weight given as an Array will determine the number of iterations.
Default value: 1
Related Object Classes: node
tax_in_unit_flow
Tax costs for incoming
unit_flows
on thisnode
. E.g. EUR/MWh.
Default value: nothing
Related Object Classes: node
Tax costs for incoming unit_flows
on this node
. E.g. EUR/MWh.
tax_net_unit_flow
Tax costs for net incoming and outgoing
unit_flows
on thisnode
. Incoming flows accrue positive net taxes, and outgoing flows accrue negative net taxes.
Default value: nothing
Related Object Classes: node
Tax costs for net incoming and outgoing unit_flows
on this node
. Incoming flows accrue positive net taxes, and outgoing flows accrue negative net taxes.
tax_out_unit_flow
Tax costs for outgoing
unit_flows
from thisnode
. E.g. EUR/MWh.
Default value: nothing
Related Object Classes: node
Tax costs for outgoing unit_flows
from this node
. E.g. EUR/MWh.
unit_availability_factor
Availability of the
unit
, acting as a multiplier on itsunit_capacity
. Typically between 0-1.
Default value: 1.0
Related Object Classes: unit
Availability of the unit
, acting as a multiplier on its unit_capacity
. Typically between 0-1.
unit_capacity
Maximum
unit_flow
capacity of a single 'sub_unit' of theunit
.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Maximum unit_flow
capacity of a single 'sub_unit' of the unit
.
unit_conv_cap_to_flow
Optional coefficient for
unit_capacity
unit conversions in the case theunit_capacity
value is incompatible with the desiredunit_flow
units.
Default value: 1.0
Related Relationship Classes: unit__from_node and unit__to_node
Optional coefficient for unit_capacity
unit conversions in the case the unit_capacity
value is incompatible with the desired unit_flow
units.
unit_decommissioning_cost
Costs associated with decommissioning a power plant. The costs will b discounted to the
discount_year
`at distribted equally over the decommissioning time.
Default value: nothing
Related Object Classes: unit
unit_decommissioning_time
A unit's decommissioning time, i.e., the time between the moment at which a unit decommissioning decision is takien, and the moment at which decommissioning is complete.
Default value: Dict{String, Any}("data" => "0h", "type" => "duration")
Related Object Classes: unit
unit_discount_rate_technology_specific
Unit-specific discount rate used to calculate the unit's investment costs. If not specified, the model discount rate is used.
Default value: 0.0
Related Object Classes: unit
unit_flow_coefficient
Coefficient of a
unit_flow
variable for a customuser_constraint
.
Default value: 0.0
Related Relationship Classes: unit__from_node__user_constraint and unit__to_node__user_constraint
Coefficient of a unit_flow
variable for a custom user_constraint
.
unit_flow_non_anticipativity_margin
Margin by which
unit_flow
variable can differ from the value in the previous window duringnon_anticipativity_time
.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
unit_flow_non_anticipativity_time
Period of time where the value of the
unit_flow
variable has to be fixed to the result from the previous window.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
unit_investment_cost
Investment cost per 'sub unit' built.
Default value: nothing
Related Object Classes: unit
Investment cost per 'sub unit' built.
unit_investment_econ_lifetime
Economic lifetime for unit investment decisions.
Default value: nothing
Related Object Classes: unit
unit_investment_lifetime_sense
A selector for
unit_lifetime
constraint sense.
Default value: >=
Related Object Classes: unit
unit_investment_tech_lifetime
Maximum technical lifetime for unit investment decisions.
Default value: nothing
Related Object Classes: unit
unit_investment_variable_type
Determines whether investment variable is integer or continuous.
Default value: unit_investment_variable_type_continuous
Uses Parameter Value Lists: unit_investment_variable_type_list
Related Object Classes: unit
Determines whether investment variable is integer or continuous.
unit_lead_time
A unit's lead time, i.e., the time between the moment at which a unit investment decision is takien, and the moment at which the unit investment becomes operational.
Default value: Dict{String, Any}("data" => "0h", "type" => "duration")
Related Object Classes: unit
unit_start_flow
Flow from node1 that is incurred when a unit is started up.
Default value: 0.0
Related Relationship Classes: unit__node__node
Flow from node1 that is incurred when a unit is started up.
units_invested_available_coefficient
Coefficient of the
units_invested_available
variable in the specifieduser_constraint
.
Default value: 0.0
units_invested_big_m_mga
bigmmga should be chosen as small as possible but sufficiently large. For unitsinvestedmga an appropriate bigmmga would be twice the candidate units.
Default value: nothing
Related Object Classes: unit
bigmmga should be chosen as small as possible but sufficiently large. For unitsinvestedmga an appropriate bigmmga would be twice the candidate units.
units_invested_coefficient
Coefficient of the
units_invested
variable in the specifieduser_constraint
.
Default value: 0.0
Coefficient of the units_invested
variable in the specified user_constraint
.
units_invested_mga
Defines whether a certain variable (here: units_invested) will be considered in the maximal-differences of the mga objective
Default value: false
Related Object Classes: unit
Defines whether a certain variable (here: units_invested) will be considered in the maximal-differences of the mga objective
units_invested_mga_weight
Used to scale mga variables. For weightd sum mga method, the length of this weight given as an Array will determine the number of iterations.
Default value: 1
Related Object Classes: unit
units_on_coefficient
Coefficient of a
units_on
variable for a customuser_constraint
.
Default value: 0.0
Coefficient of a units_on
variable for a custom user_constraint
.
units_on_cost
Objective function coefficient on
units_on
. An idling cost, for example
Default value: nothing
Related Object Classes: unit
Objective function coefficient on units_on
. An idling cost, for example
units_on_non_anticipativity_margin
Margin by which
units_on
variable can differ from the value in the previous window duringnon_anticipativity_time
.
Default value: nothing
Related Object Classes: unit
units_on_non_anticipativity_time
Period of time where the value of the
units_on
variable has to be fixed to the result from the previous window.
Default value: nothing
Related Object Classes: unit
Period of time where the value of the units_on
variable has to be fixed to the result from the previous window.
units_started_up_coefficient
Coefficient of a
units_started_up
variable for a customuser_constraint
.
Default value: 0.0
Coefficient of a units_started_up
variable for a custom user_constraint
.
units_unavailable
Represents the number of units out of service
Default value: 0
Related Object Classes: unit
Represents the number of units out of service
upward_reserve
Identifier for
node
s providing upward reserves
Default value: false
Related Object Classes: node
Identifier for node
s providing upward reserves
use_connection_intact_flow
Whether to use
connection_intact_flow
variables, to capture the impact of connection investments on network characteristics via line outage distribution factors (LODF).
Default value: true
Related Object Classes: model
use_economic_representation
If set to true, the investment models uses economic represenation, i.e., multi-year investments will be modeled considering discounts etc.
Default value: false
Related Object Classes: model
use_milestone_years
If set to true, the investment models uses milestone years. In other words, operational temporal blocks for one (milestone) year will be scaled up by the discounted duration to represent the entire investment period.
Default value: false
Related Object Classes: model
use_tight_compact_formulations
Whether to use tight and compact constraint formulations.
Default value: false
Related Object Classes: model
user_constraint_slack_penalty
A penalty for violating a user constraint.
Default value: nothing
Related Object Classes: user_constraint
version
Current version of the SpineOpt data structure. Modify it at your own risk (but please don't).
Default value: 15
Related Object Classes: settings
vom_cost
Variable operating costs of a
unit_flow
variable. E.g. EUR/MWh.
Default value: nothing
Related Relationship Classes: unit__from_node and unit__to_node
Variable operating costs of a unit_flow
variable. E.g. EUR/MWh.
weight
Weighting factor of the temporal block associated with the objective function
Default value: 1.0
Related Object Classes: temporal_block
Weighting factor of the temporal block associated with the objective function
weight_relative_to_parents
The weight of the
stochastic_scenario
in the objective function relative to its parents.
Default value: 1.0
Related Relationship Classes: stochastic_structure__stochastic_scenario
The weight of the stochastic_scenario
in the objective function relative to its parents.
window_duration
The duration of the window in case it differs from roll_forward
Default value: nothing
Related Object Classes: model
window_weight
The weight of the window in the rolling subproblem
Default value: 1
Related Object Classes: model
The weight of the window in the rolling subproblem
write_lodf_file
A boolean flag for whether the LODF values should be written to a results file.
Default value: false
Related Object Classes: model
A boolean flag for whether the LODF values should be written to a results file.
write_mps_file
A selector for writing an .mps file of the model.
Default value: nothing
Related Object Classes: model
A selector for writing an .mps file of the model.
write_ptdf_file
A boolean flag for whether the PTDF values should be written to a results file.
Default value: false
Related Object Classes: model
A boolean flag for whether the PTDF values should be written to a results file.