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

flixopt/utils.py

@@ -2,8 +2,10 @@
 This module contains several utility functions used throughout the flixopt framework.
 """
 
+from __future__ import annotations
+
 import logging
-from typing import Any, Dict, List, Literal, Optional, Union
+from typing import Literal
 
 import numpy as np
 import xarray as xr
@@ -11,11 +13,38 @@ import xarray as xr
 logger = logging.getLogger('flixopt')
 
 
-def round_floats(obj, decimals=2):
+def round_nested_floats(obj, decimals=2):
+    """Recursively round floating point numbers in nested data structures.
+
+    This function traverses nested data structures (dictionaries, lists) and rounds
+    any floating point numbers to the specified number of decimal places. It handles
+    various data types including NumPy arrays and xarray DataArrays by converting
+    them to lists with rounded values.
+
+    Args:
+        obj: The object to process. Can be a dict, list, float, int, numpy.ndarray,
+            xarray.DataArray, or any other type.
+        decimals (int, optional): Number of decimal places to round to. Defaults to 2.
+
+    Returns:
+        The processed object with the same structure as the input, but with all
+        floating point numbers rounded to the specified precision. NumPy arrays
+        and xarray DataArrays are converted to lists.
+
+    Examples:
+        >>> data = {'a': 3.14159, 'b': [1.234, 2.678]}
+        >>> round_nested_floats(data, decimals=2)
+        {'a': 3.14, 'b': [1.23, 2.68]}
+
+        >>> import numpy as np
+        >>> arr = np.array([1.234, 5.678])
+        >>> round_nested_floats(arr, decimals=1)
+        [1.2, 5.7]
+    """
     if isinstance(obj, dict):
-        return {k: round_floats(v, decimals) for k, v in obj.items()}
+        return {k: round_nested_floats(v, decimals) for k, v in obj.items()}
     elif isinstance(obj, list):
-        return [round_floats(v, decimals) for v in obj]
+        return [round_nested_floats(v, decimals) for v in obj]
     elif isinstance(obj, float):
         return round(obj, decimals)
     elif isinstance(obj, int):
@@ -29,7 +58,7 @@ def round_floats(obj, decimals=2):
 
 def convert_dataarray(
     data: xr.DataArray, mode: Literal['py', 'numpy', 'xarray', 'structure']
-) -> Union[List, np.ndarray, xr.DataArray, str]:
+) -> list | np.ndarray | xr.DataArray | str:
     """
     Convert a DataArray to a different format.
 

flixopt-3.0.0.dist-info/METADATA

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: flixopt
+Version: 3.0.0
+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.2; 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.20; 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.

flixopt-3.0.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+flixopt/__init__.py,sha256=8F0MKV9GAsFSP5OCZgn1dwzGD7-bZpsmVnTVe56ZcU8,2204
+flixopt/aggregation.py,sha256=P374vIJc1ZcPxxG8dfCPgUKNLRNP2kf8Y-sc1JOA45U,16191
+flixopt/calculation.py,sha256=KJFSjGB08Nq8hfW63_kfKLruXAkYibTCzaVy-LxmVR4,29371
+flixopt/commons.py,sha256=ZNlUN1z-h9OGHPo-s-n5OLlJaoPZKVGcAdRyGKpMk4M,1256
+flixopt/components.py,sha256=bm76uCaXkeLuDBfsJ1kjfaHOl8zmow2JTaNPCK4Jknc,57757
+flixopt/config.py,sha256=hbbwWInUDvnYDlxNidiXkGL5mSwqwLi6p3G9P1p7lkA,21992
+flixopt/core.py,sha256=1eWxpmaDfHfyDt2HgE2WfAzZZ_OsWGYmiOxFrvZVTx4,26351
+flixopt/effects.py,sha256=iLVC4VdFTtZaF6B8BJiILRwe9ahj93og8JQSaAE_ocI,34063
+flixopt/elements.py,sha256=D4EkYZxqtyBhpTYf6C82pBRJf5fjyGXxZ8HMNiaHCuA,36156
+flixopt/features.py,sha256=kd-fMvADv8GXoKkrXObYjRJLN8toBG-5bOHTuh-59kk,25073
+flixopt/flow_system.py,sha256=D84MIkX5oA_4H55p9mOC7tstV96V5RN2qPeJ2exX1ks,40242
+flixopt/interface.py,sha256=iLc2-_adqSeljlJrX6tao8IxBCQcksq4S7HQDw9L_OM,57503
+flixopt/io.py,sha256=2ZnpoU4gVnKfv-FiwoYEA11wlqbdUU8PXJiofRSKl5M,11795
+flixopt/linear_converters.py,sha256=tcz5c1SI36hRFbCX-4NXced12ss9VETg5BE7zOdyeo4,22699
+flixopt/modeling.py,sha256=7N24HRz6Jf1s2P9gMD4Ue_jBC0E7jr5o1qrI4Ik-UBQ,31365
+flixopt/network_app.py,sha256=LnVAlAgzL1BgMYLsJ20a62j6nQUmNccF1zo4ACUXzL4,29433
+flixopt/plotting.py,sha256=lHeSwfSaQCGP2w54S8CzSa7sWwCxMcWci1EU1TYqLWM,60909
+flixopt/results.py,sha256=li0KIiSP3spPIJLAgGz22nK1zpwvxGm3Hh1rfblsGv4,77728
+flixopt/solvers.py,sha256=m38Smc22MJfHYMiqfNf1MA3OmvbTRm5OWS9nECkDdQk,2355
+flixopt/structure.py,sha256=ntLoj--zTnaZwNYKw-WkJTNxY0ef4zDp4S0iiSxyyxE,47707
+flixopt/utils.py,sha256=2c1vwRHMF-vu1oEX4UezGaEw09GiwbzOYZywCTWKOj8,2866
+flixopt-3.0.0.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
+flixopt-3.0.0.dist-info/METADATA,sha256=bA5YAnexuB1Z81yd9JSq7HuQwMjyJSzA25msLQo0-lA,10776
+flixopt-3.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flixopt-3.0.0.dist-info/top_level.txt,sha256=fanTzb9NylIXfv6Ic7spU97fVmRgGDPKvI_91tw4S3E,8
+flixopt-3.0.0.dist-info/RECORD,,

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

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

flixopt-3.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+flixopt

docs/examples/00-Minimal Example.md

@@ -1,5 +0,0 @@
-# Minimal Example
-
-```python
-{! ../examples/00_Minmal/minimal_example.py !}
-```

docs/examples/01-Basic Example.md

@@ -1,5 +0,0 @@
-# Simple example
-
-```python
-{! ../examples/01_Simple/simple_example.py !}
-```

docs/examples/02-Complex Example.md

@@ -1,10 +0,0 @@
-# Complex example
-This saves the results of a calculation to file and reloads them to analyze the results
-## Build the Model
-```python
-{! ../examples/02_Complex/complex_example.py !}
-```
-## Load the Results from file
-```python
-{! ../examples/02_Complex/complex_example_results.py !}
-```

docs/examples/03-Calculation Modes.md

@@ -1,5 +0,0 @@
-# Calculation Mode comparison
-**Note:** This example relies on time series data. You can find it in the `examples` folder of the FlixOpt repository.
-```python
-{! ../examples/03_Calculation_types/example_calculation_types.py !}
-```

docs/examples/index.md

@@ -1,5 +0,0 @@
-# Examples
-
-Here you can find a collection of examples that demonstrate how to use FlixOpt.
-
-We work on improving this gallery. If you have something to share, please contact us!

docs/faq/contribute.md

@@ -1,49 +0,0 @@
-# Contributing to the Project
-
-We warmly welcome contributions from the community! This guide will help you get started with contributing to our project.
-
-## Development Setup
-1. Clone the repository `git clone https://github.com/flixOpt/flixopt.git`
-2. Install the development dependencies `pip install -editable .[dev, docs]`
-3. Run `pytest` and `ruff check .` to ensure your code passes all tests
-
-## Documentation
-FlixOpt uses [mkdocs](https://www.mkdocs.org/) to generate documentation. To preview the documentation locally, run `mkdocs serve` in the root directory.
-
-## Helpful Commands
-- `mkdocs serve` to preview the documentation locally. Navigate to `http://127.0.0.1:8000/` to view the documentation.
-- `pytest` to run the test suite (You can also run the provided python script `run_all_test.py`)
-- `ruff check .` to run the linter
-- `ruff check . --fix` to automatically fix linting issues
-
----
-# Best practices
-
-## Coding Guidelines
-
-- Follow PEP 8 style guidelines
-- Write clear, commented code
-- Include type hints
-- Create or update tests for new functionality
-- Ensure 100% test coverage for new code
-
-## Branches
-As we start to think FlixOpt in **Releases**, we decided to introduce multiple **dev**-branches instead of only one:
-Following the **Semantic Versioning** guidelines, we introduced:
-- `next/patch`: This is where all pull requests for the next patch release (1.0.x) go.  
-- `next/minor`: This is where all pull requests for the next minor release (1.x.0) go.  
-- `next/major`: This is where all pull requests for the next major release (x.0.0) go.
-
-Everything else remains in `feature/...`-branches.
-
-## Pull requests
-Every feature or bugfix should be merged into one of the 3 [release branches](#branches), using **Squash and merge** or a regular **single commit**.
-At some point, `next/minor` or `next/major` will get merged into `main` using a regular **Merge**  (not squash).
-*This ensures that Features are kept separate, and the `next/...`branches stay in synch with ``main`.*
-
-## Releases
-As stated, we follow **Semantic Versioning**.
-Right after one of the 3 [release branches](#branches) is merged into main, a **Tag** should be added to the merge commit and pushed to the main branch. The tag has the form `v1.2.3`.
-With this tag,  a release with **Release Notes** must be created. 
-
-*This is our current best practice*

docs/faq/index.md

@@ -1,3 +0,0 @@
-# Frequently Asked Questions
-
-## Work in progress