Fix trvial spottings (#1197)

* remove the obsolete graph_view_position parameter

* add missing `kwargs...` to function `unit_flow_ub`

* include missing unit-tests

* fix typo

* avoid compare explicitly defined candidate_units with zero

Author: nnhjy

src/data_structure/preprocess_data_structure.jl

@@ -908,8 +908,7 @@ function generate_unit_commitment_parameters()
                 indices(units_on_cost),
                 indices(units_on_non_anticipativity_time),
                 indices(fix_units_on),
-                (u for u in indices(candidate_units) if candidate_units(unit=u) > 0),
-                (x.unit for x in indices(units_on_coefficient) if units_on_coefficient(; x...) != 0),
+                (u for u in indices(candidate_units) if is_candidate(unit=u)),
                 (x.unit for x in indices(minimum_operating_point) if minimum_operating_point(; x...) != 0),
                 (x.unit for x in indices(ramp_up_limit)),
                 (x.unit for x in indices(ramp_down_limit)),

src/variables/variable_unit_flow.jl

@@ -51,7 +51,7 @@ end
 
 function unit_flow_ub(m; unit, node, direction, kwargs...)
     (
-        realize(unit_flow_capacity(m; unit=unit, node=node, direction=direction, _strict=false)) === nothing
+        realize(unit_flow_capacity(m; unit=unit, node=node, direction=direction, kwargs..., _strict=false)) === nothing
         || has_online_variable(unit=unit)
         || members(node) != [node]
     ) && return NaN

templates/spineopt_template.json

@@ -173,7 +173,6 @@
         ["connection", "connection_discount_rate_technology_specific", 0.0 , null, "connection-specific discount rate used to calculate the connection's investment costs. If not specified, the model discount rate is used."],
         ["connection", "fix_connections_invested", null, null, "Setting a value fixes the connections_invested variable accordingly"],
         ["connection", "fix_connections_invested_available", null, null, "Setting a value fixes the connections_invested_available variable accordingly"],
-        ["connection", "graph_view_position", null, null, "An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View."],
         ["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"],
@@ -226,7 +225,6 @@
         ["node", "fix_storages_invested_available", null, null, "Used to fix the value of the storages_invested_available variable"],
         ["node", "frac_state_loss", 0.0, null, "Self-discharge coefficient for `node_state` variables. Effectively, represents the *loss power per unit of state*."],
         ["node", "fractional_demand", 0.0, null, "The fraction of a `node` group's `demand` applied for the `node` in question."],
-        ["node", "graph_view_position", null, null, "An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View."],
         ["node", "has_pressure", false, "boolean_value_list", "A boolean flag for whether a `node` has a `node_pressure` variable."],
         ["node", "has_state", false, "boolean_value_list", "A boolean flag for whether a `node` has a `node_state` variable."],
         ["node", "has_voltage_angle", false, "boolean_value_list", "A boolean flag for whether a `node` has a `node_voltage_angle` variable."],
@@ -289,7 +287,6 @@
         ["unit", "fix_units_on", null, null, "Fix the value of the `units_on` variable."],
         ["unit", "fix_units_out_of_service", null, null, "Fix the value of the `units_out_of_service` variable."],
         ["unit", "fom_cost", null, null, "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"],
-        ["unit", "graph_view_position", null, null, "An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View."],
         ["unit", "initial_units_invested", null, null, "Initialize the value of the `units_invested` variable."],
         ["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."],
@@ -336,7 +333,6 @@
         ["connection__from_node", "fix_binary_gas_connection_flow", null, null, "Fix the value of the `connection_flow_binary` variable, and hence pre-determine the direction of flow in the connection."],
         ["connection__from_node", "fix_connection_flow", null, null, "Fix the value of the `connection_flow` variable."],
         ["connection__from_node", "fix_connection_intact_flow", null, null, "Fix the value of the `connection_intact_flow` variable."],
-        ["connection__from_node", "graph_view_position", null, null, "An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View."],
         ["connection__from_node", "initial_binary_gas_connection_flow", null, null, "Initialize the value of the `connection_flow_binary` variable, and hence pre-determine the direction of flow in the connection."],
         ["connection__from_node", "initial_connection_flow", null, null, "Initialize the value of the `connection_flow` variable."],
         ["connection__from_node", "initial_connection_intact_flow", null, null, "Initialize the value of the `connection_intact_flow` variable."],
@@ -360,7 +356,6 @@
         ["connection__to_node", "fix_binary_gas_connection_flow", null, null, "Fix the value of the `connection_flow_binary` variable, and hence pre-determine the direction of flow in the connection."],
         ["connection__to_node", "fix_connection_flow", null, null, "Fix the value of the `connection_flow` variable."],
         ["connection__to_node", "fix_connection_intact_flow", null, null, "Fix the value of the `connection_intact_flow` variable."],
-        ["connection__to_node", "graph_view_position", null, null, "An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View."],
         ["connection__to_node", "initial_binary_gas_connection_flow", null, null, "Initialize the value of the `connection_flow_binary` variable, and hence pre-determine the direction of flow in the connection."],
         ["connection__to_node", "initial_connection_flow", null, null, "Initialize the value of the `connection_flow` variable."],
         ["connection__to_node", "initial_connection_intact_flow", null, null, "Initialize the value of the `connection_intact_flow` variable."],
@@ -389,7 +384,6 @@
         ["unit__from_node", "fix_unit_flow", null, null, "Fix the `unit_flow` variable."],
         ["unit__from_node", "fix_unit_flow_op", null, null, "Fix the `unit_flow_op` variable."],
         ["unit__from_node", "fuel_cost", null, null, "Variable fuel costs than can be attributed to a `unit_flow`. E.g. EUR/MWh"],
-        ["unit__from_node", "graph_view_position", null, null, "An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View."],
         ["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."],
@@ -409,7 +403,6 @@
         ["unit__from_node", "unit_flow_non_anticipativity_margin", null, null, "Margin by which `unit_flow` variable can differ from the value in the previous window during `non_anticipativity_time`."],
         ["unit__from_node", "unit_flow_non_anticipativity_time", null, null, "Period of time where the value of the `unit_flow` variable has to be fixed to the result from the previous window."],
         ["unit__from_node", "vom_cost", null, null, "Variable operating costs of a `unit_flow` variable. E.g. EUR/MWh."],
-        ["unit__from_node__user_constraint", "graph_view_position", null, null, "An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View."],
         ["unit__from_node__user_constraint", "unit_flow_coefficient", 0.0, null, "Coefficient of a `unit_flow` variable for a custom `user_constraint`."],
         ["unit__node__node", "fix_ratio_in_in_unit_flow", null, null, "Fix the ratio between two `unit_flows` coming into the `unit` from the two `nodes`."],
         ["unit__node__node", "fix_ratio_in_out_unit_flow", null, null, "Fix the ratio between an incoming `unit_flow` from the first `node` and an outgoing `unit_flow` to the second `node`."],
@@ -441,7 +434,6 @@
         ["unit__to_node", "fix_unit_flow", null, null, "Fix the `unit_flow` variable."],
         ["unit__to_node", "fix_unit_flow_op", null, null, "Fix the `unit_flow_op` variable."],
         ["unit__to_node", "fuel_cost", null, null, "Variable fuel costs than can be attributed to a `unit_flow`. E.g. EUR/MWh"],
-        ["unit__to_node", "graph_view_position", null, null, "An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View."],
         ["unit__to_node", "initial_nonspin_units_shut_down", null, null, "Initialize the `nonspin_units_shut_down` variable."],
         ["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."],
@@ -462,7 +454,6 @@
         ["unit__to_node", "unit_flow_non_anticipativity_margin", null, null, "Margin by which `unit_flow` variable can differ from the value in the previous window during `non_anticipativity_time`."],
         ["unit__to_node", "unit_flow_non_anticipativity_time", null, null, "Period of time where the value of the `unit_flow` variable has to be fixed to the result from the previous window."],
         ["unit__to_node", "vom_cost", null, null, "Variable operating costs of a `unit_flow` variable. E.g. EUR/MWh."],
-        ["unit__to_node__user_constraint", "graph_view_position", null, null, "An optional setting for tweaking the position of the different elements when drawing them via Spine Toolbox Graph View."],
         ["unit__to_node__user_constraint", "unit_flow_coefficient", 0.0, null, "Coefficient of a `unit_flow` variable for a custom `user_constraint`."],
         ["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`."],

test/variables/variables.jl

@@ -290,7 +290,7 @@ function test_connection_history_parameters()
     end
 end
 
-function test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
+function _test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
     url_in = "sqlite://"
     test_data = Dict(
         :objects => [
@@ -330,7 +330,7 @@ function test_unit_flow_simple_bounds()
         m_end = m_start + Hour(2)
         fruf = 0.8
         cap_to_node = 200
-        url_in = test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
+        url_in = _test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
         obj_pvals = [
             ["unit", "unit_ab", "online_variable_type", "unit_online_variable_type_linear"],
         ]
@@ -365,7 +365,7 @@ function test_fix_ratio_out_in_unit_flow_simple()
         fruf = 0.8
         fuoc = 1.25
         usf = 2.4
-        url_in = test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
+        url_in = _test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
         rel_pvals = [
             ["unit__node__node", ["unit_ab", "node_b", "node_a"], "fix_ratio_out_in_unit_flow", fruf],
             ["unit__node__node", ["unit_ab", "node_b", "node_a"], "fix_units_on_coefficient_out_in", fuoc],
@@ -403,7 +403,7 @@ function test_fix_ratio_in_out_unit_flow_simple()
         fruf = 0.8
         fuoc = 1.25
         usf = 2.4
-        url_in = test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
+        url_in =_test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
         rel_pvals = [
             ["unit__node__node", ["unit_ab", "node_a", "node_b"], "fix_ratio_in_out_unit_flow", fruf],
             ["unit__node__node", ["unit_ab", "node_a", "node_b"], "fix_units_on_coefficient_in_out", fuoc],
@@ -440,7 +440,7 @@ function test_two_fix_ratio_out_in_unit_flow_simple()
         m_end = m_start + Hour(2)
         fruf = 0.8
         fruf2 = 0.6
-        url_in = test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
+        url_in =_test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
         objs = [["node", "node_b2"]]
         rels = [
             ["unit__to_node", ["unit_ab", "node_b2"]],
@@ -474,7 +474,7 @@ function test_two_fix_ratio_in_out_unit_flow_simple()
         m_end = m_start + Hour(2)
         fruf = 0.8
         fruf2 = 0.6
-        url_in = test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
+        url_in =_test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
         objs = [["node", "node_a2"]]
         rels = [
             ["unit__from_node", ["unit_ab", "node_a2"]],
@@ -508,7 +508,7 @@ function test_fix_ratio_out_in_and_in_out_unit_flow_simple()
         m_end = m_start + Hour(2)
         fruf = 0.8
         fruf2 = 0.9
-        url_in = test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
+        url_in =_test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
         objs = [["node", "node_b2"]]
         rels = [
             ["unit__to_node", ["unit_ab", "node_b2"]],
@@ -544,7 +544,7 @@ function test_two_fix_ratio_out_in_and_one_out_out_unit_flow_simple()
         fruf = 0.8
         fruf2 = 0.6
         froouf = 0.5
-        url_in = test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
+        url_in =_test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
         objs = [["node", "node_b2"], ["node", "node_b3"]]
         rels = [
             ["unit__to_node", ["unit_ab", "node_b2"]],
@@ -585,7 +585,7 @@ function test_fix_ratio_out_in_unit_flow_simple_rolling()
         stamps = [m_start, m_start + Hour(1)]
         fruf = unparse_db_value(TimeSeries(stamps, fruf_values))
         fuoc = unparse_db_value(TimeSeries(stamps, fuoc_values))
-        url_in = test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
+        url_in = _test_fix_ratio_unit_flow_simple_setup(m_start, m_end)
         obj_pvals = [("model", "instance", "roll_forward", unparse_db_value(Hour(1)))]
         rel_pvals = [
             ["unit__node__node", ["unit_ab", "node_b", "node_a"], "fix_ratio_out_in_unit_flow", fruf],
@@ -622,7 +622,7 @@ function test_fix_ratio_out_in_unit_flow_simple_rolling()
     end
 end
 
-function test_fix_ratio_connection_flow_simple_setup(m_start, m_end)
+function _test_fix_ratio_connection_flow_simple_setup(m_start, m_end)
     url_in = "sqlite://"
     test_data = Dict(
         :objects => [
@@ -660,7 +660,7 @@ function test_fix_ratio_out_in_connection_flow_simple()
         m_start = DateTime(2000, 1, 1, 0)
         m_end = m_start + Hour(2)
         frcf = 0.8
-        url_in = test_fix_ratio_connection_flow_simple_setup(m_start, m_end)
+        url_in = _test_fix_ratio_connection_flow_simple_setup(m_start, m_end)
         rel_pvals = [
             ["connection__node__node", ["conn_ab", "node_b", "node_a"], "fix_ratio_out_in_connection_flow", frcf],
         ]
@@ -689,7 +689,7 @@ function test_fix_ratio_out_in_connection_flow_simple_rolling()
         frcf_values = [0.8, 0.9]
         stamps = [m_start, m_start + Hour(1)]
         frcf = unparse_db_value(TimeSeries(stamps, frcf_values))
-        url_in = test_fix_ratio_connection_flow_simple_setup(m_start, m_end)
+        url_in = _test_fix_ratio_connection_flow_simple_setup(m_start, m_end)
         obj_pvals = [("model", "instance", "roll_forward", unparse_db_value(Hour(1)))]
         rel_pvals = [
             ["connection__node__node", ["conn_ab", "node_b", "node_a"], "fix_ratio_out_in_connection_flow", frcf],
@@ -734,6 +734,7 @@ end
     test_unit_online_variable_type_none()
     test_unit_history_parameters()
     test_connection_history_parameters()
+    test_unit_flow_simple_bounds()
     test_fix_ratio_out_in_unit_flow_simple()
     test_fix_ratio_in_out_unit_flow_simple()
     test_two_fix_ratio_out_in_unit_flow_simple()