flixopt 2.1.0__tar.gz → 2.1.1__tar.gz

{flixopt-2.1.0 → flixopt-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.0
+Version: 2.1.1
 Summary: Vector based energy and material flow optimization framework in Python.
 Author-email: "Chair of Building Energy Systems and Heat Supply, TU Dresden" <peter.stange@tu-dresden.de>, Felix Bumann <felixbumann387@gmail.com>, Felix Panitz <baumbude@googlemail.com>, Peter Stange <peter.stange@tu-dresden.de>
 Maintainer-email: Felix Bumann <felixbumann387@gmail.com>, Peter Stange <peter.stange@tu-dresden.de>

flixopt-2.1.1/docs/release-notes/v2.1.1.md

@@ -0,0 +1,11 @@
+# Release v2.1.1
+
+**Release Date:** 2025-05-08
+
+## Improvements
+
+* Improving docstring and tests
+
+## Bug Fixes
+
+* Fixing bug in the `_ElementResults.constraints` not returning the constraints but rather the variables

{flixopt-2.1.0 → flixopt-2.1.1}/flixopt/components.py

@@ -43,7 +43,10 @@ class LinearConverter(Component):
             label: The label of the Element. Used to identify it in the FlowSystem
             inputs: The input Flows
             outputs: The output Flows
-            on_off_parameters: Information about on and off states. See class OnOffParameters.
+            on_off_parameters: Information about on and off state of LinearConverter.
+                Component is On/Off, if all connected Flows are On/Off. This induces an On-Variable (binary) in all Flows!
+                If possible, use OnOffParameters in a single Flow instead to keep the number of binary variables low.
+                See class OnOffParameters.
             conversion_factors: linear relation between flows.
                 Either 'conversion_factors' or 'piecewise_conversion' can be used!
             piecewise_conversion: Define a piecewise linear relation between flow rates of different flows.

{flixopt-2.1.0 → flixopt-2.1.1}/flixopt/elements.py

@@ -47,8 +47,8 @@ class Component(Element):
             inputs: input flows.
             outputs: output flows.
             on_off_parameters: Information about on and off state of Component.
-                Component is On/Off, if all connected Flows are On/Off.
-                Induces On-Variable in all FLows!
+                Component is On/Off, if all connected Flows are On/Off. This induces an On-Variable (binary) in all Flows!
+                If possible, use OnOffParameters in a single Flow instead to keep the number of binary variables low.
                 See class OnOffParameters.
             prevent_simultaneous_flows: Define a Group of Flows. Only one them can be on at a time.
                 Induces On-Variable in all Flows! If possible, use OnOffParameters in a single Flow instead.
@@ -193,7 +193,8 @@ class Flow(Element):
                 (relative_minimum and relative_maximum are ignored)
                 used for fixed load or supply profiles, i.g. heat demand, wind-power, solarthermal
                 If the load-profile is just an upper limit, use relative_maximum instead.
-            previous_flow_rate: previous flow rate of the component.
+            previous_flow_rate: previous flow rate of the flow. Used to determine if and how long the
+                flow is already on / off. If None, the flow is considered to be off for one timestep.
             meta_data: used to store more information about the Element. Is not used internally, but saved in the results. Only use python native types.
         """
         super().__init__(label, meta_data=meta_data)

{flixopt-2.1.0 → flixopt-2.1.1}/flixopt/results.py

@@ -343,7 +343,7 @@ class _ElementResults:
         """
         if self._calculation_results.model is None:
             raise ValueError('The linopy model is not available.')
-        return self._calculation_results.model.constraints[self._variable_names]
+        return self._calculation_results.model.constraints[self._constraint_names]
 
     def filter_solution(self, variable_dims: Optional[Literal['scalar', 'time']] = None) -> xr.Dataset:
         """

{flixopt-2.1.0 → flixopt-2.1.1}/flixopt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.0
+Version: 2.1.1
 Summary: Vector based energy and material flow optimization framework in Python.
 Author-email: "Chair of Building Energy Systems and Heat Supply, TU Dresden" <peter.stange@tu-dresden.de>, Felix Bumann <felixbumann387@gmail.com>, Felix Panitz <baumbude@googlemail.com>, Peter Stange <peter.stange@tu-dresden.de>
 Maintainer-email: Felix Bumann <felixbumann387@gmail.com>, Peter Stange <peter.stange@tu-dresden.de>

{flixopt-2.1.0 → flixopt-2.1.1}/flixopt.egg-info/SOURCES.txt

@@ -25,6 +25,7 @@ docs/release-notes/index.md
 docs/release-notes/v2.0.0.md
 docs/release-notes/v2.0.1.md
 docs/release-notes/v2.1.0.md
+docs/release-notes/v2.1.1.md
 docs/user-guide/index.md
 docs/user-guide/Mathematical Notation/Bus.md
 docs/user-guide/Mathematical Notation/Effects, Penalty & Objective.md

{flixopt-2.1.0 → flixopt-2.1.1}/tests/conftest.py

@@ -432,7 +432,7 @@ def timesteps_linopy(request):
 @pytest.fixture
 def basic_flow_system_linopy(timesteps_linopy) -> fx.FlowSystem:
     """Create basic elements for component testing"""
-    flow_system = fx.FlowSystem(pd.date_range('2020-01-01', periods=10, freq='h', name='time'))
+    flow_system = fx.FlowSystem(timesteps_linopy)
     thermal_load = np.array([np.random.random() for _ in range(10)]) * 180
     p_el = (np.array([np.random.random() for _ in range(10)]) + 0.5) / 1.5 * 50
 

{flixopt-2.1.0 → flixopt-2.1.1}/tests/test_flow.py

@@ -616,6 +616,73 @@ class TestFlowOnModel:
             >= (model.variables['Sink(Wärme)|on'].isel(time=slice(None, -1)) - model.variables['Sink(Wärme)|on'].isel(time=slice(1, None))) * 2
         )
 
+    def test_consecutive_on_hours_previous(self, basic_flow_system_linopy):
+        """Test flow with minimum and maximum consecutive on hours."""
+        flow_system = basic_flow_system_linopy
+        timesteps = flow_system.time_series_collection.timesteps
+
+        flow = fx.Flow(
+            'Wärme',
+            bus='Fernwärme',
+            size=100,
+            on_off_parameters=fx.OnOffParameters(
+                consecutive_on_hours_min=2,  # Must run for at least 2 hours when turned on
+                consecutive_on_hours_max=8,  # Can't run more than 8 consecutive hours
+            ),
+            previous_flow_rate=np.array([10, 20, 30, 0, 20, 20, 30]) # Previously on for 3 steps
+        )
+
+        flow_system.add_elements( fx.Sink('Sink', sink=flow))
+        model = create_linopy_model(flow_system)
+
+        assert {'Sink(Wärme)|ConsecutiveOn|hours', 'Sink(Wärme)|on'}.issubset(set(flow.model.variables))
+
+        assert {'Sink(Wärme)|ConsecutiveOn|con1',
+         'Sink(Wärme)|ConsecutiveOn|con2a',
+         'Sink(Wärme)|ConsecutiveOn|con2b',
+         'Sink(Wärme)|ConsecutiveOn|initial',
+         'Sink(Wärme)|ConsecutiveOn|minimum',
+        }.issubset(set(flow.model.constraints))
+
+        assert_var_equal(
+            model.variables['Sink(Wärme)|ConsecutiveOn|hours'],
+            model.add_variables(lower=0, upper=8, coords=(timesteps,))
+        )
+
+        mega = model.hours_per_step.sum('time') + model.hours_per_step.isel(time=0) * 3
+
+        assert_conequal(
+            model.constraints['Sink(Wärme)|ConsecutiveOn|con1'],
+            model.variables['Sink(Wärme)|ConsecutiveOn|hours'] <= model.variables['Sink(Wärme)|on'] * mega
+        )
+
+        assert_conequal(
+            model.constraints['Sink(Wärme)|ConsecutiveOn|con2a'],
+            model.variables['Sink(Wärme)|ConsecutiveOn|hours'].isel(time=slice(1, None))
+            <= model.variables['Sink(Wärme)|ConsecutiveOn|hours'].isel(time=slice(None, -1)) + model.hours_per_step.isel(time=slice(None, -1))
+        )
+
+        # eq: duration(t) >= duration(t - 1) + dt(t) + (On(t) - 1) * BIG
+        assert_conequal(
+            model.constraints['Sink(Wärme)|ConsecutiveOn|con2b'],
+            model.variables['Sink(Wärme)|ConsecutiveOn|hours'].isel(time=slice(1, None))
+            >= model.variables['Sink(Wärme)|ConsecutiveOn|hours'].isel(time=slice(None, -1))
+            + model.hours_per_step.isel(time=slice(None, -1))
+            + (model.variables['Sink(Wärme)|on'].isel(time=slice(1, None)) - 1) * mega
+        )
+
+        assert_conequal(
+            model.constraints['Sink(Wärme)|ConsecutiveOn|initial'],
+            model.variables['Sink(Wärme)|ConsecutiveOn|hours'].isel(time=0)
+            == model.variables['Sink(Wärme)|on'].isel(time=0) * (model.hours_per_step.isel(time=0) * (1 + 3)),
+        )
+
+        assert_conequal(
+            model.constraints['Sink(Wärme)|ConsecutiveOn|minimum'],
+            model.variables['Sink(Wärme)|ConsecutiveOn|hours']
+            >= (model.variables['Sink(Wärme)|on'].isel(time=slice(None, -1)) - model.variables['Sink(Wärme)|on'].isel(time=slice(1, None))) * 2
+        )
+
     def test_consecutive_off_hours(self, basic_flow_system_linopy):
         """Test flow with minimum and maximum consecutive off hours."""
         flow_system = basic_flow_system_linopy
@@ -649,7 +716,75 @@ class TestFlowOnModel:
             model.add_variables(lower=0, upper=12, coords=(timesteps,))
         )
 
-        mega = model.hours_per_step.sum('time') + 1  # previously off for 1h
+        mega = model.hours_per_step.sum('time') + model.hours_per_step.isel(time=0) * 1  # previously off for 1h
+
+        assert_conequal(
+            model.constraints['Sink(Wärme)|ConsecutiveOff|con1'],
+            model.variables['Sink(Wärme)|ConsecutiveOff|hours'] <= model.variables['Sink(Wärme)|off'] * mega
+        )
+
+        assert_conequal(
+            model.constraints['Sink(Wärme)|ConsecutiveOff|con2a'],
+            model.variables['Sink(Wärme)|ConsecutiveOff|hours'].isel(time=slice(1, None))
+            <= model.variables['Sink(Wärme)|ConsecutiveOff|hours'].isel(time=slice(None, -1)) + model.hours_per_step.isel(time=slice(None, -1))
+        )
+
+        # eq: duration(t) >= duration(t - 1) + dt(t) + (On(t) - 1) * BIG
+        assert_conequal(
+            model.constraints['Sink(Wärme)|ConsecutiveOff|con2b'],
+            model.variables['Sink(Wärme)|ConsecutiveOff|hours'].isel(time=slice(1, None))
+            >= model.variables['Sink(Wärme)|ConsecutiveOff|hours'].isel(time=slice(None, -1))
+            + model.hours_per_step.isel(time=slice(None, -1))
+            + (model.variables['Sink(Wärme)|off'].isel(time=slice(1, None)) - 1) * mega
+        )
+
+        assert_conequal(
+            model.constraints['Sink(Wärme)|ConsecutiveOff|initial'],
+            model.variables['Sink(Wärme)|ConsecutiveOff|hours'].isel(time=0)
+            == model.variables['Sink(Wärme)|off'].isel(time=0) * (model.hours_per_step.isel(time=0) * (1 + 1)),
+        )
+
+        assert_conequal(
+            model.constraints['Sink(Wärme)|ConsecutiveOff|minimum'],
+            model.variables['Sink(Wärme)|ConsecutiveOff|hours']
+            >= (model.variables['Sink(Wärme)|off'].isel(time=slice(None, -1)) - model.variables['Sink(Wärme)|off'].isel(time=slice(1, None))) * 4
+        )
+
+    def test_consecutive_off_hours_previous(self, basic_flow_system_linopy):
+        """Test flow with minimum and maximum consecutive off hours."""
+        flow_system = basic_flow_system_linopy
+        timesteps = flow_system.time_series_collection.timesteps
+
+        flow = fx.Flow(
+            'Wärme',
+            bus='Fernwärme',
+            size=100,
+            on_off_parameters=fx.OnOffParameters(
+                consecutive_off_hours_min=4,  # Must stay off for at least 4 hours when shut down
+                consecutive_off_hours_max=12,  # Can't be off for more than 12 consecutive hours
+            ),
+            previous_flow_rate=np.array([10, 20, 30, 0, 20, 0, 0]) # Previously off for 2 steps
+        )
+
+        flow_system.add_elements( fx.Sink('Sink', sink=flow))
+        model = create_linopy_model(flow_system)
+
+        assert {'Sink(Wärme)|ConsecutiveOff|hours', 'Sink(Wärme)|off'}.issubset(set(flow.model.variables))
+
+        assert {
+            'Sink(Wärme)|ConsecutiveOff|con1',
+         'Sink(Wärme)|ConsecutiveOff|con2a',
+         'Sink(Wärme)|ConsecutiveOff|con2b',
+         'Sink(Wärme)|ConsecutiveOff|initial',
+         'Sink(Wärme)|ConsecutiveOff|minimum'
+        }.issubset(set(flow.model.constraints))
+
+        assert_var_equal(
+            model.variables['Sink(Wärme)|ConsecutiveOff|hours'],
+            model.add_variables(lower=0, upper=12, coords=(timesteps,))
+        )
+
+        mega = model.hours_per_step.sum('time') + model.hours_per_step.isel(time=0) * 2
 
         assert_conequal(
             model.constraints['Sink(Wärme)|ConsecutiveOff|con1'],
@@ -674,7 +809,7 @@ class TestFlowOnModel:
         assert_conequal(
             model.constraints['Sink(Wärme)|ConsecutiveOff|initial'],
             model.variables['Sink(Wärme)|ConsecutiveOff|hours'].isel(time=0)
-            == model.variables['Sink(Wärme)|off'].isel(time=0) * (model.hours_per_step.isel(time=0)+1),
+            == model.variables['Sink(Wärme)|off'].isel(time=0) * (model.hours_per_step.isel(time=0) * (1+2)),
         )
 
         assert_conequal(

{flixopt-2.1.0 → flixopt-2.1.1}/tests/test_storage.py

@@ -78,7 +78,7 @@ class TestStorageModel:
         assert_conequal(
             model.constraints['TestStorage|charge_state'],
             charge_state.isel(time=slice(1, None))
-            == charge_state.isel(time=slice(None, -1)) * model.hours_per_step
+            == charge_state.isel(time=slice(None, -1))
             + model.variables['TestStorage(Q_th_in)|flow_rate'] * model.hours_per_step
             - model.variables['TestStorage(Q_th_out)|flow_rate'] *  model.hours_per_step,
         )