Skip to content

Commit

Permalink
clean up template items
Browse files Browse the repository at this point in the history
  • Loading branch information
nnhjy committed Nov 15, 2024
1 parent d894790 commit 89fb7af
Showing 1 changed file with 1 addition and 82 deletions.
83 changes: 1 addition & 82 deletions templates/spineopt_template.json
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,6 @@
["commodity", "commodity_physics", "commodity_physics_none", "commodity_physics_list", "Defines if the `commodity` follows lodf or ptdf physics."],
["commodity", "commodity_physics_duration", null, null, "For how long the `commodity_physics` should apply relative to the start of the window."],
["commodity", "commodity_ptdf_threshold", 0.001, null, "The minimum absolute value of the power transfer distribution factor (PTDF) that is considered meaningful."],
["commodity", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["commodity", "mp_min_res_gen_to_demand_ratio", null, null, "Minimum ratio of renewable generation to demand for this commodity - used in the minimum renewable generation constraint within the Benders master problem"],
["commodity", "mp_min_res_gen_to_demand_ratio_slack_penalty", null, null, "Penalty for violating the minimum renewable generation to demand ratio."],
["connection", "benders_starting_connections_invested", null, null, "Fixes the number of connections invested during the first Benders iteration"],
Expand Down Expand Up @@ -176,7 +175,6 @@
["connection", "has_binary_gas_flow", false, "boolean_value_list", "This parameter needs to be set to `true` in order to represent bidirectional pressure drive gas transfer."],
["connection", "initial_connections_invested", null, null, "Setting a value fixes the connections_invested variable at the beginning"],
["connection", "initial_connections_invested_available", null, null, "Setting a value fixes the connections_invested_available variable at the beginning"],
["connection", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["connection", "number_of_connections", 1.0, null, "Denotes the number of 'sub connections' aggregated to form the modelled `connection`."],
["investment_group", "equal_investments", false, "boolean_value_list", "Whether all entities in the group must have the same investment decision."],
["investment_group", "maximum_capacity_invested_available", null, null, "Upper bound on the capacity invested available in the group at any point in time."],
Expand All @@ -191,7 +189,6 @@
["model", "duration_unit", "hour", "duration_unit_list", "Defines the base temporal unit of the `model`. Currently supported values are either an `hour` or a `minute`."],
["model", "discount_rate", 0, null, "The discount rate used for the discounting of future cashflows"],
["model", "discount_year", null, null, "The year to which all cashflows are discounted."],
["model", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["model", "max_gap", 0.05, null, "Specifies the maximum optimality gap for the model. Currently only used for the master problem within a decomposed structure"],
["model", "max_iterations", 10.0, null, "Specifies the maximum number of iterations for the model. Currently only used for the master problem within a decomposed structure"],
["model", "max_mga_iterations", null, null, "Define the number of mga iterations, i.e. how many alternative solutions will be generated."],
Expand Down Expand Up @@ -232,7 +229,6 @@
["node", "initial_node_voltage_angle", null, null, "Initializes the corresponding `node_voltage_angle` variable to the provided value"],
["node", "initial_storages_invested", null, null, "Used to initialze the value of the storages_invested variable"],
["node", "initial_storages_invested_available", null, null, "Used to initialze the value of the storages_invested_available variable"],
["node", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["node", "is_non_spinning", false, "boolean_value_list", "A boolean flag for whether a `node` is acting as a non-spinning reserve"],
["node", "is_reserve_node", false, "boolean_value_list", "A boolean flag for whether a `node` is acting as a `reserve_node`"],
["node", "max_node_pressure", null, null, "Maximum allowed gas pressure at `node`."],
Expand Down Expand Up @@ -266,19 +262,13 @@
["node", "tax_net_unit_flow", null, null, "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."],
["node", "tax_out_unit_flow", null, null, "Tax costs for outgoing `unit_flows` from this `node`. E.g. EUR/MWh."],
["node", "upward_reserve", false, null, "Identifier for `node`s providing upward reserves"],
["output", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["output", "output_resolution", null, null, "Temporal resolution of the output variables associated with this `output`."],
["output", "output_type",null,"output_type_list","Type of this `output`."],
["report", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["report", "output_db_url", null, null, "Database url for SpineOpt output."],
["settings", "version", 15, null, "Current version of the SpineOpt data structure. Modify it at your own risk (but please don't)."],
["stage", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["stage", "stage_scenario", null, null, "The scenario that this `stage` should run (EXPERIMENTAL)."],
["stochastic_scenario", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["stochastic_structure", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["temporal_block", "block_end", null, null, "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."],
["temporal_block", "block_start", null, null, "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."],
["temporal_block", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["temporal_block", "representative_periods_mapping", null, null, "Map from date time to representative temporal block name"],
["temporal_block", "resolution", {"type": "duration", "data": "1h"}, null, "Temporal resolution of the `temporal_block`. Essentially, divides the period between `block_start` and `block_end` into `TimeSlices` with the input `resolution`."],
["temporal_block", "weight", 1.0, null, "Weighting factor of the temporal block associated with the objective function"],
Expand All @@ -296,7 +286,6 @@
["unit", "initial_units_invested_available", null, null, "Initialize the value of the `units_invested_available` variable"],
["unit", "initial_units_on", null, null, "Initialize the value of the `units_on` variable."],
["unit", "initial_units_out_of_service", null, null, "Initialize the value of the `units_out_of_service` variable."],
["unit", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["unit", "is_renewable", false, "boolean_value_list", "Whether the unit is renewable - used in the minimum renewable generation constraint within the Benders master problem"],
["unit", "min_down_time", null, null, "Minimum downtime of a `unit` after it shuts down."],
["unit", "min_up_time", null, null, "Minimum uptime of a `unit` after it starts up."],
Expand All @@ -323,7 +312,6 @@
["unit", "units_on_non_anticipativity_time", null, null, "Period of time where the value of the `units_on` variable has to be fixed to the result from the previous window."],
["unit", "units_unavailable", 0, null, "Represents the number of units out of service"],
["user_constraint", "constraint_sense", "==", "constraint_sense_list", "A selector for the sense of the `user_constraint`."],
["user_constraint", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["user_constraint", "right_hand_side", 0.0, null, "The right-hand side, constant term in a `user_constraint`. Can be time-dependent and used e.g. for complicated efficiency approximations."],
["user_constraint", "user_constraint_slack_penalty", null, null, "A penalty for violating a user constraint."]
],
Expand Down Expand Up @@ -371,9 +359,7 @@
["connection__user_constraint", "connections_invested_available_coefficient", 0.0, null, "coefficient of `connections_invested_available` in the specific `user_constraint`"],
["connection__user_constraint", "connections_invested_coefficient", 0.0, null, "coefficient of `connections_invested` in the specific `user_constraint`"],
["node__node", "diff_coeff", 0.0, null, "Commodity diffusion coefficient between two `nodes`. Effectively, denotes the *diffusion power per unit of state* from the first `node` to the second."],
["node__stochastic_structure", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["node__temporal_block", "cyclic_condition", false, "boolean_value_list", "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."],
["node__temporal_block", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["node__user_constraint", "demand_coefficient", 0.0, null, "coefficient of the specified node's demand in the specified user constraint"],
["node__user_constraint", "node_state_coefficient", 0.0, null, "Coefficient of the specified node's state variable in the specified user constraint."],
["node__user_constraint", "storages_invested_available_coefficient", 0.0, null, "Coefficient of the specified node's storages invested available variable in the specified user constraint."],
Expand All @@ -393,7 +379,6 @@
["unit__from_node", "initial_nonspin_units_started_up", null, null, "Initialize the `nonspin_units_started_up` variable."],
["unit__from_node", "initial_unit_flow", null, null, "Initialize the `unit_flow` variable."],
["unit__from_node", "initial_unit_flow_op", null, null, "Initialize the `unit_flow_op` variable."],
["unit__from_node", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["unit__from_node", "max_total_cumulated_unit_flow_from_node", null, null, "Bound on the maximum cumulated flows of a unit group from a node group e.g max consumption of certain commodity."],
["unit__from_node", "min_total_cumulated_unit_flow_from_node", null, null, "Bound on the minimum cumulated flows of a unit group from a node group."],
["unit__from_node", "min_unit_flow", 0.0, null, "Set lower bound of the `unit_flow` variable."],
Expand Down Expand Up @@ -447,7 +432,6 @@
["unit__to_node", "initial_nonspin_units_started_up", null, null, "Initialize the `nonspin_units_started_up` variable."],
["unit__to_node", "initial_unit_flow", null, null, "Initialize the `unit_flow` variable."],
["unit__to_node", "initial_unit_flow_op", null, null, "Initialize the `unit_flow_op` variable."],
["unit__to_node", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["unit__to_node", "max_total_cumulated_unit_flow_to_node", null, null, "Bound on the maximum cumulated flows of a unit group to a node group, e.g. total GHG emissions."],
["unit__to_node", "min_total_cumulated_unit_flow_to_node", null, null, "Bound on the minimum cumulated flows of a unit group to a node group, e.g. total renewable production."],
["unit__to_node", "min_unit_flow", 0.0, null, "Set lower bound of the `unit_flow` variable."],
Expand All @@ -469,9 +453,7 @@
["unit__user_constraint", "units_invested_available_coefficient",0.0 , null, "Coefficient of the `units_invested_available` variable in the specified `user_constraint`."],
["unit__user_constraint", "units_invested_coefficient", 0.0, null, "Coefficient of the `units_invested` variable in the specified `user_constraint`."],
["unit__user_constraint", "units_on_coefficient", 0.0, null, "Coefficient of a `units_on` variable for a custom `user_constraint`."],
["unit__user_constraint", "units_started_up_coefficient", 0.0, null, "Coefficient of a `units_started_up` variable for a custom `user_constraint`."],
["units_on__stochastic_structure", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"],
["units_on__temporal_block", "is_active", true, "boolean_value_list", "If false, the object is excluded from the model if the tool filter object activity control is specified"]
["unit__user_constraint", "units_started_up_coefficient", 0.0, null, "Coefficient of a `units_started_up` variable for a custom `user_constraint`."]
],
"objects": [
["output", "binary_gas_connection_flow", null],
Expand Down Expand Up @@ -806,68 +788,5 @@
["output","bound_units_taken_out_of_service","output_type","variable_reduced_cost","Base"],
["output","bound_user_constraint_slack_neg","output_type","variable_reduced_cost","Base"],
["output","bound_user_constraint_slack_pos","output_type","variable_reduced_cost","Base"]
],
"tools": [
["object_activity_control", ""]
],
"features": [
["commodity", "is_active", "boolean_value_list", "boolean_value_list"],
["connection", "is_active", "boolean_value_list", "boolean_value_list"],
["model", "is_active", "boolean_value_list", "boolean_value_list"],
["node", "is_active", "boolean_value_list", "boolean_value_list"],
["node__stochastic_structure", "is_active", "boolean_value_list", "boolean_value_list"],
["node__temporal_block", "is_active", "boolean_value_list", "boolean_value_list"],
["output", "is_active", "boolean_value_list", "boolean_value_list"],
["report", "is_active", "boolean_value_list", "boolean_value_list"],
["stage", "is_active", "boolean_value_list", "boolean_value_list"],
["stochastic_scenario", "is_active", "boolean_value_list", "boolean_value_list"],
["stochastic_structure", "is_active", "boolean_value_list", "boolean_value_list"],
["temporal_block", "is_active", "boolean_value_list", "boolean_value_list"],
["unit", "is_active", "boolean_value_list", "boolean_value_list"],
["unit__from_node", "is_active", "boolean_value_list", "boolean_value_list"],
["unit__to_node", "is_active", "boolean_value_list", "boolean_value_list"],
["units_on__stochastic_structure", "is_active", "boolean_value_list", "boolean_value_list"],
["units_on__temporal_block", "is_active", "boolean_value_list", "boolean_value_list"],
["user_constraint", "is_active", "boolean_value_list", "boolean_value_list"]
],
"tool_features": [
["object_activity_control", "commodity", "is_active", false],
["object_activity_control", "connection", "is_active", false],
["object_activity_control", "model", "is_active", false],
["object_activity_control", "node", "is_active", false],
["object_activity_control", "node__stochastic_structure", "is_active", false],
["object_activity_control", "node__temporal_block", "is_active", false],
["object_activity_control", "output", "is_active", false],
["object_activity_control", "report", "is_active", false],
["object_activity_control", "stage", "is_active", false],
["object_activity_control", "stochastic_scenario", "is_active", false],
["object_activity_control", "stochastic_structure", "is_active", false],
["object_activity_control", "temporal_block", "is_active", false],
["object_activity_control", "unit", "is_active", false],
["object_activity_control", "unit__from_node", "is_active", false],
["object_activity_control", "unit__to_node", "is_active", false],
["object_activity_control", "units_on__stochastic_structure", "is_active", false],
["object_activity_control", "units_on__temporal_block", "is_active", false],
["object_activity_control", "user_constraint", "is_active", false]
],
"tool_feature_methods": [
["object_activity_control", "commodity", "is_active", true],
["object_activity_control", "connection", "is_active", true],
["object_activity_control", "model", "is_active", true],
["object_activity_control", "node", "is_active", true],
["object_activity_control", "node__stochastic_structure", "is_active", true],
["object_activity_control", "node__temporal_block", "is_active", true],
["object_activity_control", "output", "is_active", true],
["object_activity_control", "report", "is_active", true],
["object_activity_control", "stage", "is_active", true],
["object_activity_control", "stochastic_scenario", "is_active", true],
["object_activity_control", "stochastic_structure", "is_active", true],
["object_activity_control", "temporal_block", "is_active", true],
["object_activity_control", "unit", "is_active", true],
["object_activity_control", "unit__from_node", "is_active", true],
["object_activity_control", "unit__to_node", "is_active", true],
["object_activity_control", "units_on__stochastic_structure", "is_active", true],
["object_activity_control", "units_on__temporal_block", "is_active", true],
["object_activity_control", "user_constraint", "is_active", true]
]
}

0 comments on commit 89fb7af

Please sign in to comment.