flixopt 1.0.12__tar.gz

flixopt-1.0.12/.github/workflows/python-app.yaml

@@ -0,0 +1,147 @@
+name: Python Package CI/CD
+
+on:
+  push:
+    branches: [main]  # Run on pushes to main (after PR is merged)
+    tags:
+      - 'v*'  # Trigger on version tags
+  pull_request:
+    branches: [main, next/*]  # Run when PRs are created or updated
+    types: [opened, synchronize, reopened]
+  release:
+    types: [created]  # Trigger when a release is created
+
+jobs:
+  lint:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"  # Ruff tasks can run with a single Python version
+
+      - name: Install Ruff
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+
+      - name: Run Ruff Linting
+        run: ruff check .
+
+  test:
+    runs-on: ubuntu-22.04
+    needs: lint  # Run tests only after linting passes
+    strategy:
+      fail-fast: false  # Continue testing other Python versions if one fails
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+
+      - name: Run tests
+        run: pytest -v -p no:warnings
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    runs-on: ubuntu-22.04
+    needs: [test]  # Only run after tests pass
+    if: github.event_name == 'release' && github.event.action == 'created'  # Only on release creation
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build setuptools wheel twine
+
+      - name: Build the distribution
+        run: |
+          python -m build
+
+      - name: Upload to TestPyPI
+        run: |
+          twine upload --repository testpypi dist/* --verbose
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          
+      - name: Test install from TestPyPI
+        run: |
+          # Create a temporary environment to test installation
+          python -m venv test_env
+          source test_env/bin/activate
+          # Get the package name from the built distribution
+          PACKAGE_NAME=$(ls dist/*.tar.gz | head -n 1 | sed 's/dist\///' | sed 's/-[0-9].*$//')
+          # Install from TestPyPI with retry (TestPyPI can be slow to index)
+          pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ $PACKAGE_NAME || \
+          (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!')"
+
+  publish-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-22.04
+    needs: [publish-testpypi]  # Only run after TestPyPI publish succeeds
+    if: github.event_name == 'release' && github.event.action == 'created'  # Only on release creation
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build setuptools wheel twine
+
+      - name: Build the distribution
+        run: |
+          python -m build
+
+      - name: Upload to PyPI
+        run: |
+          twine upload dist/* --verbose
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Verify PyPI installation
+        run: |
+          # Create a temporary environment to test installation
+          python -m venv prod_test_env
+          source prod_test_env/bin/activate
+          # Get the package name from the built distribution
+          PACKAGE_NAME=$(ls dist/*.tar.gz | head -n 1 | sed 's/dist\///' | sed 's/-[0-9].*$//')
+          # Wait for PyPI to index the package
+          sleep 60
+          # Install from PyPI
+          pip install $PACKAGE_NAME
+          # Basic import test
+          python -c "import flixOpt; print('PyPI installation successful!')"

flixopt-1.0.12/.gitignore

@@ -0,0 +1,9 @@
+*.pyc
+results/
+.idea/
+.venv/
+~/.venv
+venv/
+.DS_Store
+lib/
+temp-plot.html

flixopt-1.0.12/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Chair of Building Energy Systems and Heat Supply - TU Dresden
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

flixopt-1.0.12/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.2
+Name: flixopt
+Version: 1.0.12
+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
+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: Pyomo>=6.4.2
+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"
+Provides-Extra: full
+Requires-Dist: pyvis==0.3.1; extra == "full"
+Requires-Dist: tsam>=2.3.1; extra == "full"
+
+# flixOpt: Energy and Material Flow Optimization Framework
+
+**flixOpt** is a Python-based optimization framework designed to tackle energy and material flow problems using mixed-integer linear programming (MILP). Combining flexibility and efficiency, it provides a powerful platform for both dispatch and investment optimization challenges.
+
+---
+
+## 🚀 Introduction
+
+flixOpt was 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). 
+
+Although flixOpt is in its early stages, it is fully functional and ready for experimentation. It is used for investment and operation decisions by energy providing companys as well as research institutions. Feedback and collaboration are highly encouraged to help shape its future.
+
+---
+
+## 📦 Installation
+
+Install flixOpt directly into your environment using pip. Thanks to [HiGHS](https://github.com/ERGO-Code/HiGHS?tab=readme-ov-file), flixOpt can be used without further setup.
+`pip install git+https://github.com/flixOpt/flixopt.git`
+
+We recommend installing flixOpt with all dependencies, which enables interactive network visualizations by [pyvis](https://github.com/WestHealth/pyvis) and time series aggregation by [tsam](https://github.com/FZJ-IEK3-VSA/tsam).
+`pip install "flixOpt[full] @ git+https://github.com/flixOpt/flixopt.git"`
+
+---
+
+## 🌟 Key Features and Concepts
+
+### 💡 High-level Interface...
+  - flixOpt aims to provide a user-friendly interface for defining and solving energy systems, without sacrificing fine-grained control where necessary.
+  - This is achieved through a high-level interface with many optional or default parameters.
+  - The most important concepts are:
+    - **FlowSystem**: Represents the System that is modeled.
+    - **Flow**: A Flow represents a stream of matter or energy. In an Energy-System, it could be electricity [kW]
+    - **Bus**: A Bus represents a balancing node in the Energy-System, typically connecting a demand to a supply.
+    - **Component**: A Component is a physical entity that consumes or produces matter or energy. It can also transform matter or energy into other kinds of matter or energy.
+    - **Effect**: Flows and Components can have Effects, related to their usage (or size). Common effects are *costs*, *CO2-emissions*, *primary-energy-demand* or *area-demand*. One Effect is used as the optimization target. The others can be constrained.
+  - To simplify the modeling process, high-level **Components** (CHP, Boiler, Heat Pump, Cooling Tower, Storage, etc.) are availlable.
+
+### 🎛️ ...with low-level control
+- **Segmented Linear Correlations**  
+  - Accurate modeling for efficiencies, investment effects, and sizes.
+- **On/Off Variables**
+  - Modeling On/Off-Variables and their constraints.
+    - On-Hours/Off-Hours
+    - Consecutive On-Hours/ Off-Hours
+    - Switch On/Off
+
+### 💰 Investment Optimization
+- flixOpt combines dispatch optimization with investment optimization in one model.
+- Size and/or discrete investment decisions can be modeled
+- Investment decisions can be combined with Modeling On/Off-Variables and their constraints
+
+### Further Features
+- **Multiple Effects**
+  - Couple effects (e.g., specific CO2 costs) and set constraints (e.g., max CO2 emissions).
+  - Easily switch between optimization targets (e.g., minimize CO2 or costs).
+  - This allows to solve questions like "How much does it cost to reduce CO2 emissions by 20%?"
+
+- **Advanced Time Handling**
+  - Non-equidistant timesteps supported.  
+  - Energy prices or effects in general can always be defined per hour (or per MWh...)
+
+  - A variety of predefined constraints for operational and investment optimization can be applied.
+  - Many of these are optional and only applied when necessary, keeping the amount o variables and equations low.
+
+---
+
+## 🖥️ Usage Example
+![Usage Example](https://github.com/user-attachments/assets/fa0e12fa-2853-4f51-a9e2-804abbefe20c)
+
+**Plotting examples**:
+![flixOpt plotting](/pics/flixOpt_plotting.jpg)
+
+## ⚙️ Calculation Modes
+
+flixOpt offers three calculation modes, tailored to different performance and accuracy needs:
+
+- **Full Mode**  
+  - Provides exact solutions with high computational requirements.  
+  - Recommended for detailed analyses and investment decision problems.
+
+- **Segmented Mode**  
+  - Solving a Model segmentwise, this mode can speed up the solving process for complex systems, while being fairly accurate.
+  - Utilizes variable time overlap to improve accuracy.
+  - Not suitable for large storage systems or investment decisions.
+
+- **Aggregated Mode**  
+  - Automatically generates typical periods using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam).  
+  - Balances speed and accuracy, making it ideal for large-scale simulations.
+
+
+## 🏗️ Architecture
+
+- **Minimal coupling to Pyomo**
+  - Included independent module is used to organize variables and equations, independently of a specific modeling language.
+  - While currently only working with [Pyomo](http://www.pyomo.org/), flixOpt is designed to work with different modeling languages with minor modifications ([cvxpy](https://www.cvxpy.org)).
+
+- **File-based Post-Processing Unit**
+  - Results are saved to .json and .yaml files for easy access and analysis anytime.
+  - Internal plotting functions utilizing matplotlib, plotly and pandas simplify results visualization and reporting.
+
+![Architecture Diagram](/pics/architecture_flixOpt.png)
+
+---
+
+## 🛠️ 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:  
+
+- [CBC](https://github.com/coin-or/Cbc)  
+- [GLPK](https://www.gnu.org/software/glpk/)  
+- [Gurobi](https://www.gurobi.com/)  
+- [CPLEX](https://www.ibm.com/analytics/cplex-optimizer)
+
+Executables can be found for example [here for CBC](https://portal.ampl.com/dl/open/cbc/) and [here for GLPK](https://sourceforge.net/projects/winglpk/) (Windows: You have to put solver-executables to the PATH-variable)
+
+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)  
+
+---
+
+## 🔧 Development and Testing
+
+Run the tests using:  
+
+```bash
+python -m unittest discover -s tests

flixopt-1.0.12/README.md

@@ -0,0 +1,134 @@
+# flixOpt: Energy and Material Flow Optimization Framework
+
+**flixOpt** is a Python-based optimization framework designed to tackle energy and material flow problems using mixed-integer linear programming (MILP). Combining flexibility and efficiency, it provides a powerful platform for both dispatch and investment optimization challenges.
+
+---
+
+## 🚀 Introduction
+
+flixOpt was 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). 
+
+Although flixOpt is in its early stages, it is fully functional and ready for experimentation. It is used for investment and operation decisions by energy providing companys as well as research institutions. Feedback and collaboration are highly encouraged to help shape its future.
+
+---
+
+## 📦 Installation
+
+Install flixOpt directly into your environment using pip. Thanks to [HiGHS](https://github.com/ERGO-Code/HiGHS?tab=readme-ov-file), flixOpt can be used without further setup.
+`pip install git+https://github.com/flixOpt/flixopt.git`
+
+We recommend installing flixOpt with all dependencies, which enables interactive network visualizations by [pyvis](https://github.com/WestHealth/pyvis) and time series aggregation by [tsam](https://github.com/FZJ-IEK3-VSA/tsam).
+`pip install "flixOpt[full] @ git+https://github.com/flixOpt/flixopt.git"`
+
+---
+
+## 🌟 Key Features and Concepts
+
+### 💡 High-level Interface...
+  - flixOpt aims to provide a user-friendly interface for defining and solving energy systems, without sacrificing fine-grained control where necessary.
+  - This is achieved through a high-level interface with many optional or default parameters.
+  - The most important concepts are:
+    - **FlowSystem**: Represents the System that is modeled.
+    - **Flow**: A Flow represents a stream of matter or energy. In an Energy-System, it could be electricity [kW]
+    - **Bus**: A Bus represents a balancing node in the Energy-System, typically connecting a demand to a supply.
+    - **Component**: A Component is a physical entity that consumes or produces matter or energy. It can also transform matter or energy into other kinds of matter or energy.
+    - **Effect**: Flows and Components can have Effects, related to their usage (or size). Common effects are *costs*, *CO2-emissions*, *primary-energy-demand* or *area-demand*. One Effect is used as the optimization target. The others can be constrained.
+  - To simplify the modeling process, high-level **Components** (CHP, Boiler, Heat Pump, Cooling Tower, Storage, etc.) are availlable.
+
+### 🎛️ ...with low-level control
+- **Segmented Linear Correlations**  
+  - Accurate modeling for efficiencies, investment effects, and sizes.
+- **On/Off Variables**
+  - Modeling On/Off-Variables and their constraints.
+    - On-Hours/Off-Hours
+    - Consecutive On-Hours/ Off-Hours
+    - Switch On/Off
+
+### 💰 Investment Optimization
+- flixOpt combines dispatch optimization with investment optimization in one model.
+- Size and/or discrete investment decisions can be modeled
+- Investment decisions can be combined with Modeling On/Off-Variables and their constraints
+
+### Further Features
+- **Multiple Effects**
+  - Couple effects (e.g., specific CO2 costs) and set constraints (e.g., max CO2 emissions).
+  - Easily switch between optimization targets (e.g., minimize CO2 or costs).
+  - This allows to solve questions like "How much does it cost to reduce CO2 emissions by 20%?"
+
+- **Advanced Time Handling**
+  - Non-equidistant timesteps supported.  
+  - Energy prices or effects in general can always be defined per hour (or per MWh...)
+
+  - A variety of predefined constraints for operational and investment optimization can be applied.
+  - Many of these are optional and only applied when necessary, keeping the amount o variables and equations low.
+
+---
+
+## 🖥️ Usage Example
+![Usage Example](https://github.com/user-attachments/assets/fa0e12fa-2853-4f51-a9e2-804abbefe20c)
+
+**Plotting examples**:
+![flixOpt plotting](/pics/flixOpt_plotting.jpg)
+
+## ⚙️ Calculation Modes
+
+flixOpt offers three calculation modes, tailored to different performance and accuracy needs:
+
+- **Full Mode**  
+  - Provides exact solutions with high computational requirements.  
+  - Recommended for detailed analyses and investment decision problems.
+
+- **Segmented Mode**  
+  - Solving a Model segmentwise, this mode can speed up the solving process for complex systems, while being fairly accurate.
+  - Utilizes variable time overlap to improve accuracy.
+  - Not suitable for large storage systems or investment decisions.
+
+- **Aggregated Mode**  
+  - Automatically generates typical periods using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam).  
+  - Balances speed and accuracy, making it ideal for large-scale simulations.
+
+
+## 🏗️ Architecture
+
+- **Minimal coupling to Pyomo**
+  - Included independent module is used to organize variables and equations, independently of a specific modeling language.
+  - While currently only working with [Pyomo](http://www.pyomo.org/), flixOpt is designed to work with different modeling languages with minor modifications ([cvxpy](https://www.cvxpy.org)).
+
+- **File-based Post-Processing Unit**
+  - Results are saved to .json and .yaml files for easy access and analysis anytime.
+  - Internal plotting functions utilizing matplotlib, plotly and pandas simplify results visualization and reporting.
+
+![Architecture Diagram](/pics/architecture_flixOpt.png)
+
+---
+
+## 🛠️ 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:  
+
+- [CBC](https://github.com/coin-or/Cbc)  
+- [GLPK](https://www.gnu.org/software/glpk/)  
+- [Gurobi](https://www.gurobi.com/)  
+- [CPLEX](https://www.ibm.com/analytics/cplex-optimizer)
+
+Executables can be found for example [here for CBC](https://portal.ampl.com/dl/open/cbc/) and [here for GLPK](https://sourceforge.net/projects/winglpk/) (Windows: You have to put solver-executables to the PATH-variable)
+
+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)  
+
+---
+
+## 🔧 Development and Testing
+
+Run the tests using:  
+
+```bash
+python -m unittest discover -s tests

flixopt-1.0.12/examples/00_Minmal/minimal_example.py

@@ -0,0 +1,67 @@
+"""
+This script shows how to use the flixOpt framework to model a super minimalistic energy system.
+"""
+
+import numpy as np
+from rich.pretty import pprint
+
+import flixOpt as fx
+
+if __name__ == '__main__':
+    # --- Define Thermal Load Profile ---
+    # Load profile (e.g., kW) for heating demand over time
+    thermal_load_profile = np.array([30, 0, 20])
+    datetime_series = fx.create_datetime_array('2020-01-01', 3, 'h')
+
+    # --- Define Energy Buses ---
+    # These represent the different energy carriers in the system
+    electricity_bus = fx.Bus('Electricity')
+    heat_bus = fx.Bus('District Heating')
+    fuel_bus = fx.Bus('Natural Gas')
+
+    # --- Define Objective Effect (Cost) ---
+    # Cost effect representing the optimization objective (minimizing costs)
+    cost_effect = fx.Effect('costs', '€', 'Cost', is_standard=True, is_objective=True)
+
+    # --- Define Flow System Components ---
+    # Boiler component with thermal output (heat) and fuel input (gas)
+    boiler = fx.linear_converters.Boiler(
+        'Boiler',
+        eta=0.5,
+        Q_th=fx.Flow(label='Thermal Output', bus=heat_bus, size=50),
+        Q_fu=fx.Flow(label='Fuel Input', bus=fuel_bus),
+    )
+
+    # Heat load component with a fixed thermal demand profile
+    heat_load = fx.Sink(
+        'Heat Demand',
+        sink=fx.Flow(label='Thermal Load', bus=heat_bus, size=1, fixed_relative_profile=thermal_load_profile),
+    )
+
+    # Gas source component with cost-effect per flow hour
+    gas_source = fx.Source(
+        'Natural Gas Tariff',
+        source=fx.Flow(label='Gas Flow', bus=fuel_bus, size=1000, effects_per_flow_hour=0.04),  # 0.04 €/kWh
+    )
+
+    # --- Build the Flow System ---
+    # Add all components and effects to the system
+    flow_system = fx.FlowSystem(datetime_series)
+    flow_system.add_elements(cost_effect, boiler, heat_load, gas_source)
+
+    # --- Define and Run Calculation ---
+    calculation = fx.FullCalculation('Simulation1', flow_system)
+    calculation.do_modeling()
+
+    # --- Solve the Calculation and Save Results ---
+    calculation.solve(fx.solvers.HighsSolver(), save_results=True)
+
+    # --- Load and Analyze Results ---
+    # Load results and plot the operation of the District Heating Bus
+    results = fx.results.CalculationResults(calculation.name, folder='results')
+    results.plot_operation('District Heating', 'area')
+
+    # Print results to the console. Check Results in file or perform more plotting
+    pprint(calculation.results())
+    pprint('Look into .yaml and .json file for results')
+    pprint(calculation.system_model.main_results)

flixopt-1.0.12/examples/01_Simple/simple_example.py

@@ -0,0 +1,120 @@
+"""
+THis script shows how to use the flixOpt framework to model a simple energy system.
+"""
+
+import numpy as np
+from rich.pretty import pprint  # Used for pretty printing
+
+import flixOpt as fx
+
+if __name__ == '__main__':
+    # --- Create Time Series Data ---
+    # Heat demand profile (e.g., kW) over time and corresponding power prices
+    heat_demand_per_h = np.array([30, 0, 90, 110, 110, 20, 20, 20, 20])
+    power_prices = 1 / 1000 * np.array([80, 80, 80, 80, 80, 80, 80, 80, 80])
+
+    # Create datetime array starting from '2020-01-01' for the given time period
+    time_series = fx.create_datetime_array('2020-01-01', len(heat_demand_per_h))
+
+    # --- Define Energy Buses ---
+    # These represent nodes, where the used medias are balanced (electricity, heat, and gas)
+    Strom, Fernwaerme, Gas = fx.Bus(label='Strom'), fx.Bus(label='Fernwärme'), fx.Bus(label='Gas')
+
+    # --- Define Effects (Objective and CO2 Emissions) ---
+    # Cost effect: used as the optimization objective --> minimizing costs
+    costs = fx.Effect(
+        label='costs',
+        unit='€',
+        description='Kosten',
+        is_standard=True,  # standard effect: no explicit value needed for costs
+        is_objective=True,  # Minimizing costs as the optimization objective
+    )
+
+    # CO2 emissions effect with an associated cost impact
+    CO2 = fx.Effect(
+        label='CO2',
+        unit='kg',
+        description='CO2_e-Emissionen',
+        specific_share_to_other_effects_operation={costs: 0.2},
+        maximum_operation_per_hour=1000,  # Max CO2 emissions per hour
+    )
+
+    # --- Define Flow System Components ---
+    # Boiler: Converts fuel (gas) into thermal energy (heat)
+    boiler = fx.linear_converters.Boiler(
+        label='Boiler',
+        eta=0.5,
+        Q_th=fx.Flow(label='Q_th', bus=Fernwaerme, size=50, relative_minimum=0.1, relative_maximum=1),
+        Q_fu=fx.Flow(label='Q_fu', bus=Gas),
+    )
+
+    # Combined Heat and Power (CHP): Generates both electricity and heat from fuel
+    chp = fx.linear_converters.CHP(
+        label='CHP',
+        eta_th=0.5,
+        eta_el=0.4,
+        P_el=fx.Flow('P_el', bus=Strom, size=60, relative_minimum=5 / 60),
+        Q_th=fx.Flow('Q_th', bus=Fernwaerme),
+        Q_fu=fx.Flow('Q_fu', bus=Gas),
+    )
+
+    # Storage: Energy storage system with charging and discharging capabilities
+    storage = fx.Storage(
+        label='Storage',
+        charging=fx.Flow('Q_th_load', bus=Fernwaerme, size=1000),
+        discharging=fx.Flow('Q_th_unload', bus=Fernwaerme, size=1000),
+        capacity_in_flow_hours=fx.InvestParameters(fix_effects=20, fixed_size=30, optional=False),
+        initial_charge_state=0,  # Initial storage state: empty
+        relative_maximum_charge_state=1 / 100 * np.array([80, 70, 80, 80, 80, 80, 80, 80, 80, 80]),
+        eta_charge=0.9,
+        eta_discharge=1,  # Efficiency factors for charging/discharging
+        relative_loss_per_hour=0.08,  # 8% loss per hour. Absolute loss depends on current charge state
+        prevent_simultaneous_charge_and_discharge=True,  # Prevent charging and discharging at the same time
+    )
+
+    # Heat Demand Sink: Represents a fixed heat demand profile
+    heat_sink = fx.Sink(
+        label='Heat Demand',
+        sink=fx.Flow(label='Q_th_Last', bus=Fernwaerme, size=1, fixed_relative_profile=heat_demand_per_h),
+    )
+
+    # Gas Source: Gas tariff source with associated costs and CO2 emissions
+    gas_source = fx.Source(
+        label='Gastarif',
+        source=fx.Flow(label='Q_Gas', bus=Gas, size=1000, effects_per_flow_hour={costs: 0.04, CO2: 0.3}),
+    )
+
+    # Power Sink: Represents the export of electricity to the grid
+    power_sink = fx.Sink(
+        label='Einspeisung', sink=fx.Flow(label='P_el', bus=Strom, effects_per_flow_hour=-1 * power_prices)
+    )
+
+    # --- Build the Flow System ---
+    # Create the flow system and add all defined components and effects
+    flow_system = fx.FlowSystem(time_series=time_series)
+    flow_system.add_elements(costs, CO2, boiler, storage, chp, heat_sink, gas_source, power_sink)
+
+    # Visualize the flow system for validation purposes
+    flow_system.visualize_network()
+
+    # --- Define and Run Calculation ---
+    # Create a calculation object to model the Flow System
+    calculation = fx.FullCalculation(name='Sim1', flow_system=flow_system)
+    calculation.do_modeling()  # Translate the model to a solvable form, creating equations and Variables
+
+    # --- Solve the Calculation and Save Results ---
+    calculation.solve(fx.solvers.HighsSolver(), save_results=True)
+
+    # --- Load and Analyze Results ---
+    # Load the results and plot the operation of the District Heating Bus
+    results = fx.results.CalculationResults(calculation.name, folder='results')
+    results.plot_operation('Fernwärme', 'area')
+    results.plot_storage('Storage')
+    results.plot_operation('Fernwärme', 'bar')
+    results.plot_operation('Fernwärme', 'line')
+    results.plot_operation('CHP__Q_th', 'line')
+    results.plot_operation('CHP__Q_th', 'heatmap')
+
+    # Convert the results for the storage component to a dataframe and display
+    results.to_dataframe('Storage')
+    pprint(results.all_results)