flixopt 3.1.0__tar.gz → 3.1.1__tar.gz

{flixopt-3.1.0 → flixopt-3.1.1}/CHANGELOG.md

@@ -50,8 +50,47 @@ If upgrading from v2.x, see the [v3.0.0 release notes](https://github.com/flixOp
 
 ## [Unreleased] - ????-??-??
 
+If upgrading from v2.x, see the [v3.0.0 release notes](https://github.com/flixOpt/flixOpt/releases/tag/v3.0.0) and [Migration Guide](https://flixopt.github.io/flixopt/latest/user-guide/migration-guide-v3/).
+
+### ✨ Added
+
+### 💥 Breaking Changes
+
+### ♻️ Changed
+
+### 🗑️ Deprecated
+
+### 🔥 Removed
+
+### 🐛 Fixed
+
+### 🔒 Security
+
+### 📦 Dependencies
+
+### 📝 Docs
+
+### 👷 Development
+
+### 🚧 Known Issues
+
+---
+
 Until here -->
 
+## [3.1.1] - 2025-10-20
+**Summary**: Fixed a bug when acessing the `effects_per_component` dataset in results without periodic effects.
+
+If upgrading from v2.x, see the [v3.0.0 release notes](https://github.com/flixOpt/flixOpt/releases/tag/v3.0.0) and [Migration Guide](https://flixopt.github.io/flixopt/latest/user-guide/migration-guide-v3/).
+
+### 🐛 Fixed
+- Fixed ValueError in effects_per_component when all periodic effects are scalars/NaN by explicitly creating mode-specific templates (via _create_template_for_mode) with correct dimensions
+
+### 👷 Development
+- Converted all remaining numpy style docstrings to google style
+
+---
+
 ## [3.1.0] - 2025-10-19
 
 **Summary**: This release adds faceting and animation support for multidimensional plots and redesigns the documentation website. Plotting results across scenarios or periods is now significantly simpler (Plotly only).

{flixopt-3.1.0/flixopt.egg-info → flixopt-3.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 3.1.0
+Version: 3.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-3.1.0 → flixopt-3.1.1}/flixopt/components.py

@@ -1304,16 +1304,18 @@ class Sink(Component):
         prevent_simultaneous_flow_rates: bool = False,
         **kwargs,
     ):
-        """
-        Initialize a Sink (consumes flow from the system).
-
-        Supports legacy `sink=` keyword for backward compatibility (deprecated): if `sink` is provided it is used as the single input flow and a DeprecationWarning is issued; specifying both `inputs` and `sink` raises ValueError.
-
-        Parameters:
-            label (str): Unique element label.
-            inputs (list[Flow], optional): Input flows for the sink.
-            meta_data (dict, optional): Arbitrary metadata attached to the element.
-            prevent_simultaneous_flow_rates (bool, optional): If True, prevents simultaneous nonzero flow rates across the element's inputs by wiring that restriction into the base Component setup.
+        """Initialize a Sink (consumes flow from the system).
+
+        Supports legacy `sink=` keyword for backward compatibility (deprecated): if `sink` is provided
+        it is used as the single input flow and a DeprecationWarning is issued; specifying both
+        `inputs` and `sink` raises ValueError.
+
+        Args:
+            label: Unique element label.
+            inputs: Input flows for the sink.
+            meta_data: Arbitrary metadata attached to the element.
+            prevent_simultaneous_flow_rates: If True, prevents simultaneous nonzero flow rates
+                across the element's inputs by wiring that restriction into the base Component setup.
 
         Note:
             The deprecated `sink` kwarg is accepted for compatibility but will be removed in future releases.

{flixopt-3.1.0 → flixopt-3.1.1}/flixopt/effects.py

@@ -480,19 +480,17 @@ class EffectCollection:
     def create_effect_values_dict(
         self, effect_values_user: PeriodicEffectsUser | TemporalEffectsUser
     ) -> dict[str, Scalar | TemporalDataUser] | None:
-        """
-        Converts effect values into a dictionary. If a scalar is provided, it is associated with a default effect type.
-
-        Examples
-        --------
-        effect_values_user = 20                               -> {'<standard_effect_label>': 20}
-        effect_values_user = {None: 20}                       -> {'<standard_effect_label>': 20}
-        effect_values_user = None                             -> None
-        effect_values_user = {'effect1': 20, 'effect2': 0.3}  -> {'effect1': 20, 'effect2': 0.3}
-
-        Returns
-        -------
-        dict or None
+        """Converts effect values into a dictionary. If a scalar is provided, it is associated with a default effect type.
+
+        Examples:
+            ```python
+            effect_values_user = 20                               -> {'<standard_effect_label>': 20}
+            effect_values_user = {None: 20}                       -> {'<standard_effect_label>': 20}
+            effect_values_user = None                             -> None
+            effect_values_user = {'effect1': 20, 'effect2': 0.3}  -> {'effect1': 20, 'effect2': 0.3}
+            ```
+
+        Returns:
             A dictionary keyed by effect label, or None if input is None.
             Note: a standard effect must be defined when passing scalars or None labels.
         """

{flixopt-3.1.0 → flixopt-3.1.1}/flixopt/results.py

@@ -230,6 +230,7 @@ class CalculationResults:
         self.timesteps_extra = self.solution.indexes['time']
         self.hours_per_timestep = FlowSystem.calculate_hours_per_timestep(self.timesteps_extra)
         self.scenarios = self.solution.indexes['scenario'] if 'scenario' in self.solution.indexes else None
+        self.periods = self.solution.indexes['period'] if 'period' in self.solution.indexes else None
 
         self._effect_share_factors = None
         self._flow_system = None
@@ -619,6 +620,30 @@ class CalculationResults:
             total = xr.DataArray(np.nan)
         return total.rename(f'{element}->{effect}({mode})')
 
+    def _create_template_for_mode(self, mode: Literal['temporal', 'periodic', 'total']) -> xr.DataArray:
+        """Create a template DataArray with the correct dimensions for a given mode.
+
+        Args:
+            mode: The calculation mode ('temporal', 'periodic', or 'total').
+
+        Returns:
+            A DataArray filled with NaN, with dimensions appropriate for the mode.
+        """
+        coords = {}
+        if mode == 'temporal':
+            coords['time'] = self.timesteps_extra
+        if self.periods is not None:
+            coords['period'] = self.periods
+        if self.scenarios is not None:
+            coords['scenario'] = self.scenarios
+
+        # Create template with appropriate shape
+        if coords:
+            shape = tuple(len(coords[dim]) for dim in coords)
+            return xr.DataArray(np.full(shape, np.nan, dtype=float), coords=coords, dims=list(coords.keys()))
+        else:
+            return xr.DataArray(np.nan)
+
     def _create_effects_dataset(self, mode: Literal['temporal', 'periodic', 'total']) -> xr.Dataset:
         """Creates a dataset containing effect totals for all components (including their flows).
         The dataset does contain the direct as well as the indirect effects of each component.
@@ -629,32 +654,23 @@ class CalculationResults:
         Returns:
             An xarray Dataset with components as dimension and effects as variables.
         """
+        # Create template with correct dimensions for this mode
+        template = self._create_template_for_mode(mode)
+
         ds = xr.Dataset()
         all_arrays = {}
-        template = None  # Template is needed to determine the dimensions of the arrays. This handles the case of no shares for an effect
-
         components_list = list(self.components)
 
-        # First pass: collect arrays and find template
+        # Collect arrays for all effects and components
         for effect in self.effects:
             effect_arrays = []
             for component in components_list:
                 da = self._compute_effect_total(element=component, effect=effect, mode=mode, include_flows=True)
                 effect_arrays.append(da)
 
-                if template is None and (da.dims or not da.isnull().all()):
-                    template = da
-
             all_arrays[effect] = effect_arrays
 
-        # Ensure we have a template
-        if template is None:
-            raise ValueError(
-                f"No template with proper dimensions found for mode '{mode}'. "
-                f'All computed arrays are scalars, which indicates a data issue.'
-            )
-
-        # Second pass: process all effects (guaranteed to include all)
+        # Process all effects: expand scalar NaN arrays to match template dimensions
         for effect in self.effects:
             dataarrays = all_arrays[effect]
             component_arrays = []

{flixopt-3.1.0 → flixopt-3.1.1}/flixopt/structure.py

@@ -880,13 +880,10 @@ class Element(Interface):
 
     @staticmethod
     def _valid_label(label: str) -> str:
-        """
-        Checks if the label is valid. If not, it is replaced by the default label
+        """Checks if the label is valid. If not, it is replaced by the default label.
 
-        Raises
-        ------
-        ValueError
-            If the label is not valid
+        Raises:
+            ValueError: If the label is not valid.
         """
         not_allowed = ['(', ')', '|', '->', '\\', '-slash-']  # \\ is needed to check for \
         if any([sign in label for sign in not_allowed]):

{flixopt-3.1.0 → flixopt-3.1.1/flixopt.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 3.1.0
+Version: 3.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>