flixopt 3.0.1__py3-none-any.whl → 3.0.3__py3-none-any.whl

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/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.3.dist-info/METADATA

@@ -0,0 +1,272 @@
+Metadata-Version: 2.4
+Name: flixopt
+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>
+License-Expression: MIT
+Project-URL: homepage, https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschung/forschungsprojekte/flixopt
+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 :: 4 - Beta
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<3,>=1.21.5
+Requires-Dist: pandas<3,>=2.0.0
+Requires-Dist: xarray<2026.0,>=2024.2.0
+Requires-Dist: linopy<0.6,>=0.5.1
+Requires-Dist: h5netcdf<2,>=1.0.0
+Requires-Dist: pyyaml<7,>=6.0.0
+Requires-Dist: rich<15,>=13.0.0
+Requires-Dist: tomli<3,>=2.0.1; python_version < "3.11"
+Requires-Dist: highspy<2,>=1.5.3
+Requires-Dist: matplotlib<4,>=3.5.2
+Requires-Dist: plotly<7,>=5.15.0
+Requires-Dist: numexpr<2.14,>=2.8.4; python_version < "3.11"
+Provides-Extra: network-viz
+Requires-Dist: dash<4,>=3.0.0; extra == "network-viz"
+Requires-Dist: dash-cytoscape<2,>=1.0.0; extra == "network-viz"
+Requires-Dist: dash-daq<1,>=0.6.0; extra == "network-viz"
+Requires-Dist: networkx<4,>=3.0.0; extra == "network-viz"
+Requires-Dist: werkzeug<4,>=3.0.0; extra == "network-viz"
+Requires-Dist: flask<4,>=3.0.0; extra == "network-viz"
+Provides-Extra: full
+Requires-Dist: pyvis==0.3.2; extra == "full"
+Requires-Dist: tsam<3,>=2.3.1; extra == "full"
+Requires-Dist: scipy<2,>=1.15.1; extra == "full"
+Requires-Dist: gurobipy<13,>=10.0.0; extra == "full"
+Requires-Dist: dash<4,>=3.0.0; extra == "full"
+Requires-Dist: dash-cytoscape<2,>=1.0.0; extra == "full"
+Requires-Dist: dash-daq<1,>=0.6.0; extra == "full"
+Requires-Dist: networkx<4,>=3.0.0; extra == "full"
+Requires-Dist: werkzeug<4,>=3.0.0; extra == "full"
+Requires-Dist: flask<4,>=3.0.0; extra == "full"
+Provides-Extra: dev
+Requires-Dist: pytest==8.4.2; extra == "dev"
+Requires-Dist: pytest-xdist==3.8.0; extra == "dev"
+Requires-Dist: nbformat==5.10.4; extra == "dev"
+Requires-Dist: ruff==0.13.3; extra == "dev"
+Requires-Dist: pre-commit==4.3.0; extra == "dev"
+Requires-Dist: pyvis==0.3.2; extra == "dev"
+Requires-Dist: tsam==2.3.9; extra == "dev"
+Requires-Dist: scipy==1.15.1; extra == "dev"
+Requires-Dist: gurobipy==12.0.3; extra == "dev"
+Requires-Dist: dash==3.0.0; extra == "dev"
+Requires-Dist: dash-cytoscape==1.0.2; extra == "dev"
+Requires-Dist: dash-daq==0.6.0; extra == "dev"
+Requires-Dist: networkx==3.0.0; extra == "dev"
+Requires-Dist: werkzeug==3.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material==9.6.21; extra == "docs"
+Requires-Dist: mkdocstrings-python==1.18.2; extra == "docs"
+Requires-Dist: mkdocs-table-reader-plugin==3.1.0; extra == "docs"
+Requires-Dist: mkdocs-gen-files==0.5.0; extra == "docs"
+Requires-Dist: mkdocs-include-markdown-plugin==7.1.7; extra == "docs"
+Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "docs"
+Requires-Dist: markdown-include==0.8.1; extra == "docs"
+Requires-Dist: pymdown-extensions==10.16.1; extra == "docs"
+Requires-Dist: pygments==2.19.2; extra == "docs"
+Requires-Dist: mike==2.1.3; extra == "docs"
+Dynamic: license-file
+
+# FlixOpt: Energy and Material Flow Optimization Framework
+
+[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://flixopt.github.io/flixopt/latest/)
+[![Build Status](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml/badge.svg)](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml)
+[![PyPI version](https://img.shields.io/pypi/v/flixopt)](https://pypi.org/project/flixopt/)
+[![PyPI status](https://img.shields.io/pypi/status/flixopt.svg)](https://pypi.org/project/flixopt/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/flixopt.svg)](https://pypi.org/project/flixopt/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI downloads](https://img.shields.io/pypi/dm/flixopt)](https://pypi.org/project/flixopt/)
+[![GitHub last commit](https://img.shields.io/github/last-commit/flixOpt/flixopt)](https://github.com/flixOpt/flixopt/commits/main)
+[![GitHub issues](https://img.shields.io/github/issues/flixOpt/flixopt)](https://github.com/flixOpt/flixopt/issues)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/flixOpt/flixopt/main.svg)](https://results.pre-commit.ci/latest/github/flixOpt/flixopt/main)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Powered by linopy](https://img.shields.io/badge/powered%20by-linopy-blue)](https://github.com/PyPSA/linopy/)
+[![Powered by xarray](https://img.shields.io/badge/powered%20by-xarray-blue)](https://xarray.dev/)
+[![DOI](https://img.shields.io/badge/DOI-10.18086%2Feurosun.2022.04.07-blue)](https://doi.org/10.18086/eurosun.2022.04.07)
+[![GitHub stars](https://img.shields.io/github/stars/flixOpt/flixopt?style=social)](https://github.com/flixOpt/flixopt/stargazers)
+
+---
+
+**FlixOpt is a Python framework for optimizing energy and material flow systems** - from district heating networks to industrial production lines, from renewable energy portfolios to supply chain logistics.
+
+**Start simple, scale complex:** Build a working optimization model in minutes, then progressively add detail - multi-period investments, stochastic scenarios, custom constraints - without rewriting your code.
+
+---
+
+## 🚀 Quick Start
+
+```bash
+pip install flixopt
+```
+
+That's it! FlixOpt comes with the [HiGHS](https://highs.dev/) solver included. You're ready to optimize.
+
+**The basic workflow:**
+
+```python
+import flixopt as fx
+
+# 1. Define your system structure
+flow_system = fx.FlowSystem(timesteps)
+flow_system.add_elements(buses, components, effects)
+
+# 2. Create and solve
+calculation = fx.FullCalculation("MyModel", flow_system)
+calculation.solve()
+
+# 3. Analyze results
+calculation.results.solution
+```
+
+**Get started with real examples:**
+- 📚 [Full Documentation](https://flixopt.github.io/flixopt/latest/)
+- 💡 [Examples Gallery](https://flixopt.github.io/flixopt/latest/examples/) - Complete working examples from simple to complex
+- 🔧 [API Reference](https://flixopt.github.io/flixopt/latest/api-reference/)
+
+---
+
+## 🌟 Why FlixOpt?
+
+### Progressive Enhancement - Your Model Grows With You
+
+**Start simple:**
+```python
+# Basic single-period model
+flow_system = fx.FlowSystem(timesteps)
+boiler = fx.Boiler("Boiler", eta=0.9, ...)
+```
+
+**Add complexity incrementally:**
+- **Investment decisions** → Add `InvestParameters` to components
+- **Multi-period planning** → Add `periods` dimension to FlowSystem
+- **Uncertainty modeling** → Add `scenarios` dimension with probabilities
+- **Custom constraints** → Extend with native linopy syntax
+
+**No refactoring required.** Your component definitions stay the same - periods, scenarios, and features are added as dimensions and parameters.
+
+→ [Learn more about multi-period and stochastic modeling](https://flixopt.github.io/flixopt/latest/user-guide/mathematical-notation/dimensions/)
+
+### For Everyone
+
+- **Beginners:** High-level components that "just work"
+- **Experts:** Full access to modify models with linopy
+- **Researchers:** Quick prototyping with customization options
+- **Engineers:** Reliable, tested components without black boxes
+- **Students:** Clear, Pythonic interfaces for learning optimization
+
+### Key Features
+
+**Multi-criteria optimization:** Model costs, emissions, resource use - any custom metric. Optimize single objectives or use weighted combinations and ε-constraints.
+→ [Effects documentation](https://flixopt.github.io/flixopt/latest/user-guide/mathematical-notation/effects-penalty-objective/)
+
+**Performance at any scale:** Choose calculation modes without changing your model - Full, Segmented, or Aggregated (using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam)).
+→ [Calculation modes](https://flixopt.github.io/flixopt/latest/api-reference/calculation/)
+
+**Built for reproducibility:** Self-contained NetCDF result files with complete model information. Load results months later - everything is preserved.
+→ [Results documentation](https://flixopt.github.io/flixopt/latest/api-reference/results/)
+
+**Flexible data operations:** Transform FlowSystems with xarray-style operations (`sel()`, `resample()`) for multi-stage optimization.
+
+---
+
+## 🎯 What is FlixOpt?
+
+### A General-Purpose Flow Optimization Framework
+
+FlixOpt models **any system involving flows and conversions:**
+
+- **Energy systems:** District heating/cooling, microgrids, renewable portfolios, sector coupling
+- **Material flows:** Supply chains, production lines, chemical processes
+- **Integrated systems:** Water-energy nexus, industrial symbiosis
+
+While energy systems are our primary focus, the same foundation applies universally. This enables coupling different system types within integrated models.
+
+### Modern Foundations
+
+Built on [linopy](https://github.com/PyPSA/linopy/) and [xarray](https://github.com/pydata/xarray), FlixOpt delivers **performance** and **transparency**. Full access to variables, constraints, and model structure. Extend anything with native linopy syntax.
+
+### Our Position
+
+We bridge the gap between high-level strategic models (like [FINE](https://github.com/FZJ-IEK3-VSA/FINE)) and low-level dispatch tools - similar to [PyPSA](https://docs.pypsa.org/latest/). FlixOpt is the sweet spot for detailed operational planning and long-term investment analysis in the **same framework**.
+
+### Academic Roots
+
+Originally developed at [TU Dresden](https://github.com/gewv-tu-dresden) for the SMARTBIOGRID project (funded by the German Federal Ministry for Economic Affairs and Energy, FKZ: 03KB159B). FlixOpt evolved from the MATLAB-based flixOptMat framework while incorporating best practices from [oemof/solph](https://github.com/oemof/oemof-solph).
+
+---
+
+## 🛣️ Roadmap
+
+**FlixOpt aims to be the most accessible, flexible, and universal Python framework for energy and material flow optimization.** We believe optimization modeling should be approachable for beginners yet powerful for experts, minimizing context switching between different planning horizons.
+
+**Current focus:**
+- Enhanced component library (sector coupling, hydrogen, thermal networks)
+- Examples showcasing multi-period and stochastic modeling
+- Advanced result analysis and visualization
+
+**Future vision:**
+- Modeling to generate alternatives (MGA) for robust decision-making
+- Advanced stochastic optimization (two-stage, CVaR)
+- Community ecosystem of user-contributed components
+
+→ [Full roadmap and vision](https://flixopt.github.io/flixopt/latest/roadmap/)
+
+---
+
+## 🛠️ Installation
+
+### Basic Installation
+
+```bash
+pip install flixopt
+```
+
+Includes the [HiGHS](https://highs.dev/) solver - you're ready to optimize immediately.
+
+### Full Installation
+
+For additional features (interactive network visualization, time series aggregation):
+
+```bash
+pip install "flixopt[full]"
+```
+
+### Solver Support
+
+FlixOpt supports many solvers via linopy: **HiGHS** (included), **Gurobi**, **CPLEX**, **CBC**, **GLPK**, and more.
+
+→ [Installation guide](https://flixopt.github.io/flixopt/latest/getting-started/)
+
+---
+
+## 🤝 Contributing
+
+FlixOpt thrives on community input. Whether you're fixing bugs, adding components, improving docs, or sharing use cases - **we welcome your contributions.**
+
+→ [Contribution guide](https://flixopt.github.io/flixopt/latest/contribute/)
+
+---
+
+## 📖 Citation
+
+If FlixOpt supports your research or project, please cite:
+
+- **Main Citation:** [DOI:10.18086/eurosun.2022.04.07](https://doi.org/10.18086/eurosun.2022.04.07)
+- **Short Overview:** [DOI:10.13140/RG.2.2.14948.24969](https://doi.org/10.13140/RG.2.2.14948.24969)
+
+---
+
+## 📄 License
+
+MIT License - See [LICENSE](https://github.com/flixopt/flixopt/blob/main/LICENSE) for details.

{flixopt-3.0.1.dist-info → flixopt-3.0.3.dist-info}/RECORD

@@ -14,13 +14,13 @@ flixopt/io.py,sha256=2ZnpoU4gVnKfv-FiwoYEA11wlqbdUU8PXJiofRSKl5M,11795
 flixopt/linear_converters.py,sha256=tcz5c1SI36hRFbCX-4NXced12ss9VETg5BE7zOdyeo4,22699
 flixopt/modeling.py,sha256=s0zipbblq-LJrSe7angKT3Imxgr3kIbprG98HUvmkzI,31322
 flixopt/network_app.py,sha256=LnVAlAgzL1BgMYLsJ20a62j6nQUmNccF1zo4ACUXzL4,29433
-flixopt/plotting.py,sha256=lHeSwfSaQCGP2w54S8CzSa7sWwCxMcWci1EU1TYqLWM,60909
-flixopt/results.py,sha256=rgyYJTcgF1DOxYSvKM__BTfVU13o13DwSBjvA4o4gdM,77773
+flixopt/plotting.py,sha256=T_fUwfR6x_rEQeE2dmGE7Nvy0K7ujoLnq09NEr6Ru1I,60889
+flixopt/results.py,sha256=fHcgS5b31lMJxF48-ngDTnCdCVolRKRtDQXjaZABsrA,78018
 flixopt/solvers.py,sha256=m38Smc22MJfHYMiqfNf1MA3OmvbTRm5OWS9nECkDdQk,2355
 flixopt/structure.py,sha256=ntLoj--zTnaZwNYKw-WkJTNxY0ef4zDp4S0iiSxyyxE,47707
 flixopt/utils.py,sha256=CtCMBjvq31upz7i-_1nbPnSe-1CoRoOWlPkucwiSo5Q,2930
-flixopt-3.0.1.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
-flixopt-3.0.1.dist-info/METADATA,sha256=TJLBIM5v232UVDWCn5Mrq0-HAfjTW0OBUNC8KbQQIPY,10776
-flixopt-3.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-flixopt-3.0.1.dist-info/top_level.txt,sha256=fanTzb9NylIXfv6Ic7spU97fVmRgGDPKvI_91tw4S3E,8
-flixopt-3.0.1.dist-info/RECORD,,
+flixopt-3.0.3.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
+flixopt-3.0.3.dist-info/METADATA,sha256=d016PxDA7cMrKArNB761-4E-wUMzIcdf1HTjgYZG_BU,12669
+flixopt-3.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flixopt-3.0.3.dist-info/top_level.txt,sha256=fanTzb9NylIXfv6Ic7spU97fVmRgGDPKvI_91tw4S3E,8
+flixopt-3.0.3.dist-info/RECORD,,

flixopt-3.0.1.dist-info/METADATA

@@ -1,209 +0,0 @@
-Metadata-Version: 2.4
-Name: flixopt
-Version: 3.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>
-License-Expression: MIT
-Project-URL: homepage, https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschung/forschungsprojekte/flixopt
-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 :: 3 - Alpha
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy<3,>=1.21.5
-Requires-Dist: pandas<3,>=2.0.0
-Requires-Dist: xarray<2026.0,>=2024.2.0
-Requires-Dist: linopy<0.6,>=0.5.1
-Requires-Dist: h5netcdf<2,>=1.0.0
-Requires-Dist: pyyaml<7,>=6.0.0
-Requires-Dist: rich<15,>=13.0.0
-Requires-Dist: tomli<3,>=2.0.1; python_version < "3.11"
-Requires-Dist: highspy<2,>=1.5.3
-Requires-Dist: matplotlib<4,>=3.5.2
-Requires-Dist: plotly<7,>=5.15.0
-Requires-Dist: numexpr<2.14,>=2.8.4; python_version < "3.11"
-Provides-Extra: network-viz
-Requires-Dist: dash<4,>=3.0.0; extra == "network-viz"
-Requires-Dist: dash-cytoscape<2,>=1.0.0; extra == "network-viz"
-Requires-Dist: dash-daq<1,>=0.6.0; extra == "network-viz"
-Requires-Dist: networkx<4,>=3.0.0; extra == "network-viz"
-Requires-Dist: werkzeug<4,>=3.0.0; extra == "network-viz"
-Requires-Dist: flask<4,>=3.0.0; extra == "network-viz"
-Provides-Extra: full
-Requires-Dist: pyvis==0.3.2; extra == "full"
-Requires-Dist: tsam<3,>=2.3.1; extra == "full"
-Requires-Dist: scipy<2,>=1.15.1; extra == "full"
-Requires-Dist: gurobipy<13,>=10.0.0; extra == "full"
-Requires-Dist: dash<4,>=3.0.0; extra == "full"
-Requires-Dist: dash-cytoscape<2,>=1.0.0; extra == "full"
-Requires-Dist: dash-daq<1,>=0.6.0; extra == "full"
-Requires-Dist: networkx<4,>=3.0.0; extra == "full"
-Requires-Dist: werkzeug<4,>=3.0.0; extra == "full"
-Requires-Dist: flask<4,>=3.0.0; extra == "full"
-Provides-Extra: dev
-Requires-Dist: pytest==8.4.2; extra == "dev"
-Requires-Dist: pytest-xdist==3.8.0; extra == "dev"
-Requires-Dist: nbformat==5.10.4; extra == "dev"
-Requires-Dist: ruff==0.13.3; extra == "dev"
-Requires-Dist: pre-commit==4.3.0; extra == "dev"
-Requires-Dist: pyvis==0.3.2; extra == "dev"
-Requires-Dist: tsam==2.3.9; extra == "dev"
-Requires-Dist: scipy==1.15.1; extra == "dev"
-Requires-Dist: gurobipy==12.0.3; extra == "dev"
-Requires-Dist: dash==3.0.0; extra == "dev"
-Requires-Dist: dash-cytoscape==1.0.2; extra == "dev"
-Requires-Dist: dash-daq==0.6.0; extra == "dev"
-Requires-Dist: networkx==3.0.0; extra == "dev"
-Requires-Dist: werkzeug==3.0.0; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: mkdocs-material==9.6.21; extra == "docs"
-Requires-Dist: mkdocstrings-python==1.18.2; extra == "docs"
-Requires-Dist: mkdocs-table-reader-plugin==3.1.0; extra == "docs"
-Requires-Dist: mkdocs-gen-files==0.5.0; extra == "docs"
-Requires-Dist: mkdocs-include-markdown-plugin==7.1.7; extra == "docs"
-Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "docs"
-Requires-Dist: markdown-include==0.8.1; extra == "docs"
-Requires-Dist: pymdown-extensions==10.16.1; extra == "docs"
-Requires-Dist: pygments==2.19.2; extra == "docs"
-Requires-Dist: mike==2.1.3; extra == "docs"
-Dynamic: license-file
-
-# FlixOpt: Energy and Material Flow Optimization Framework
-
-[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://flixopt.github.io/flixopt/latest/)
-[![Build Status](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml/badge.svg)](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml)
-[![PyPI version](https://img.shields.io/pypi/v/flixopt)](https://pypi.org/project/flixopt/)
-[![Python Versions](https://img.shields.io/pypi/pyversions/flixopt.svg)](https://pypi.org/project/flixopt/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
----
-
-## 🎯 Vision
-
-**FlixOpt aims to be the most accessible and flexible Python framework for energy and material flow optimization.**
-
-We believe that optimization modeling should be **approachable for beginners** yet **powerful for experts**. Too often, frameworks force you to choose between ease of use and flexibility. FlixOpt refuses this compromise.
-
-### Where We're Going
-
-**Short-term goals:**
-- **Multi-dimensional modeling**: Full support for multi-period investments and scenario-based stochastic optimization (periods and scenarios are in active development)
-- **Enhanced component library**: More pre-built, domain-specific components (sector coupling, hydrogen systems, thermal networks, demand-side management)
-
-**Medium-term vision:**
-- **Modeling to generate alternatives (MGA)**: Built-in support for exploring near-optimal solution spaces to produce more robust, diverse solutions under uncertainty
-- **Interactive tutorials**: Browser-based, reactive tutorials for learning FlixOpt without local installation
-- **Standardized cost calculations**: Align with industry standards (VDI 2067) for CAPEX/OPEX calculations
-- **Advanced result analysis**: Time-series aggregation, automated reporting, and rich visualization options
-
-**Long-term vision:**
-- **Showcase universal applicability**: FlixOpt already handles any flow-based system (supply chains, water networks, production planning, chemical processes) - we need more examples and domain-specific component libraries to demonstrate this
-- **Seamless integration**: First-class support for coupling with simulation tools, databases, existing energy system models, and GIS data
-- **Robust optimization**: Built-in uncertainty quantification and stochastic programming capabilities
-- **Community ecosystem**: Rich library of user-contributed components, examples, and domain-specific extensions
-- **Model validation tools**: Automated checks for physical plausibility, data consistency, and common modeling errors
-
-### Why FlixOpt Exists
-
-FlixOpt is a **general-purpose framework for modeling any system involving flows and conversions** - energy, materials, fluids, goods, or data. While energy systems are our primary focus, the same mathematical foundation applies to supply chains, water networks, production lines, and more.
-
-We bridge the gap between high-level strategic models (like [FINE](https://github.com/FZJ-IEK3-VSA/FINE)) for long-term planning and low-level dispatch tools for operations. FlixOpt is the **sweet spot** for:
-
-- **Researchers** who need to prototype quickly but may require deep customization later
-- **Engineers** who want reliable, tested components without black-box abstractions
-- **Students** learning optimization who benefit from clear, Pythonic interfaces
-- **Practitioners** who need to move from model to production-ready results
-- **Domain experts** from any field where things flow, transform, and need optimizing
-
-Built on modern foundations ([linopy](https://github.com/PyPSA/linopy/) and [xarray](https://github.com/pydata/xarray)), FlixOpt delivers both **performance** and **transparency**. You can inspect everything, extend anything, and trust that your model does exactly what you designed.
-
-Originally developed at [TU Dresden](https://github.com/gewv-tu-dresden) for the SMARTBIOGRID project (funded by the German Federal Ministry for Economic Affairs and Energy, FKZ: 03KB159B), FlixOpt has evolved from the Matlab-based flixOptMat framework while incorporating the best ideas from [oemof/solph](https://github.com/oemof/oemof-solph).
-
----
-
-## 🌟 What Makes FlixOpt Different
-
-### Start Simple, Scale Complex
-Define a working model in minutes with high-level components, then drill down to fine-grained control when needed. No rewriting, no framework switching.
-
-```python
-import flixopt as fx
-
-# Simple start
-boiler = fx.Boiler("Boiler", eta=0.9, ...)
-
-# Advanced control when needed - extend with native linopy
-boiler.model.add_constraints(custom_constraint, name="my_constraint")
-```
-
-### Multi-Criteria Optimization Done Right
-Model costs, emissions, resource use, and any custom metric simultaneously as **Effects**. Optimize any single Effect, use weighted combinations, or apply ε-constraints:
-
-```python
-costs = fx.Effect('costs', '€', 'Total costs',
-                  share_from_temporal={'CO2': 180})  # 180 €/tCO2
-co2 = fx.Effect('CO2', 'kg', 'Emissions', maximum_periodic=50000)
-```
-
-### Performance at Any Scale
-Choose the right calculation mode for your problem:
-- **Full** - Maximum accuracy for smaller problems
-- **Segmented** - Rolling horizon for large time series
-- **Aggregated** - Typical periods using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam) for massive models
-
-### Built for Reproducibility
-Every result file is self-contained with complete model information. Load it months later and know exactly what you optimized. Export to NetCDF, share with colleagues, archive for compliance.
-
----
-
-## 🚀 Quick Start
-
-```bash
-pip install flixopt
-```
-
-That's it. FlixOpt comes with the [HiGHS](https://highs.dev/) solver included - you're ready to optimize.
-Many more solvers are supported (gurobi, cplex, cbc, glpk, ...)
-
-For additional features (interactive network visualization, time series aggregation):
-```bash
-pip install "flixopt[full]"
-```
-
-**Next steps:**
-- 📚 [Full Documentation](https://flixopt.github.io/flixopt/latest/)
-- 💡 [Examples](https://flixopt.github.io/flixopt/latest/examples/)
-- 🔧 [API Reference](https://flixopt.github.io/flixopt/latest/api-reference/)
-
----
-
-## 🤝 Contributing
-
-FlixOpt thrives on community input. Whether you're fixing bugs, adding components, improving docs, or sharing use cases - we welcome your contributions.
-
-See our [contribution guide](https://flixopt.github.io/flixopt/latest/contribute/) to get started.
-
----
-
-## 📖 Citation
-
-If FlixOpt supports your research or project, please cite:
-
-- **Main Citation:** [DOI:10.18086/eurosun.2022.04.07](https://doi.org/10.18086/eurosun.2022.04.07)
-- **Short Overview:** [DOI:10.13140/RG.2.2.14948.24969](https://doi.org/10.13140/RG.2.2.14948.24969)
-
----
-
-## 📄 License
-
-MIT License - See [LICENSE](https://github.com/flixopt/flixopt/blob/main/LICENSE) for details.