flixopt 2.1.1__py3-none-any.whl → 2.2.0b0__py3-none-any.whl

flixopt/structure.py

@@ -19,7 +19,7 @@ from rich.console import Console
 from rich.pretty import Pretty
 
 from .config import CONFIG
-from .core import NumericData, Scalar, TimeSeries, TimeSeriesCollection, TimeSeriesData
+from .core import Scalar, TimeSeries, TimeSeriesCollection, TimeSeriesData, TimestepData
 
 if TYPE_CHECKING:  # for type checking and preventing circular imports
     from .effects import EffectCollectionModel
@@ -58,6 +58,7 @@ class SystemModel(linopy.Model):
         self.flow_system = flow_system
         self.time_series_collection = flow_system.time_series_collection
         self.effects: Optional[EffectCollectionModel] = None
+        self.scenario_weights = self._calculate_scenario_weights(flow_system.scenario_weights)
 
     def do_modeling(self):
         self.effects = self.flow_system.effects.create_model(self)
@@ -69,6 +70,24 @@ class SystemModel(linopy.Model):
         for bus_model in bus_models:  # Buses after Components, because FlowModels are created in ComponentModels
             bus_model.do_modeling()
 
+    def _calculate_scenario_weights(self, weights: Optional[TimeSeries] = None) -> xr.DataArray:
+        """Calculates the weights of the scenarios. If None, all scenarios have the same weight. All weights are normalized to 1.
+        If no scenarios are present, s single weight of 1 is returned.
+        """
+        if weights is not None and not isinstance(weights, TimeSeries):
+            raise TypeError(f'Weights must be a TimeSeries or None, got {type(weights)}')
+        if self.time_series_collection.scenarios is None:
+            return xr.DataArray(1)
+        if weights is None:
+            weights = xr.DataArray(
+                np.ones(len(self.time_series_collection.scenarios)),
+                coords={'scenario': self.time_series_collection.scenarios}
+            )
+        elif isinstance(weights, TimeSeries):
+            weights = weights.selected_data
+
+        return weights / weights.sum()
+
     @property
     def solution(self):
         solution = super().solution
@@ -87,6 +106,10 @@ class SystemModel(linopy.Model):
                 effect.label_full: effect.model.results_structure()
                 for effect in sorted(self.flow_system.effects, key=lambda effect: effect.label_full.upper())
             },
+            'Flows': {
+                flow.label_full: flow.model.results_structure()
+                for flow in sorted(self.flow_system.flows.values(), key=lambda flow: flow.label_full.upper())
+            },
         }
         return solution.reindex(time=self.time_series_collection.timesteps_extra)
 
@@ -98,13 +121,40 @@ class SystemModel(linopy.Model):
     def hours_of_previous_timesteps(self):
         return self.time_series_collection.hours_of_previous_timesteps
 
-    @property
-    def coords(self) -> Tuple[pd.DatetimeIndex]:
-        return (self.time_series_collection.timesteps,)
+    def get_coords(
+        self, scenario_dim=True, time_dim=True, extra_timestep=False
+    ) -> Optional[Union[Tuple[pd.Index], Tuple[pd.Index, pd.Index]]]:
+        """
+        Returns the coordinates of the model
 
-    @property
-    def coords_extra(self) -> Tuple[pd.DatetimeIndex]:
-        return (self.time_series_collection.timesteps_extra,)
+        Args:
+            scenario_dim: If True, the scenario dimension is included in the coordinates
+            time_dim: If True, the time dimension is included in the coordinates
+            extra_timestep: If True, the extra timesteps are used instead of the regular timesteps
+
+        Returns:
+            The coordinates of the model. Might also be None if no scenarios are present and time_dim is False
+        """
+        if not scenario_dim and not time_dim:
+            return None
+        scenarios = self.time_series_collection.scenarios
+        timesteps = (
+            self.time_series_collection.timesteps if not extra_timestep else self.time_series_collection.timesteps_extra
+        )
+
+        if scenario_dim and time_dim:
+            if scenarios is None:
+                return (timesteps,)
+            return timesteps, scenarios
+
+        if scenario_dim and not time_dim:
+            if scenarios is None:
+                return None
+            return (scenarios,)
+        if time_dim and not scenario_dim:
+            return (timesteps,)
+
+        raise ValueError(f'Cannot get coordinates with both {scenario_dim=} and {time_dim=}')
 
 
 class Interface:
@@ -449,8 +499,7 @@ class ElementModel(Model):
 
     def results_structure(self):
         return {
-            'label': self.label,
-            'label_full': self.label_full,
+            'label': self.label_full,
             'variables': list(self.variables),
             'constraints': list(self.constraints),
         }
@@ -534,9 +583,12 @@ def copy_and_convert_datatypes(data: Any, use_numpy: bool = True, use_element_la
             return copy_and_convert_datatypes(data.tolist(), use_numpy, use_element_label)
 
     elif isinstance(data, TimeSeries):
-        return copy_and_convert_datatypes(data.active_data, use_numpy, use_element_label)
+        return copy_and_convert_datatypes(data.selected_data, use_numpy, use_element_label)
     elif isinstance(data, TimeSeriesData):
         return copy_and_convert_datatypes(data.data, use_numpy, use_element_label)
+    elif isinstance(data, (pd.Series, pd.DataFrame)):
+        #TODO: This can be improved
+        return copy_and_convert_datatypes(data.values, use_numpy, use_element_label)
 
     elif isinstance(data, Interface):
         if use_element_label and isinstance(data, Element):
@@ -584,6 +636,8 @@ def get_compact_representation(data: Any, array_threshold: int = 50, decimals: i
 
         def normalized_center_of_mass(array: Any) -> float:
             # position in array (0 bis 1 normiert)
+            if array.ndim >= 2:  # No good way to calculate center of mass for 2D arrays
+                return np.nan
             positions = np.linspace(0, 1, len(array))  # weights w_i
             # mass center
             if np.sum(array) == 0:

flixopt/utils.py

@@ -11,15 +11,6 @@ import xarray as xr
 logger = logging.getLogger('flixopt')
 
 
-def is_number(number_alias: Union[int, float, str]):
-    """Returns True is string is a number."""
-    try:
-        float(number_alias)
-        return True
-    except ValueError:
-        return False
-
-
 def round_floats(obj, decimals=2):
     if isinstance(obj, dict):
         return {k: round_floats(v, decimals) for k, v in obj.items()}
@@ -27,6 +18,12 @@ def round_floats(obj, decimals=2):
         return [round_floats(v, decimals) for v in obj]
     elif isinstance(obj, float):
         return round(obj, decimals)
+    elif isinstance(obj, int):
+        return obj
+    elif isinstance(obj, np.ndarray):
+        return np.round(obj, decimals).tolist()
+    elif isinstance(obj, xr.DataArray):
+        return obj.round(decimals).values.tolist()
     return obj
 
 

{flixopt-2.1.1.dist-info → flixopt-2.2.0b0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.1
+Version: 2.2.0b0
 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.dist-info → flixopt-2.2.0b0.dist-info}/RECORD

@@ -14,11 +14,12 @@ 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/release-notes/v2.2.0.md,sha256=MvIdMzmDA4d-h6UFGPU0dEqWl5PwJC8qPE5NvxxlCJ8,2022
 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
 docs/user-guide/Mathematical Notation/Flow.md,sha256=MaBsj5j5dfa1qnUYCKbrNqE2yDZSeJ60_hoq95uhWyg,1094
+docs/user-guide/Mathematical Notation/Investment.md,sha256=NUs8b2Hx1ZNFxSuGqFHx5epk2-qqUQ7I_EG17X5EVPQ,4181
 docs/user-guide/Mathematical Notation/LinearConverter.md,sha256=XNkRgE8-MVNplKT3n1MyIrtgTRkbbwp7-qfapZw2kfU,1322
 docs/user-guide/Mathematical Notation/Piecewise.md,sha256=ia4rkKYrEidWIBsgLMAkt10JH-idmaavJTAMzAlMH_8,1994
 docs/user-guide/Mathematical Notation/Storage.md,sha256=PeNzk77i-81VX8I5r3zen3karF5v3wal9x2_ReUuyho,2199
@@ -26,34 +27,33 @@ docs/user-guide/Mathematical Notation/index.md,sha256=gkglBsoARhgvppXN9PgdJF33sC
 docs/user-guide/Mathematical Notation/others.md,sha256=wOUsfspAoSNTMlTNipeQ8ohoVVX2S-eI3dmlzqqrbR8,47
 flixopt/__init__.py,sha256=F49OK5QLUnMGmsaKQ-G0dXsVuKr9Ow_pjM4KMSNZ918,614
 flixopt/aggregation.py,sha256=UaAYh34C4XhDgiSs4lm31XEMLr4YO5BzLKUAx4NQuyI,17002
-flixopt/calculation.py,sha256=1Hs9dc6eqdJoHT6Dd3NlwdRORFO2vKdKx38o95FPxJE,20016
+flixopt/calculation.py,sha256=u8O11pU-PaY57MybTG63MSa3Rm-fBUTn9OvytZI-3aY,21348
 flixopt/commons.py,sha256=ZNlUN1z-h9OGHPo-s-n5OLlJaoPZKVGcAdRyGKpMk4M,1256
-flixopt/components.py,sha256=WXSljJNnEXyQLXMQQRwMfkugus3qTmIu9bPcknzvr1w,29121
+flixopt/components.py,sha256=lu76ZklsG2fS7xOYYEoutFgj72DLCfqwFpRcBzBZfzs,31377
 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=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=GKSZmz0GCuJwspTC8Ot6MOKinvy_mhnDXCafb_f7uVY,35161
+flixopt/core.py,sha256=IS9IN-WrHTn2U8cbrhkFw3TqLblKNDNzMXZVHatZuks,56359
+flixopt/effects.py,sha256=TELgTCuzu8wYWEmRpQY5r_hBxQIk0pr_hm2Rn-hTpAA,24575
+flixopt/elements.py,sha256=glEvUpHHjZZVUvafRAybNXiqJNlnhWWZ3edgoSfpslc,28630
+flixopt/features.py,sha256=zcLzunoi-LAMUuG6OjJ_4j95zA3b-tptPkgvSN29Als,46725
+flixopt/flow_system.py,sha256=mLEZ0blw5dNLRR8IDBjkQWob_uKeXD-aADQSUy9Vtjw,21090
+flixopt/interface.py,sha256=HKYPO0J3FoEyxa6Wr-BIkEHsGpNwDobXq3zzy1CqoXo,16148
+flixopt/io.py,sha256=S4Ia3lcKykXUEW8qn8pu8JOhqejp001bolCGXO7vleM,12029
+flixopt/linear_converters.py,sha256=xIp0mxw2v5mVzT9ZWYUeJUbh-jYgFiRmku88vOXhtWA,10934
+flixopt/plotting.py,sha256=68O330RnLBNlOcZ-P6WK1YBvRwSoG6x9ELrBcDBOrNA,54879
+flixopt/results.py,sha256=1tD94E2YfOIA8nX5bXR3vnAnBwokO9O0Mlk5zuESF5Q,69189
 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.1.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
+flixopt/structure.py,sha256=Ufgu8cf1pO4UIww4Lht7I1Iabm6JUxWM-N7gGdNjIdM,28905
+flixopt/utils.py,sha256=xuksGh1dXj8HNhkcjMCVIxlpAA_QSWXePFmkbJYvQwM,1712
+flixopt-2.2.0b0.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
 pics/flixopt-icon.svg,sha256=_1a6bk2pDOVEy233LC1nM6jZ35NdzD8Hd3UqGxW1Xpg,135341
 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.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.2.0b0.dist-info/METADATA,sha256=0O2Ass8s06oafXxxkjUbHtWdfmeUUjCmUzjzcBE3uZI,7157
+flixopt-2.2.0b0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+flixopt-2.2.0b0.dist-info/top_level.txt,sha256=DEuo4R1z7GmEp5R3pjbQEJbaPRjKHFvNX2ceiBnVOL0,32
+flixopt-2.2.0b0.dist-info/RECORD,,

{flixopt-2.1.1.dist-info → flixopt-2.2.0b0.dist-info}/WHEEL

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

{flixopt-2.1.1.dist-info → flixopt-2.2.0b0.dist-info}/top_level.txt

@@ -2,5 +2,4 @@ docs
 flixopt
 pics
 scripts
-site
 tests

docs/release-notes/v2.1.1.md

@@ -1,11 +0,0 @@
-# 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

site/release-notes/_template.txt

@@ -1,32 +0,0 @@
-# Release v{version}
-
-**Release Date:** YYYY-MM-DD
-
-## What's New
-
-* Feature 1 - Description
-* Feature 2 - Description
-
-## Improvements
-
-* Improvement 1 - Description
-* Improvement 2 - Description
-
-## Bug Fixes
-
-* Fixed issue with X
-* Resolved problem with Y
-
-## Breaking Changes
-
-* Change 1 - Migration instructions
-* Change 2 - Migration instructions
-
-## Deprecations
-
-* Feature X will be removed in v{next_version}
-
-## Dependencies
-
-* Added dependency X v1.2.3
-* Updated dependency Y to v2.0.0