flixopt 2.0.0__py3-none-any.whl → 2.0.1__py3-none-any.whl

docs/release-notes/v2.0.1.md

@@ -0,0 +1,12 @@
+# Release v2.0.1
+
+**Release Date:** 2025-04-20
+
+## Improvements
+
+* Add logger warning if relative_minimum is used without on_off_parameters in Flow, as this prevents the flow_rate from switching "OFF"
+
+## Bug Fixes
+
+* Replace "|" with "__" in filenames when saving figures, as "|" can lead to issues on windows
+* Fixed a Bug that prevented the load factor from working without InvestmentParameters

flixopt/core.py

@@ -426,8 +426,64 @@ class TimeSeries:
             True if all values in this TimeSeries are greater than other
         """
         if isinstance(other, TimeSeries):
-            return (self.active_data > other.active_data).all().item()
-        return NotImplemented
+            return self.active_data > other.active_data
+        return self.active_data > other
+
+    def __ge__(self, other):
+        """
+        Compare if this TimeSeries is greater than or equal to another.
+
+        Args:
+            other: Another TimeSeries to compare with
+
+        Returns:
+            True if all values in this TimeSeries are greater than or equal to other
+        """
+        if isinstance(other, TimeSeries):
+            return self.active_data >= other.active_data
+        return self.active_data >= other
+
+    def __lt__(self, other):
+        """
+        Compare if this TimeSeries is less than another.
+
+        Args:
+            other: Another TimeSeries to compare with
+
+        Returns:
+            True if all values in this TimeSeries are less than other
+        """
+        if isinstance(other, TimeSeries):
+            return self.active_data < other.active_data
+        return self.active_data < other
+
+    def __le__(self, other):
+        """
+        Compare if this TimeSeries is less than or equal to another.
+
+        Args:
+            other: Another TimeSeries to compare with
+
+        Returns:
+            True if all values in this TimeSeries are less than or equal to other
+        """
+        if isinstance(other, TimeSeries):
+            return self.active_data <= other.active_data
+        return self.active_data <= other
+
+    def __eq__(self, other):
+        """
+        Compare if this TimeSeries is equal to another.
+
+        Args:
+            other: Another TimeSeries to compare with
+
+        Returns:
+            True if all values in this TimeSeries are equal to other
+        """
+        if isinstance(other, TimeSeries):
+            return self.active_data == other.active_data
+        return self.active_data == other
 
     def __array_ufunc__(self, ufunc, method, *inputs, **kwargs):
         """
@@ -843,7 +899,7 @@ class TimeSeriesCollection:
         if isinstance(item, str):
             return item in self.time_series_data
         elif isinstance(item, TimeSeries):
-            return item in self.time_series_data.values()
+            return any([item is ts for ts in self.time_series_data.values()])
         return False
 
     @property

flixopt/elements.py

@@ -115,7 +115,7 @@ class Bus(Element):
         )
 
     def _plausibility_checks(self) -> None:
-        if self.excess_penalty_per_flow_hour == 0:
+        if self.excess_penalty_per_flow_hour is not None and (self.excess_penalty_per_flow_hour == 0).all():
             logger.warning(f'In Bus {self.label}, the excess_penalty_per_flow_hour is 0. Use "None" or a value > 0.')
 
     @property
@@ -277,6 +277,13 @@ class Flow(Element):
                 f'if you want to allow flows to be switched on and off.'
             )
 
+        if (self.relative_minimum > 0).any() and self.on_off_parameters is None:
+            logger.warning(
+                f'Flow {self.label} has a relative_minimum of {self.relative_minimum.active_data} and no on_off_parameters. '
+                f'This prevents the flow_rate from switching off (flow_rate = 0). '
+                f'Consider using on_off_parameters to allow the flow to be switched on and off.'
+            )
+
     @property
     def label_full(self) -> str:
         return f'{self.component}({self.label})'
@@ -389,14 +396,13 @@ class FlowModel(ElementModel):
             flow_hours_per_size_max = self._model.hours_per_step.sum() * self.element.load_factor_max
             size = self.element.size if self._investment is None else self._investment.size
 
-            if self._investment is not None:
-                self.add(
-                    self._model.add_constraints(
-                        self.total_flow_hours <= size * flow_hours_per_size_max,
-                        name=f'{self.label_full}|{name_short}',
-                    ),
-                    name_short,
-                )
+            self.add(
+                self._model.add_constraints(
+                    self.total_flow_hours <= size * flow_hours_per_size_max,
+                    name=f'{self.label_full}|{name_short}',
+                ),
+                name_short,
+            )
 
         #  eq: size * sum(dt)* load_factor_min <= var_sumFlowHours
         if self.element.load_factor_min is not None:
@@ -404,14 +410,13 @@ class FlowModel(ElementModel):
             flow_hours_per_size_min = self._model.hours_per_step.sum() * self.element.load_factor_min
             size = self.element.size if self._investment is None else self._investment.size
 
-            if self._investment is not None:
-                self.add(
-                    self._model.add_constraints(
-                        self.total_flow_hours >= size * flow_hours_per_size_min,
-                        name=f'{self.label_full}|{name_short}',
-                    ),
-                    name_short,
-                )
+            self.add(
+                self._model.add_constraints(
+                    self.total_flow_hours >= size * flow_hours_per_size_min,
+                    name=f'{self.label_full}|{name_short}',
+                ),
+                name_short,
+            )
 
     @property
     def absolute_flow_rate_bounds(self) -> Tuple[NumericData, NumericData]:

flixopt/plotting.py

@@ -32,7 +32,9 @@ _portland_colors = [
     [217 / 255, 30 / 255, 30 / 255],  # Red
 ]
 
-plt.colormaps.register(mcolors.LinearSegmentedColormap.from_list('portland', _portland_colors))
+# Check if the colormap already exists before registering it
+if 'portland' not in plt.colormaps:
+    plt.colormaps.register(mcolors.LinearSegmentedColormap.from_list('portland', _portland_colors))
 
 
 ColorType = Union[str, List[str], Dict[str, str]]
@@ -1309,6 +1311,7 @@ def export_figure(
         TypeError: If the figure type is not supported.
     """
     filename = user_path or default_path
+    filename = filename.with_name(filename.name.replace('|', '__'))
     if filename.suffix == '':
         if default_filetype is None:
             raise ValueError('No default filetype provided')

{flixopt-2.0.0.dist-info → flixopt-2.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.0.0
+Version: 2.0.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>
@@ -120,7 +120,7 @@ We recommend installing FlixOpt with all dependencies, which enables additional
 
 ## 📚 Documentation
 
-The documentation is available at [https://flixopt.github.io/flixopt/](https://flixopt.github.io/flixopt/)
+The documentation is available at [https://flixopt.github.io/flixopt/latest/](https://flixopt.github.io/flixopt/latest/)
 
 ---
 

{flixopt-2.0.0.dist-info → flixopt-2.0.1.dist-info}/RECORD

@@ -12,6 +12,7 @@ docs/javascripts/mathjax.js,sha256=lkPNMk5XrDlyut9e5nGHgpN7gFl8OejpdJJ_gRW_14k,4
 docs/release-notes/_template.txt,sha256=j65E_FDxzimkcMXBrXyF6b2KPm0KAiQlGTxfhQHnN7c,496
 docs/release-notes/index.md,sha256=6VslOEfF3KQQCbntguRKz7uGWd_W_KIYotP8L1fzAeI,227
 docs/release-notes/v2.0.0.md,sha256=eauxvCH3O0B054vhbP0G8GdeF2LM__J57VAGYRFQzBg,4676
+docs/release-notes/v2.0.1.md,sha256=nQlfmOkOrOdZ0WVfNAX0BXYbJ2_i9q8SdDW9hOVDAAo,398
 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
@@ -28,20 +29,20 @@ flixopt/commons.py,sha256=ZNlUN1z-h9OGHPo-s-n5OLlJaoPZKVGcAdRyGKpMk4M,1256
 flixopt/components.py,sha256=FjsRI6REC25SPEkJmVn_etR8Yv1_Jup4NoD2QABGhMw,28679
 flixopt/config.py,sha256=Kt8QYk7hX5qHcQUtfgjM862C6SQr4K2lDvtk_LLER8Y,9085
 flixopt/config.yaml,sha256=imzAnnhcJhIfKNTTXFB5Td7Pvk5ARn5j720k-oGGRug,392
-flixopt/core.py,sha256=18VRtb2uc1Miw9On0IDpPcpLra9LFC99KQ-OQku7sPo,35936
+flixopt/core.py,sha256=JGsnw-VsNCQW2zDl0kMwhcPIzq08DJmcRQ02nLyDvIg,37633
 flixopt/effects.py,sha256=SGDIlo7VVIlMp-AeAyZx4CRJcUmpjFYqEq3lpBY8NEg,16662
-flixopt/elements.py,sha256=FGbnRzO6BL2SR2F3kf7cKg40703lWmk1nnHCU47io4U,24529
+flixopt/elements.py,sha256=xvpC2oOeiWE98LPYFIYkM_4qbgkPYYFzHLQAf-9GUKE,24872
 flixopt/features.py,sha256=JvtK3NyqPzb5ZpsIt8KoCoTXrWvNoiTwyc-Ds1pDNxs,43768
 flixopt/flow_system.py,sha256=4D2u2ucLig0GbC7ksCuWXuZPZdkgDzPafv-GhjAxRyk,17479
 flixopt/interface.py,sha256=EmMteo93XQRanCk4PwVRo7S-bteP-L5EtQqAe0GVIc0,11940
 flixopt/io.py,sha256=2QKdtu2-mkzSGBIqHtUcF9UaG32nq9qcIRxZghf1hLw,11284
 flixopt/linear_converters.py,sha256=ej5V_ML_3m1k9HbDnuey6pHEpQtguYkxBXHxWyE9sq0,10936
-flixopt/plotting.py,sha256=Ygxj6pkeIH0p2vyrEL0UnKyF2T7CS1OWuojH35By4mM,53942
+flixopt/plotting.py,sha256=wUwBSQxxwy1uui-mi2hgj6h__O6EvxCnocIbX0ewpMk,54111
 flixopt/results.py,sha256=gzf8M8Ig3uPjPSFRJeF--MrijbUyGkuF-SdVNRl7gnc,35159
 flixopt/solvers.py,sha256=k1bSoiXec3asWED70-erXkgtpn2C8KRBfSZj0FLviSM,2436
 flixopt/structure.py,sha256=beq463pSqySAVO6qc0ZBCZ_OnMrBy6dcmP4h6HcI3hI,26339
 flixopt/utils.py,sha256=f-_vFDvvG27-c_VMpzkv3lb79Yny4rvoSmemushbzhU,1687
-flixopt-2.0.0.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
+flixopt-2.0.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
@@ -50,7 +51,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.0.0.dist-info/METADATA,sha256=vZo92bhXIpCQxgKCvLUb8fJ7kfetM5m7bIQFp4Gzodo,7097
-flixopt-2.0.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-flixopt-2.0.0.dist-info/top_level.txt,sha256=U8aoMBkjiSFi7j4zgUOVgvgmyT5a1LnIArZI6TWdk-g,37
-flixopt-2.0.0.dist-info/RECORD,,
+flixopt-2.0.1.dist-info/METADATA,sha256=0QHc2zLIaJIvs5AQqLPi67P9SlLKv5Gd0EN6rVVKNt4,7111
+flixopt-2.0.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+flixopt-2.0.1.dist-info/top_level.txt,sha256=U8aoMBkjiSFi7j4zgUOVgvgmyT5a1LnIArZI6TWdk-g,37
+flixopt-2.0.1.dist-info/RECORD,,