flixopt 1.0.12__tar.gz → 2.0.0__tar.gz

flixopt-2.0.0/.github/workflows/deploy-docs.yaml

@@ -0,0 +1,33 @@
+name: Documentation
+
+on:
+  release:
+    types: [created]  # Automatically deploy docs on release
+  workflow_dispatch:  # Allow manual triggering
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch all history for proper versioning
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install documentation dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[docs]"
+
+      - name: Deploy docs
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          mike deploy --push --update-aliases $VERSION latest

{flixopt-1.0.12 → flixopt-2.0.0}/.github/workflows/python-app.yaml

@@ -99,12 +99,12 @@ jobs:
           (sleep 30 && pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ $PACKAGE_NAME) || \
           (sleep 60 && pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ $PACKAGE_NAME)
           # Basic import test
-          python -c "import flixOpt; print('Installation successful!')"
+          python -c "import flixopt; print('Installation successful!')"
 
   publish-pypi:
     name: Publish to PyPI
     runs-on: ubuntu-22.04
-    needs: [publish-testpypi]  # Only run after TestPyPI publish succeeds
+    needs: [test]  # Only run after TestPyPI publish succeeds
     if: github.event_name == 'release' && github.event.action == 'created'  # Only on release creation
 
     steps:
@@ -144,4 +144,4 @@ jobs:
           # Install from PyPI
           pip install $PACKAGE_NAME
           # Basic import test
-          python -c "import flixOpt; print('PyPI installation successful!')"
+          python -c "import flixopt; print('PyPI installation successful!')"

{flixopt-1.0.12 → flixopt-2.0.0}/.gitignore

@@ -1,4 +1,5 @@
 *.pyc
+*.log
 results/
 .idea/
 .venv/

flixopt-2.0.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: flixopt
+Version: 2.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: MIT License
+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: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2,>=1.21.5
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: linopy>=0.5.1
+Requires-Dist: netcdf4>=1.6.1
+Requires-Dist: rich>=13.0.1
+Requires-Dist: highspy>=1.5.3
+Requires-Dist: pandas<3,>=2
+Requires-Dist: matplotlib>=3.5.2
+Requires-Dist: plotly>=5.15
+Requires-Dist: tomli>=2.0.1
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pyvis==0.3.1; extra == "dev"
+Requires-Dist: tsam>=2.3.1; extra == "dev"
+Requires-Dist: scipy>=1.15.1; extra == "dev"
+Requires-Dist: gurobipy>=10.0; extra == "dev"
+Provides-Extra: full
+Requires-Dist: pyvis==0.3.1; extra == "full"
+Requires-Dist: tsam>=2.3.1; extra == "full"
+Requires-Dist: scipy>=1.15.1; extra == "full"
+Requires-Dist: streamlit>=1.44.0; extra == "full"
+Requires-Dist: gurobipy>=10.0; extra == "full"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Requires-Dist: mkdocs-table-reader-plugin; extra == "docs"
+Requires-Dist: mkdocs-gen-files; extra == "docs"
+Requires-Dist: mkdocs-include-markdown-plugin; extra == "docs"
+Requires-Dist: mkdocs-literate-nav; extra == "docs"
+Requires-Dist: markdown-include; extra == "docs"
+Requires-Dist: pymdown-extensions; extra == "docs"
+Requires-Dist: pygments; extra == "docs"
+Requires-Dist: mike; extra == "docs"
+Dynamic: license-file
+
+# FlixOpt: Energy and Material Flow Optimization Framework
+
+[![📚 Documentation](https://img.shields.io/badge/📚_docs-online-brightgreen.svg)](https://flixopt.github.io/flixopt/latest/)
+[![CI](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://badge.fury.io/py/flixopt.svg)](https://badge.fury.io/py/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)
+
+---
+
+## 🚀 Purpose
+
+**flixopt** is a Python-based optimization framework designed to tackle energy and material flow problems using mixed-integer linear programming (MILP).
+
+**flixopt** bridges the gap between high-level energy systems models like [FINE](https://github.com/FZJ-IEK3-VSA/FINE) used for design and (multi-period) investment decisions and low-level dispatch optimization tools used for operation decisions.
+
+**flixopt** leverages the fast and efficient [linopy](https://github.com/PyPSA/linopy/) for the mathematical modeling and [xarray](https://github.com/pydata/xarray) for data handling.
+
+**flixopt** provides a user-friendly interface with options for advanced users.
+
+It was originally developed by [TU Dresden](https://github.com/gewv-tu-dresden) as part of the SMARTBIOGRID project, funded by the German Federal Ministry for Economic Affairs and Energy (FKZ: 03KB159B). Building on the Matlab-based flixOptMat framework (developed in the FAKS project), FlixOpt also incorporates concepts from [oemof/solph](https://github.com/oemof/oemof-solph). 
+
+---
+
+## 🌟 Key Features
+
+- **High-level Interface** with low-level control
+    - User-friendly interface for defining flow systems
+    - Pre-defined components like CHP, Heat Pump, Cooling Tower, etc.
+    - Fine-grained control for advanced configurations
+
+- **Investment Optimization**
+    - Combined dispatch and investment optimization
+    - Size optimization and discrete investment decisions
+    - Combined with On/Off variables and constraints
+
+- **Effects, not only Costs --> Multi-criteria Optimization**
+    - flixopt abstracts costs as so called 'Effects'. This allows to model costs, CO2-emissions, primary-energy-demand or area-demand at the same time.
+    - Effects can interact with each other(e.g., specific CO2 costs)
+    - Any of these `Effects` can be used as the optimization objective.
+    - A **Weigted Sum** of Effects can be used as the optimization objective.
+    - Every Effect can be constrained ($\epsilon$-constraint method).
+
+- **Calculation Modes**
+    - **Full** - Solve the model with highest accuracy and computational requirements.
+    - **Segmented** - Speed up solving by using a rolling horizon. 
+    - **Aggregated** - Speed up solving by identifying typical periods using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam). Suitable for large models.
+
+---
+
+## 📦 Installation
+
+Install FlixOpt via pip.
+`pip install flixopt`
+With [HiGHS](https://github.com/ERGO-Code/HiGHS?tab=readme-ov-file) included out of the box, flixopt is ready to use..
+
+We recommend installing FlixOpt with all dependencies, which enables additional features like interactive network visualizations ([pyvis](https://github.com/WestHealth/pyvis)) and time series aggregation ([tsam](https://github.com/FZJ-IEK3-VSA/tsam)).
+`pip install "flixopt[full]"`
+
+---
+
+## 📚 Documentation
+
+The documentation is available at [https://flixopt.github.io/flixopt/](https://flixopt.github.io/flixopt/)
+
+---
+
+## 🛠️ Solver Integration
+
+By default, FlixOpt uses the open-source solver [HiGHS](https://highs.dev/) which is installed by default. However, it is compatible with additional solvers such as:  
+
+- [Gurobi](https://www.gurobi.com/)  
+- [CBC](https://github.com/coin-or/Cbc)  
+- [GLPK](https://www.gnu.org/software/glpk/)
+- [CPLEX](https://www.ibm.com/analytics/cplex-optimizer)
+
+For detailed licensing and installation instructions, refer to the respective solver documentation.  
+
+---
+
+## 📖 Citation
+
+If you use FlixOpt in your research or project, please cite the following:  
+
+- **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)  

flixopt-2.0.0/README.md

@@ -0,0 +1,86 @@
+# FlixOpt: Energy and Material Flow Optimization Framework
+
+[![📚 Documentation](https://img.shields.io/badge/📚_docs-online-brightgreen.svg)](https://flixopt.github.io/flixopt/latest/)
+[![CI](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://badge.fury.io/py/flixopt.svg)](https://badge.fury.io/py/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)
+
+---
+
+## 🚀 Purpose
+
+**flixopt** is a Python-based optimization framework designed to tackle energy and material flow problems using mixed-integer linear programming (MILP).
+
+**flixopt** bridges the gap between high-level energy systems models like [FINE](https://github.com/FZJ-IEK3-VSA/FINE) used for design and (multi-period) investment decisions and low-level dispatch optimization tools used for operation decisions.
+
+**flixopt** leverages the fast and efficient [linopy](https://github.com/PyPSA/linopy/) for the mathematical modeling and [xarray](https://github.com/pydata/xarray) for data handling.
+
+**flixopt** provides a user-friendly interface with options for advanced users.
+
+It was originally developed by [TU Dresden](https://github.com/gewv-tu-dresden) as part of the SMARTBIOGRID project, funded by the German Federal Ministry for Economic Affairs and Energy (FKZ: 03KB159B). Building on the Matlab-based flixOptMat framework (developed in the FAKS project), FlixOpt also incorporates concepts from [oemof/solph](https://github.com/oemof/oemof-solph). 
+
+---
+
+## 🌟 Key Features
+
+- **High-level Interface** with low-level control
+    - User-friendly interface for defining flow systems
+    - Pre-defined components like CHP, Heat Pump, Cooling Tower, etc.
+    - Fine-grained control for advanced configurations
+
+- **Investment Optimization**
+    - Combined dispatch and investment optimization
+    - Size optimization and discrete investment decisions
+    - Combined with On/Off variables and constraints
+
+- **Effects, not only Costs --> Multi-criteria Optimization**
+    - flixopt abstracts costs as so called 'Effects'. This allows to model costs, CO2-emissions, primary-energy-demand or area-demand at the same time.
+    - Effects can interact with each other(e.g., specific CO2 costs)
+    - Any of these `Effects` can be used as the optimization objective.
+    - A **Weigted Sum** of Effects can be used as the optimization objective.
+    - Every Effect can be constrained ($\epsilon$-constraint method).
+
+- **Calculation Modes**
+    - **Full** - Solve the model with highest accuracy and computational requirements.
+    - **Segmented** - Speed up solving by using a rolling horizon. 
+    - **Aggregated** - Speed up solving by identifying typical periods using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam). Suitable for large models.
+
+---
+
+## 📦 Installation
+
+Install FlixOpt via pip.
+`pip install flixopt`
+With [HiGHS](https://github.com/ERGO-Code/HiGHS?tab=readme-ov-file) included out of the box, flixopt is ready to use..
+
+We recommend installing FlixOpt with all dependencies, which enables additional features like interactive network visualizations ([pyvis](https://github.com/WestHealth/pyvis)) and time series aggregation ([tsam](https://github.com/FZJ-IEK3-VSA/tsam)).
+`pip install "flixopt[full]"`
+
+---
+
+## 📚 Documentation
+
+The documentation is available at [https://flixopt.github.io/flixopt/](https://flixopt.github.io/flixopt/)
+
+---
+
+## 🛠️ Solver Integration
+
+By default, FlixOpt uses the open-source solver [HiGHS](https://highs.dev/) which is installed by default. However, it is compatible with additional solvers such as:  
+
+- [Gurobi](https://www.gurobi.com/)  
+- [CBC](https://github.com/coin-or/Cbc)  
+- [GLPK](https://www.gnu.org/software/glpk/)
+- [CPLEX](https://www.ibm.com/analytics/cplex-optimizer)
+
+For detailed licensing and installation instructions, refer to the respective solver documentation.  
+
+---
+
+## 📖 Citation
+
+If you use FlixOpt in your research or project, please cite the following:  
+
+- **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)  

flixopt-2.0.0/docs/SUMMARY.md

@@ -0,0 +1,7 @@
+- [Home](index.md)
+- [Getting Started](getting-started.md)
+- [User Guide](user-guide/)
+- [Examples](examples/)
+- [FAQ](faq/)
+- [API-Reference](api-reference/)
+- [Release Notes](release-notes/)

flixopt-2.0.0/docs/contribute.md

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

flixopt-2.0.0/docs/examples/00-Minimal Example.md

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

flixopt-2.0.0/docs/examples/01-Basic Example.md

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

flixopt-2.0.0/docs/examples/02-Complex Example.md

@@ -0,0 +1,10 @@
+# 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 !}
+```

flixopt-2.0.0/docs/examples/03-Calculation Modes.md

@@ -0,0 +1,5 @@
+# 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 !}
+```

flixopt-2.0.0/docs/examples/index.md

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

flixopt-2.0.0/docs/faq/contribute.md

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

flixopt-2.0.0/docs/faq/index.md

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

flixopt-2.0.0/docs/getting-started.md

@@ -0,0 +1,42 @@
+# Getting Started with FlixOpt
+
+This guide will help you install FlixOpt, understand its basic concepts, and run your first optimization model.
+
+## Installation
+
+### Basic Installation
+
+Install FlixOpt directly into your environment using pip:
+
+```bash
+pip install flixopt
+```
+
+This provides the core functionality with the HiGHS solver included.
+
+### Full Installation
+
+For all features including interactive network visualizations and time series aggregation:
+
+```bash
+pip install "flixopt[full]""
+```
+
+## Basic Workflow
+
+Working with FlixOpt follows a general pattern:
+
+1. **Create a [`FlowSystem`][flixopt.flow_system.FlowSystem]** with a time series
+2. **Define [`Effects`][flixopt.effects.Effect]** (costs, emissions, etc.)
+3. **Define [`Buses`][flixopt.elements.Bus]** as connection points in your system
+4. **Add [`Components`][flixopt.components]** like converters, storage, sources/sinks with their Flows
+5. **Run [`Calculations`][flixopt.calculation]** to optimize your system
+6. **Analyze [`Results`][flixopt.results]** using built-in or external visualization tools
+
+## Next Steps
+
+Now that you've installed FlixOpt and understand the basic workflow, you can:
+
+- Learn about the [core concepts of FlixOpt](user-guide/index.md)
+- Explore some [examples](examples/)
+- Check the [API reference](api-reference/index.md) for detailed documentation