flixopt 3.0.2__tar.gz → 3.0.3__tar.gz

{flixopt-3.0.2 → flixopt-3.0.3}/CHANGELOG.md

@@ -41,7 +41,6 @@ Please keep the format of the changelog consistent with the other releases, so t
 
 ---
 
-
 ## [Unreleased] - ????-??-??
 
 ### ✨ Added
@@ -69,6 +68,19 @@ Please keep the format of the changelog consistent with the other releases, so t
 ---
 Until here -->
 
+## [3.0.3] - 2025-10-16
+**Summary**: Hotfixing new plotting parameter `style`. Continue to use `mode`.
+
+### 🐛 Fixed
+- Reverted breaking change from v3.0.0: continue to use `mode parameter in plotting instead of new `style`
+- Renamed new `mode` parameter in plotting methods to `unit_type`
+
+### 📝 Docs
+- Updated Migration Guide and added missing entries.
+- Improved Changelog of v3.0.0
+
+---
+
 ## [3.0.2] - 2025-10-15
 **Summary**: This is a follow-up release to **[v3.0.0](https://github.com/flixOpt/flixOpt/releases/tag/v3.0.0)**, improving the documentation.
 
@@ -139,17 +151,43 @@ This replaces `specific_share_to_other_effects_*` parameters and inverts the dir
 
 ### 💥 Breaking Changes
 
-- `relative_minimum_charge_state` and `relative_maximum_charge_state` don't have an extra timestep anymore.
+**API and Behavior Changes:**
+
+- **Effect system redesigned** (no deprecation):
+  - **Terminology changes**: Effect domains renamed for clarity: `operation` → `temporal`, `invest`/`investment` → `periodic`
+  - **Sharing system**: The old `specific_share_to_other_effects_*` parameters were completely replaced with the new `share_from_temporal` and `share_from_periodic` syntax (see 🔥 Removed section)
+- **FlowSystem independence**: FlowSystems cannot be shared across multiple Calculations anymore. A copy of the FlowSystem is created instead, making every Calculation independent. Each Subcalculation in `SegmentedCalculation` now has its own distinct `FlowSystem` object
+- **Bus and Effect object assignment**: Direct assignment of Bus/Effect objects is no longer supported. Use labels (strings) instead:
+  - `Flow.bus` must receive a string label, not a Bus object
+  - Effect shares must use effect labels (strings) in dictionaries, not Effect objects
+- **Logging defaults** (from v2.2.0): Console and file logging are now disabled by default. Enable explicitly with `CONFIG.Logging.console = True` and `CONFIG.apply()`
+
+**Class and Method Renaming:**
+
 - Renamed class `SystemModel` to `FlowSystemModel`
 - Renamed class `Model` to `Submodel`
 - Renamed `mode` parameter in plotting methods to `style`
-- Renamed investment binary variable `is_invested` to `invested` in `InvestmentModel`
-- `Calculation.do_modeling()` now returns the `Calculation` object instead of its `linopy.Model`. Callers that previously accessed the linopy model directly should now use `calculation.do_modeling().model` instead of `calculation.do_modeling()`.
+- `Calculation.do_modeling()` now returns the `Calculation` object instead of its `linopy.Model`. Callers that previously accessed the linopy model directly should now use `calculation.do_modeling().model` instead of `calculation.do_modeling()`
+
+**Variable Renaming in Results:**
+
+- Investment binary variable: `is_invested` → `invested` in `InvestmentModel`
+- Switch tracking variables in `OnOffModel`:
+  - `switch_on` → `switch|on`
+  - `switch_off` → `switch|off`
+  - `switch_on_nr` → `switch|count`
+- Effect submodel variables (following terminology changes):
+  - `Effect(invest)|total` → `Effect(periodic)`
+  - `Effect(operation)|total` → `Effect(temporal)`
+  - `Effect(operation)|total_per_timestep` → `Effect(temporal)|per_timestep`
+  - `Effect|total` → `Effect`
+
+**Data Structure Changes:**
+
+- `relative_minimum_charge_state` and `relative_maximum_charge_state` don't have an extra timestep anymore. Use the new `relative_minimum_final_charge_state` and `relative_maximum_final_charge_state` parameters for final state control
 
 ### ♻️ Changed
 
-- FlowSystems cannot be shared across multiple Calculations anymore. A copy of the FlowSystem is created instead, making every Calculation independent
-- Each Subcalculation in `SegmentedCalculation` now has its own distinct `FlowSystem` object
 - Type system overhaul - added clear separation between temporal and non-temporal data throughout codebase for better clarity
 - Enhanced FlowSystem interface with improved `__repr__()` and `__str__()` methods
 - Improved Model Structure - Views and organisation is now divided into:
@@ -164,8 +202,6 @@ This replaces `specific_share_to_other_effects_*` parameters and inverts the dir
 
 - The `agg_group` and `agg_weight` parameters of `TimeSeriesData` are deprecated and will be removed in a future version. Use `aggregation_group` and `aggregation_weight` instead.
 - The `active_timesteps` parameter of `Calculation` is deprecated and will be removed in a future version. Use the new `sel(time=...)` method on the FlowSystem instead.
-- The assignment of Bus Objects to Flow.bus is deprecated and will be removed in a future version. Use the label of the Bus instead.
-- The usage of Effects objects in Dicts to assign shares to Effects is deprecated and will be removed in a future version. Use the label of the Effect instead.
 - **InvestParameters** parameters renamed for improved clarity around investment and retirement effects:
     - `fix_effects` → `effects_of_investment`
     - `specific_effects` → `effects_of_investment_per_size`

{flixopt-3.0.2/flixopt.egg-info → flixopt-3.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 3.0.2
+Version: 3.0.3
 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>
@@ -9,7 +9,7 @@ Project-URL: homepage, https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschu
 Project-URL: repository, https://github.com/flixOpt/flixopt
 Project-URL: documentation, https://flixopt.github.io/flixopt/
 Keywords: optimization,energy systems,numerical analysis
-Classifier: Development Status :: 5 - Production/Stable
+Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

{flixopt-3.0.2 → flixopt-3.0.3}/flixopt/plotting.py

@@ -327,7 +327,7 @@ class ColorProcessor:
 
 def with_plotly(
     data: pd.DataFrame,
-    style: Literal['stacked_bar', 'line', 'area', 'grouped_bar'] = 'stacked_bar',
+    mode: Literal['stacked_bar', 'line', 'area', 'grouped_bar'] = 'stacked_bar',
     colors: ColorType = 'viridis',
     title: str = '',
     ylabel: str = '',
@@ -340,7 +340,7 @@ def with_plotly(
     Args:
         data: A DataFrame containing the data to plot, where the index represents time (e.g., hours),
               and each column represents a separate data series.
-        style: The plotting style. Use 'stacked_bar' for stacked bar charts, 'line' for stepped lines,
+        mode: The plotting mode. Use 'stacked_bar' for stacked bar charts, 'line' for stepped lines,
               or 'area' for stacked area charts.
         colors: Color specification, can be:
             - A string with a colorscale name (e.g., 'viridis', 'plasma')
@@ -354,8 +354,8 @@ def with_plotly(
     Returns:
         A Plotly figure object containing the generated plot.
     """
-    if style not in ('stacked_bar', 'line', 'area', 'grouped_bar'):
-        raise ValueError(f"'style' must be one of {{'stacked_bar','line','area', 'grouped_bar'}}, got {style!r}")
+    if mode not in ('stacked_bar', 'line', 'area', 'grouped_bar'):
+        raise ValueError(f"'mode' must be one of {{'stacked_bar','line','area', 'grouped_bar'}}, got {mode!r}")
     if data.empty:
         return go.Figure()
 
@@ -363,7 +363,7 @@ def with_plotly(
 
     fig = fig if fig is not None else go.Figure()
 
-    if style == 'stacked_bar':
+    if mode == 'stacked_bar':
         for i, column in enumerate(data.columns):
             fig.add_trace(
                 go.Bar(
@@ -381,7 +381,7 @@ def with_plotly(
             bargap=0,  # No space between bars
             bargroupgap=0,  # No space between grouped bars
         )
-    if style == 'grouped_bar':
+    if mode == 'grouped_bar':
         for i, column in enumerate(data.columns):
             fig.add_trace(go.Bar(x=data.index, y=data[column], name=column, marker=dict(color=processed_colors[i])))
 
@@ -390,7 +390,7 @@ def with_plotly(
             bargap=0.2,  # No space between bars
             bargroupgap=0,  # space between grouped bars
         )
-    elif style == 'line':
+    elif mode == 'line':
         for i, column in enumerate(data.columns):
             fig.add_trace(
                 go.Scatter(
@@ -401,7 +401,7 @@ def with_plotly(
                     line=dict(shape='hv', color=processed_colors[i]),
                 )
             )
-    elif style == 'area':
+    elif mode == 'area':
         data = data.copy()
         data[(data > -1e-5) & (data < 1e-5)] = 0  # Preventing issues with plotting
         # Split columns into positive, negative, and mixed categories
@@ -468,7 +468,7 @@ def with_plotly(
 
 def with_matplotlib(
     data: pd.DataFrame,
-    style: Literal['stacked_bar', 'line'] = 'stacked_bar',
+    mode: Literal['stacked_bar', 'line'] = 'stacked_bar',
     colors: ColorType = 'viridis',
     title: str = '',
     ylabel: str = '',
@@ -483,7 +483,7 @@ def with_matplotlib(
     Args:
         data: A DataFrame containing the data to plot. The index should represent time (e.g., hours),
               and each column represents a separate data series.
-        style: Plotting style. Use 'stacked_bar' for stacked bar charts or 'line' for stepped lines.
+        mode: Plotting mode. Use 'stacked_bar' for stacked bar charts or 'line' for stepped lines.
         colors: Color specification, can be:
             - A string with a colormap name (e.g., 'viridis', 'plasma')
             - A list of color strings (e.g., ['#ff0000', '#00ff00'])
@@ -499,19 +499,19 @@ def with_matplotlib(
         A tuple containing the Matplotlib figure and axes objects used for the plot.
 
     Notes:
-        - If `style` is 'stacked_bar', bars are stacked for both positive and negative values.
+        - If `mode` is 'stacked_bar', bars are stacked for both positive and negative values.
           Negative values are stacked separately without extra labels in the legend.
-        - If `style` is 'line', stepped lines are drawn for each data series.
+        - If `mode` is 'line', stepped lines are drawn for each data series.
     """
-    if style not in ('stacked_bar', 'line'):
-        raise ValueError(f"'style' must be one of {{'stacked_bar','line'}} for matplotlib, got {style!r}")
+    if mode not in ('stacked_bar', 'line'):
+        raise ValueError(f"'mode' must be one of {{'stacked_bar','line'}} for matplotlib, got {mode!r}")
 
     if fig is None or ax is None:
         fig, ax = plt.subplots(figsize=figsize)
 
     processed_colors = ColorProcessor(engine='matplotlib').process_colors(colors, list(data.columns))
 
-    if style == 'stacked_bar':
+    if mode == 'stacked_bar':
         cumulative_positive = np.zeros(len(data))
         cumulative_negative = np.zeros(len(data))
         width = data.index.to_series().diff().dropna().min()  # Minimum time difference
@@ -542,7 +542,7 @@ def with_matplotlib(
             )
             cumulative_negative += negative_values.values
 
-    elif style == 'line':
+    elif mode == 'line':
         for i, column in enumerate(data.columns):
             ax.step(data.index, data[column], where='post', color=processed_colors[i], label=column)
 

{flixopt-3.0.2 → flixopt-3.0.3}/flixopt/results.py

@@ -921,8 +921,8 @@ class _NodeResults(_ElementResults):
         colors: plotting.ColorType = 'viridis',
         engine: plotting.PlottingEngine = 'plotly',
         indexer: dict[FlowSystemDimensions, Any] | None = None,
-        mode: Literal['flow_rate', 'flow_hours'] = 'flow_rate',
-        style: Literal['area', 'stacked_bar', 'line'] = 'stacked_bar',
+        unit_type: Literal['flow_rate', 'flow_hours'] = 'flow_rate',
+        mode: Literal['area', 'stacked_bar', 'line'] = 'stacked_bar',
         drop_suffix: bool = True,
     ) -> plotly.graph_objs.Figure | tuple[plt.Figure, plt.Axes]:
         """
@@ -935,23 +935,26 @@ class _NodeResults(_ElementResults):
             indexer: Optional selection dict, e.g., {'scenario': 'base', 'period': 2024}.
                  If None, uses first value for each dimension (except time).
                  If empty dict {}, uses all values.
-            style: The style to use for the dataset. Can be 'flow_rate' or 'flow_hours'.
+            unit_type: The unit type to use for the dataset. Can be 'flow_rate' or 'flow_hours'.
                 - 'flow_rate': Returns the flow_rates of the Node.
                 - 'flow_hours': Returns the flow_hours of the Node. [flow_hours(t) = flow_rate(t) * dt(t)]. Renames suffixes to |flow_hours.
+            mode: The plotting mode. Use 'stacked_bar' for stacked bar charts, 'line' for stepped lines, or 'area' for stacked area charts.
             drop_suffix: Whether to drop the suffix from the variable names.
         """
-        ds = self.node_balance(with_last_timestep=True, mode=mode, drop_suffix=drop_suffix, indexer=indexer)
+        ds = self.node_balance(with_last_timestep=True, unit_type=unit_type, drop_suffix=drop_suffix, indexer=indexer)
 
         ds, suffix_parts = _apply_indexer_to_data(ds, indexer, drop=True)
         suffix = '--' + '-'.join(suffix_parts) if suffix_parts else ''
 
-        title = f'{self.label} (flow rates){suffix}' if mode == 'flow_rate' else f'{self.label} (flow hours){suffix}'
+        title = (
+            f'{self.label} (flow rates){suffix}' if unit_type == 'flow_rate' else f'{self.label} (flow hours){suffix}'
+        )
 
         if engine == 'plotly':
             figure_like = plotting.with_plotly(
                 ds.to_dataframe(),
                 colors=colors,
-                style=style,
+                mode=mode,
                 title=title,
             )
             default_filetype = '.html'
@@ -959,7 +962,7 @@ class _NodeResults(_ElementResults):
             figure_like = plotting.with_matplotlib(
                 ds.to_dataframe(),
                 colors=colors,
-                style=style,
+                mode=mode,
                 title=title,
             )
             default_filetype = '.png'
@@ -1063,7 +1066,7 @@ class _NodeResults(_ElementResults):
         negate_outputs: bool = False,
         threshold: float | None = 1e-5,
         with_last_timestep: bool = False,
-        mode: Literal['flow_rate', 'flow_hours'] = 'flow_rate',
+        unit_type: Literal['flow_rate', 'flow_hours'] = 'flow_rate',
         drop_suffix: bool = False,
         indexer: dict[FlowSystemDimensions, Any] | None = None,
     ) -> xr.Dataset:
@@ -1074,7 +1077,7 @@ class _NodeResults(_ElementResults):
             negate_outputs: Whether to negate the output flow_rates of the Node.
             threshold: The threshold for small values. Variables with all values below the threshold are dropped.
             with_last_timestep: Whether to include the last timestep in the dataset.
-            mode: The mode to use for the dataset. Can be 'flow_rate' or 'flow_hours'.
+            unit_type: The unit type to use for the dataset. Can be 'flow_rate' or 'flow_hours'.
                 - 'flow_rate': Returns the flow_rates of the Node.
                 - 'flow_hours': Returns the flow_hours of the Node. [flow_hours(t) = flow_rate(t) * dt(t)]. Renames suffixes to |flow_hours.
             drop_suffix: Whether to drop the suffix from the variable names.
@@ -1102,7 +1105,7 @@ class _NodeResults(_ElementResults):
 
         ds, _ = _apply_indexer_to_data(ds, indexer, drop=True)
 
-        if mode == 'flow_hours':
+        if unit_type == 'flow_hours':
             ds = ds * self._calculation_results.hours_per_timestep
             ds = ds.rename_vars({var: var.replace('flow_rate', 'flow_hours') for var in ds.data_vars})
 
@@ -1137,7 +1140,7 @@ class ComponentResults(_NodeResults):
         show: bool = True,
         colors: plotting.ColorType = 'viridis',
         engine: plotting.PlottingEngine = 'plotly',
-        style: Literal['area', 'stacked_bar', 'line'] = 'stacked_bar',
+        mode: Literal['area', 'stacked_bar', 'line'] = 'stacked_bar',
         indexer: dict[FlowSystemDimensions, Any] | None = None,
     ) -> plotly.graph_objs.Figure:
         """Plot storage charge state over time, combined with the node balance.
@@ -1147,7 +1150,7 @@ class ComponentResults(_NodeResults):
             show: Whether to show the plot or not.
             colors: Color scheme. Also see plotly.
             engine: Plotting engine to use. Only 'plotly' is implemented atm.
-            style: The colors to use for the plot. See `flixopt.plotting.ColorType` for options.
+            mode: The plotting mode. Use 'stacked_bar' for stacked bar charts, 'line' for stepped lines, or 'area' for stacked area charts.
             indexer: Optional selection dict, e.g., {'scenario': 'base', 'period': 2024}.
                  If None, uses first value for each dimension.
                  If empty dict {}, uses all values.
@@ -1171,7 +1174,7 @@ class ComponentResults(_NodeResults):
             fig = plotting.with_plotly(
                 ds.to_dataframe(),
                 colors=colors,
-                style=style,
+                mode=mode,
                 title=title,
             )
 
@@ -1187,7 +1190,7 @@ class ComponentResults(_NodeResults):
             fig, ax = plotting.with_matplotlib(
                 ds.to_dataframe(),
                 colors=colors,
-                style=style,
+                mode=mode,
                 title=title,
             )
 

{flixopt-3.0.2 → flixopt-3.0.3/flixopt.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 3.0.2
+Version: 3.0.3
 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>
@@ -9,7 +9,7 @@ Project-URL: homepage, https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschu
 Project-URL: repository, https://github.com/flixOpt/flixopt
 Project-URL: documentation, https://flixopt.github.io/flixopt/
 Keywords: optimization,energy systems,numerical analysis
-Classifier: Development Status :: 5 - Production/Stable
+Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

{flixopt-3.0.2 → flixopt-3.0.3}/pyproject.toml

@@ -21,7 +21,7 @@ maintainers = [
 ]
 keywords = ["optimization", "energy systems", "numerical analysis"]
 classifiers = [
-    "Development Status :: 5 - Production/Stable",
+    "Development Status :: 4 - Beta",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",