flixopt 2.1.0__py3-none-any.whl → 2.1.1__py3-none-any.whl

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/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/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/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.dist-info → flixopt-2.1.1.dist-info}/METADATA

@@ -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.dist-info → flixopt-2.1.1.dist-info}/RECORD

@@ -14,6 +14,7 @@ docs/release-notes/index.md,sha256=6VslOEfF3KQQCbntguRKz7uGWd_W_KIYotP8L1fzAeI,2
 docs/release-notes/v2.0.0.md,sha256=eauxvCH3O0B054vhbP0G8GdeF2LM__J57VAGYRFQzBg,4676
 docs/release-notes/v2.0.1.md,sha256=_0oqZjogRv_x6DToWih78uhHu65-J1tat5A1asYxg50,398
 docs/release-notes/v2.1.0.md,sha256=uUnlzG61rI2PYce1SxIySYOnW55e_vnJYJN7l8lcB8A,1325
+docs/release-notes/v2.1.1.md,sha256=Y9cMiB6LeO6rZexJ9DD9BEl5mnrP8GLcf9nDtOLfIgc,217
 docs/user-guide/index.md,sha256=fxI_bMjz7czJ5aF_7D7l5rQVpc03WV2EAaBo9y3gB2g,7452
 docs/user-guide/Mathematical Notation/Bus.md,sha256=getjae_-rNTXbotO0euXwYCq2arBoayKsN9KeFb2u60,1612
 "docs/user-guide/Mathematical Notation/Effects, Penalty & Objective.md",sha256=RNqcJzNI1E-U01gaeoKu7m-7gjmtDWvjr2Y5JK9YgTA,5685
@@ -27,23 +28,23 @@ flixopt/__init__.py,sha256=F49OK5QLUnMGmsaKQ-G0dXsVuKr9Ow_pjM4KMSNZ918,614
 flixopt/aggregation.py,sha256=UaAYh34C4XhDgiSs4lm31XEMLr4YO5BzLKUAx4NQuyI,17002
 flixopt/calculation.py,sha256=1Hs9dc6eqdJoHT6Dd3NlwdRORFO2vKdKx38o95FPxJE,20016
 flixopt/commons.py,sha256=ZNlUN1z-h9OGHPo-s-n5OLlJaoPZKVGcAdRyGKpMk4M,1256
-flixopt/components.py,sha256=igiJdIcMA7o1QEjk0QDSCjNj0ADSXayd1xrJldA2ch4,28846
+flixopt/components.py,sha256=WXSljJNnEXyQLXMQQRwMfkugus3qTmIu9bPcknzvr1w,29121
 flixopt/config.py,sha256=Kt8QYk7hX5qHcQUtfgjM862C6SQr4K2lDvtk_LLER8Y,9085
 flixopt/config.yaml,sha256=imzAnnhcJhIfKNTTXFB5Td7Pvk5ARn5j720k-oGGRug,392
 flixopt/core.py,sha256=JGsnw-VsNCQW2zDl0kMwhcPIzq08DJmcRQ02nLyDvIg,37633
 flixopt/effects.py,sha256=SGDIlo7VVIlMp-AeAyZx4CRJcUmpjFYqEq3lpBY8NEg,16662
-flixopt/elements.py,sha256=d3gyFbt2dwqcsf7wJK2Ex9AOTt6_sToI8cCqSb2-1Xo,26678
+flixopt/elements.py,sha256=9P2uB3twwADf48Gx1xCluE-ZJCkzw0X7tYrtKEQOjk8,26932
 flixopt/features.py,sha256=sEtdj7BpaYS9a0XdhRUtdDFXWLdaGABRXdi5JOoLPb0,43919
 flixopt/flow_system.py,sha256=4D2u2ucLig0GbC7ksCuWXuZPZdkgDzPafv-GhjAxRyk,17479
 flixopt/interface.py,sha256=uXf6Z29OfHpIRsS1-oZZ6SSuy8FLe13FjtqzHPqzzQE,12088
 flixopt/io.py,sha256=2QKdtu2-mkzSGBIqHtUcF9UaG32nq9qcIRxZghf1hLw,11284
 flixopt/linear_converters.py,sha256=ej5V_ML_3m1k9HbDnuey6pHEpQtguYkxBXHxWyE9sq0,10936
 flixopt/plotting.py,sha256=wUwBSQxxwy1uui-mi2hgj6h__O6EvxCnocIbX0ewpMk,54111
-flixopt/results.py,sha256=gzf8M8Ig3uPjPSFRJeF--MrijbUyGkuF-SdVNRl7gnc,35159
+flixopt/results.py,sha256=GKSZmz0GCuJwspTC8Ot6MOKinvy_mhnDXCafb_f7uVY,35161
 flixopt/solvers.py,sha256=k1bSoiXec3asWED70-erXkgtpn2C8KRBfSZj0FLviSM,2436
 flixopt/structure.py,sha256=QS0IFBHzdEMKYTgd6uosudhoDD4X0JcdF7LlS-XRacs,26295
 flixopt/utils.py,sha256=f-_vFDvvG27-c_VMpzkv3lb79Yny4rvoSmemushbzhU,1687
-flixopt-2.1.0.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
+flixopt-2.1.1.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
 pics/architecture_flixOpt-pre2.0.0.png,sha256=9RWSA3vys588aadr2437zor-_-xBTQNQ0bAf8xGcu5g,70605
 pics/architecture_flixOpt.png,sha256=KjN1bJwESbkHmTW7UsJ7dZyiKZlTO7Dx20dg8KlR1HU,260219
 pics/flixOpt_plotting.jpg,sha256=zn7ZPAtXm5eRTxtOj86e4-PPhHpCar1jqGh7vMBgQGY,518862
@@ -52,7 +53,7 @@ pics/pics.pptx,sha256=ImWeGGvjtWJ6BGruipsnZYmWtHj5sWdbw1NSFePbkC8,683344
 scripts/gen_ref_pages.py,sha256=AYRtXyz78x5I_Hn0oRtGVbTxgLLj2QNyRX6vWRefPjc,1960
 site/release-notes/_template.txt,sha256=j65E_FDxzimkcMXBrXyF6b2KPm0KAiQlGTxfhQHnN7c,496
 tests/ressources/Zeitreihen2020.csv,sha256=kbsDTKZS0iUsNZAS7m3DohzZI_OHHWe44s3GwLvcTLw,1918412
-flixopt-2.1.0.dist-info/METADATA,sha256=db6pwA2-_i00-KWJgBYbQzFQPZPZsab2oohuXjn2GHM,7155
-flixopt-2.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-flixopt-2.1.0.dist-info/top_level.txt,sha256=U8aoMBkjiSFi7j4zgUOVgvgmyT5a1LnIArZI6TWdk-g,37
-flixopt-2.1.0.dist-info/RECORD,,
+flixopt-2.1.1.dist-info/METADATA,sha256=3n5YyOC_w1ySnHAFZwJtYGUGEfboRLbYYFXOSKiNxaU,7155
+flixopt-2.1.1.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+flixopt-2.1.1.dist-info/top_level.txt,sha256=U8aoMBkjiSFi7j4zgUOVgvgmyT5a1LnIArZI6TWdk-g,37
+flixopt-2.1.1.dist-info/RECORD,,

{flixopt-2.1.0.dist-info → flixopt-2.1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.3.1)
 Root-Is-Purelib: true
 Tag: py3-none-any