flixopt 2.1.7__tar.gz → 2.1.9__tar.gz

{flixopt-2.1.7 → flixopt-2.1.9}/.github/workflows/python-app.yaml

@@ -2,12 +2,15 @@ name: Python Package CI/CD
 
 on:
   push:
-    branches: [main, dev]  # Added develop branch
-    tags:
-      - 'v*.*.*'  # Trigger on semantic version tags
+    branches: [main]        # Only main branch
+    tags: ['v*.*.*']
   pull_request:
-    branches: [main, dev, 'feature/*', 'hotfix/*', 'fix/*']
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
+      - 'README*'
   workflow_dispatch:  # Allow manual triggering
 
 # Set permissions for security
@@ -24,39 +27,40 @@ env:
 
 jobs:
   lint:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Check out code
         uses: actions/checkout@v5
 
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "0.8.19"
+          enable-cache: true
+
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-          cache: 'pip'
-          cache-dependency-path: |
-            pyproject.toml
 
       - name: Install Ruff
         run: |
-          python -m pip install --upgrade pip
-          pip install "ruff==0.9.*"
-          ruff --version
+          uvx ruff --version
 
       - name: Run Ruff Linting
         run: |
           echo "::group::Ruff Linting"
-          ruff check . --output-format=github
+          uvx ruff check . --output-format=github
           echo "::endgroup::"
 
       - name: Run Ruff Formatting Check
         run: |
           echo "::group::Ruff Formatting"
-          ruff format --check --diff .
+          uvx ruff format --check --diff .
           echo "::endgroup::"
 
   test:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     timeout-minutes: 30
     needs: lint  # Run tests only after linting passes
     strategy:
@@ -68,49 +72,49 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v5
 
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "0.8.19"
+          enable-cache: true
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'pip'
-          cache-dependency-path: |
-            pyproject.toml
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install .[dev] pytest-xdist
+          uv pip install --system .[dev] "pytest-xdist==3.*"
 
       - name: Run tests
         run: pytest -v -p no:warnings --numprocesses=auto
 
   security:
     name: Security Scan
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     needs: lint
     steps:
       - name: Check out code
         uses: actions/checkout@v5
 
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "0.8.19"
+          enable-cache: true
+
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-          cache: 'pip'
-          cache-dependency-path: |
-            pyproject.toml
-
-      - name: Install security tools
-        run: |
-          python -m pip install --upgrade pip
-          pip install bandit[toml]
 
       - name: Run Bandit security scan
         run: |
           # Gate on HIGH severity & MEDIUM confidence; produce JSON artifact
-          bandit -r flixopt/ -c pyproject.toml -f json -o bandit-report.json -q -lll -ii
+          uvx bandit -r flixopt/ -c pyproject.toml -f json -o bandit-report.json -q --severity-level high --confidence-level medium
           # Human-readable output without affecting job status
-          bandit -r flixopt/ -c pyproject.toml -q --exit-zero
+          uvx bandit -r flixopt/ -c pyproject.toml -q --exit-zero
 
       - name: Upload security reports
         uses: actions/upload-artifact@v4
@@ -122,7 +126,7 @@ jobs:
 
   create-release:
     name: Create GitHub Release
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     permissions:
       contents: write
     needs: [lint, test, security]
@@ -134,6 +138,12 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "0.8.19"
+          enable-cache: true
+
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
@@ -157,46 +167,54 @@ jobs:
 
   publish-testpypi:
     name: Publish to TestPyPI
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     needs: [test, create-release]  # Run after tests and release creation
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')  # Only on tag push
     environment:
       name: testpypi
       url: https://test.pypi.org/p/flixopt
+    env:
+      SKIP_TESTPYPI_UPLOAD: "false"
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
 
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "0.8.19"
+          enable-cache: true
+
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-          cache: 'pip'
-          cache-dependency-path: |
-            pyproject.toml
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install build setuptools wheel twine
+          uv pip install --system twine
 
       - name: Build the distribution
         run: |
-          python -m build
+          uv build
 
       - name: Upload to TestPyPI
         run: |
-          twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose
+          twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose --skip-existing
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          TWINE_NON_INTERACTIVE: "1"
 
       - name: Test install from TestPyPI
+        if: env.SKIP_TESTPYPI_UPLOAD != 'true'
         run: |
+          set -Eeuo pipefail
           # Create a temporary environment to test installation
-          python -m venv test_env
+          uv venv test_env
           source test_env/bin/activate
+
           # Get project name from pyproject.toml (PEP 621)
           PACKAGE_NAME=$(python - <<'PY'
           import sys, tomllib, pathlib
@@ -204,15 +222,18 @@ jobs:
           print(data["project"]["name"])
           PY
           )
+
           # Extract version from git tag
           VERSION=${GITHUB_REF#refs/tags/v}
+
           # Wait and retry while TestPyPI indexes the package
           INSTALL_SUCCESS=false
-          for d in 15 30 60 120 180 360 720 1080; do
+          for d in 10 20 40 80 120; do
             sleep "$d"
             echo "Attempting to install $PACKAGE_NAME==$VERSION from TestPyPI (retry after ${d}s)..."
+
             # Install specific version and verify it matches
-            if pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ "$PACKAGE_NAME==$VERSION" && \
+            if uv pip install --index-strategy unsafe-best-match --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ "$PACKAGE_NAME==$VERSION" && \
                python -c "from importlib.metadata import version; installed = version('$PACKAGE_NAME'); print(f'Installed: {installed}'); assert '$VERSION' == installed"; then
               INSTALL_SUCCESS=true
               break
@@ -234,7 +255,7 @@ jobs:
 
   publish-pypi:
     name: Publish to PyPI
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     needs: [publish-testpypi]  # Only run after TestPyPI publish succeeds
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')  # Only on tag push
     environment:
@@ -245,35 +266,40 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v5
 
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "0.8.19"
+          enable-cache: true
+
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-          cache: 'pip'
-          cache-dependency-path: |
-            pyproject.toml
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install build setuptools wheel twine
+          uv pip install --system twine
 
       - name: Build the distribution
         run: |
-          python -m build
+          uv build
 
       - name: Upload to PyPI
         run: |
-          twine upload dist/* --verbose
+          twine upload dist/* --verbose --skip-existing
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+          TWINE_NON_INTERACTIVE: "1"
 
       - name: Verify PyPI installation
         run: |
+          set -Eeuo pipefail
           # Create a temporary environment to test installation
-          python -m venv prod_test_env
+          uv venv prod_test_env
           source prod_test_env/bin/activate
+
           # Get project name from pyproject.toml (PEP 621)
           PACKAGE_NAME=$(python - <<'PY'
           import sys, tomllib, pathlib
@@ -281,15 +307,18 @@ jobs:
           print(data["project"]["name"])
           PY
           )
+
           # Extract version from git tag
           VERSION=${GITHUB_REF#refs/tags/v}
+
           # Wait and retry while PyPI indexes the package
           INSTALL_SUCCESS=false
-          for d in 5 10 15 30 60 120 180 360 720 1080; do
+          for d in 10 20 40 80 120; do
             sleep "$d"
             echo "Attempting to install $PACKAGE_NAME==$VERSION from PyPI (retry after ${d}s)..."
+
             # Install specific version and verify it matches
-            if pip install "$PACKAGE_NAME==$VERSION" && \
+            if uv pip install "$PACKAGE_NAME==$VERSION" && \
                python -c "from importlib.metadata import version; installed = version('$PACKAGE_NAME'); print(f'Installed: {installed}'); assert '$VERSION' == installed"; then
               INSTALL_SUCCESS=true
               break
@@ -311,7 +340,7 @@ jobs:
 
   deploy-docs:
     name: Deploy Documentation
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     permissions:
       contents: write
     needs: [publish-pypi]  # Deploy docs after successful PyPI publishing
@@ -323,13 +352,16 @@ jobs:
         with:
           fetch-depth: 0  # Fetch all history for proper versioning
 
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "0.8.19"
+          enable-cache: true
+
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-          cache: 'pip'
-          cache-dependency-path: |
-            pyproject.toml
 
       - name: Sync changelog to docs
         run: |
@@ -338,8 +370,7 @@ jobs:
 
       - name: Install documentation dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install -e ".[docs]"
+          uv pip install --system ".[docs]"
 
       - name: Configure Git Credentials
         run: |

{flixopt-2.1.7 → flixopt-2.1.9}/CHANGELOG.md

@@ -6,23 +6,64 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 <!-- This text won't be rendered
+Note: The CI will automatically append a "What's Changed" section to the changelog.
+This contains all commits, PRs, and contributors.
+Therefore, the Changelog should focus on the user-facing changes.
+Please remove all irrelevant sections before releasing.
 
-## [Unreleased]
-
-### Changed
+## [Unreleased] - ????-??-??
 
 ### Added
 
+### Changed
+
 ### Deprecated
 
+### Removed
+
 ### Fixed
 
 ### Known issues
 
-### Development
+### *Development*
 
 Until here -->
 
+## [2.1.9] - 2025-09-23
+Small Bugfix which was supposed to be fixed in 2.1.8
+
+### Fixed
+- Fix error handling in network visualization if networkx is not installed.
+
+
+## [2.1.8] - 2025-09-22
+This release focuses on code quality improvements, enhanced documentation, and bug fixes for heat pump components and visualization features.
+
+### Added
+- Extra Check for HeatPumpWithSource.COP to be strictly > 1 to avoid division by zero
+- Apply deterministic color assignment by using sorted() in `plotting.py`
+- Add missing args in docstrings in `plotting.py`, `solvers.py`, and `core.py`.
+
+### Changed
+- Greatly improved docstrings and documentation of all public classes
+- Make path handling to be gentle about missing .html suffix in `plotting.py`
+- Default for `relative_losses` in `Transmission` is now 0 instead of None
+- Setter of COP in `HeatPumpWithSource` now completely overwrites the conversion factors, which is safer.
+- Fix some docstrings in plotting.py
+- Change assertions to raise Exceptions in `plotting.py`
+
+### Fixed
+- Fix color scheme selection in network_app; color pickers now update when a scheme is selected.
+- Fix error handling in network visualization if networkx is not installed.
+- Fix broken links in docs.
+- Fix COP getter and setter of `HeatPumpWithSource` returning and setting wrong conversion factors.
+- Fix custom compression levels in `io.save_dataset_to_netcdf`
+- Fix `total_max` did not work when total min was not used.
+
+### *Development*
+- Pin dev dependencies to specific versions
+- Improve CI workflows to run faster and smarter
+
 ## [2.1.7] - 2025-09-13
 
 This update is a maintenance release to improve Code Quality, CI and update the dependencies.
@@ -31,7 +72,7 @@ There are no changes or new features.
 ### Added
 - Added __version__ to flixopt
 
-### Development
+### *Development*
 - ruff format the whole Codebase
 - Added renovate config
 - Added pre-commit

{flixopt-2.1.7/flixopt.egg-info → flixopt-2.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.7
+Version: 2.1.9
 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>
@@ -24,54 +24,58 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy<3,>=1.21.5
 Requires-Dist: pandas<3,>=2.0.0
-Requires-Dist: linopy<0.5.8,>=0.5.7
+Requires-Dist: xarray<2026.0,>=2024.2.0
+Requires-Dist: linopy<0.6,>=0.5.1
 Requires-Dist: netcdf4<2,>=1.6.1
-Requires-Dist: PyYAML<7,>=6.0.0
-Requires-Dist: rich>=13.0.0
-Requires-Dist: tomli>=2.0.1; python_version < "3.11"
-Requires-Dist: highspy>=1.5.3
-Requires-Dist: matplotlib<4.0.0,>=3.5.2
-Requires-Dist: plotly<6.0.0,>=5.15.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
 Provides-Extra: network-viz
-Requires-Dist: dash>=3.0.0; extra == "network-viz"
-Requires-Dist: dash-cytoscape>=1.0.0; extra == "network-viz"
-Requires-Dist: dash-daq>=0.6.0; extra == "network-viz"
-Requires-Dist: networkx>=3.0.0; extra == "network-viz"
-Requires-Dist: werkzeug>=3.0.0; 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.0.0,>=2.3.1; extra == "full"
-Requires-Dist: scipy<2.0.0,>=1.15.1; extra == "full"
-Requires-Dist: gurobipy>=10.0.0; extra == "full"
-Requires-Dist: dash>=3.0.0; extra == "full"
-Requires-Dist: dash-cytoscape>=1.0.0; extra == "full"
-Requires-Dist: dash-daq>=0.6.0; extra == "full"
-Requires-Dist: networkx>=3.0.0; extra == "full"
-Requires-Dist: werkzeug>=3.0.0; 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>=7.0.0; extra == "dev"
-Requires-Dist: ruff>=0.9.0; extra == "dev"
-Requires-Dist: pre-commit>=4.0.0; extra == "dev"
+Requires-Dist: pytest==8.4.2; extra == "dev"
+Requires-Dist: nbformat==5.10.4; extra == "dev"
+Requires-Dist: ruff==0.13.0; extra == "dev"
+Requires-Dist: pre-commit==4.3.0; extra == "dev"
 Requires-Dist: pyvis==0.3.2; extra == "dev"
-Requires-Dist: tsam<3.0.0,>=2.3.1; extra == "dev"
-Requires-Dist: scipy<2.0.0,>=1.15.1; extra == "dev"
-Requires-Dist: gurobipy>=10.0.0; extra == "dev"
-Requires-Dist: dash>=3.0.0; extra == "dev"
-Requires-Dist: dash-cytoscape>=1.0.0; 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"
+Requires-Dist: tsam==2.3.1; 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<10,>=9.0.0; extra == "docs"
-Requires-Dist: mkdocstrings-python>=1.0.0; extra == "docs"
-Requires-Dist: mkdocs-table-reader-plugin>=2.0.0; extra == "docs"
-Requires-Dist: mkdocs-gen-files>=0.4.0; extra == "docs"
-Requires-Dist: mkdocs-include-markdown-plugin>=6.0.0; extra == "docs"
-Requires-Dist: mkdocs-literate-nav>=0.6.0; extra == "docs"
-Requires-Dist: markdown-include>=0.8.0; extra == "docs"
-Requires-Dist: pymdown-extensions>=10.0.0; extra == "docs"
-Requires-Dist: pygments>=2.14.0; extra == "docs"
-Requires-Dist: mike>=2.0.0; extra == "docs"
+Requires-Dist: mkdocs-material==9.6.19; 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

{flixopt-2.1.7 → flixopt-2.1.9}/docs/SUMMARY.md

@@ -3,5 +3,5 @@
 - [User Guide](user-guide/)
 - [Examples](examples/)
 - [Contribute](contribute.md)
-- [API-Reference](api-reference/)
+- [API Reference](api-reference/)
 - [Release Notes](changelog.md)

{flixopt-2.1.7 → flixopt-2.1.9}/docs/getting-started.md

@@ -19,7 +19,7 @@ This provides the core functionality with the HiGHS solver included.
 For all features including interactive network visualizations and time series aggregation:
 
 ```bash
-pip install "flixopt[full]""
+pip install "flixopt[full]"
 ```
 
 ## Basic Workflow
@@ -38,5 +38,5 @@ Working with FlixOpt follows a general pattern:
 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/)
+- Explore some [examples](examples/index.md)
 - Check the [API reference](api-reference/index.md) for detailed documentation

{flixopt-2.1.7 → flixopt-2.1.9}/docs/user-guide/Mathematical Notation/Effects, Penalty & Objective.md

@@ -1,15 +1,15 @@
 ## Effects
-[`Effects`][flixopt.effects.Effect] are used to allocate things like costs, emissions, or other "effects" occuring in the system.
+[`Effects`][flixopt.effects.Effect] are used to allocate things like costs, emissions, or other "effects" occurring in the system.
 These arise from so called **Shares**, which originate from **Elements** like [Flows](Flow.md).
 
 **Example:**
 
 [`Flows`][flixopt.elements.Flow] have an attribute called `effects_per_flow_hour`, defining the effect amount of per flow hour.
-Assiziated effects could be:
+Associated effects could be:
 - costs - given in [€/kWh]...
 - ...or emissions - given in [kg/kWh].
 -
-Effects are allocated seperatly for investments and operation.
+Effects are allocated separately for investments and operation.
 
 ### Shares to Effects
 
@@ -43,7 +43,7 @@ For example, the Effect "CO$_2$ emissions" (unit: kg)
 can cause an additional share to Effect "monetary costs" (unit: €).
 In this case, the factor $\text a_{x \rightarrow e}$ is the specific CO$_2$ price in €/kg. However, circular references have to be avoided.
 
-The overall sum of investment shares of an Effect $e$ is given by $\eqref{Effect_invest}$
+The overall sum of investment shares of an Effect $e$ is given by $\eqref{eq:Effect_invest}$
 
 $$ \label{eq:Effect_invest}
 E_{e, \text{inv}} =
@@ -68,8 +68,8 @@ With:
 
 - $\mathcal{L}$ being the set of all elements in the FlowSystem
 - $\mathcal{E}$ being the set of all effects in the FlowSystem
-- $\text r_{x \rightarrow e, \text{inv}}$ being the factor between the operation part of Effect $x$ and Effect $e$
-- $\text r_{x \rightarrow e, \text{op}}(\text{t}_i)$ being the factor between the invest part of Effect $x$ and Effect $e$
+- $\text r_{x \rightarrow e, \text{inv}}$ being the factor between the invest part of Effect $x$ and Effect $e$
+- $\text r_{x \rightarrow e, \text{op}}(\text{t}_i)$ being the factor between the operation part of Effect $x$ and Effect $e$
 
 - $\text{t}_i$ being the time step
 - $s_{l \rightarrow e, \text{inv}}$ being the share of element $l$ to the investment part of effect $e$
@@ -113,7 +113,7 @@ With:
 - $\mathcal{T}$ being the set of all timesteps
 - $s_{l \rightarrow \Phi}$ being the share of element $l$ to the penalty
 
-At the moment, penalties only occur in [Buses](#buses)
+At the moment, penalties only occur in [Buses](Bus.md)
 
 ## Objective
 
@@ -128,5 +128,5 @@ With:
 - $\Phi$ being the [Penalty](#penalty)
 
 This approach allows for a multi-criteria optimization using both...
- - ... the **Weigted Sum**Method, as the chosen **Objective Effect** can incorporate other Effects.
+ - ... the **Weighted Sum** method, as the chosen **Objective Effect** can incorporate other Effects.
  - ... the ($\epsilon$-constraint method) by constraining effects.

{flixopt-2.1.7 → flixopt-2.1.9}/docs/user-guide/Mathematical Notation/Flow.md

@@ -21,6 +21,6 @@ $$
 $$
 
 
-This mathematical Formulation can be extended or changed when using [OnOffParameters](#onoffparameters)
-to define the On/Off state of the Flow, or [InvestParameters](#investments),
-which changes the size of the Flow from a constant to an optimization variable.
+This mathematical formulation can be extended by using [OnOffParameters](./OnOffParameters.md)
+to define the on/off state of the Flow, or by using [InvestParameters](./InvestParameters.md)
+to change the size of the Flow from a constant to an optimization variable.

flixopt-2.1.9/docs/user-guide/Mathematical Notation/InvestParameters.md

@@ -0,0 +1,3 @@
+# InvestParameters
+
+This is a work in progress.

{flixopt-2.1.7 → flixopt-2.1.9}/docs/user-guide/Mathematical Notation/LinearConverter.md

@@ -1,4 +1,4 @@
-[`LinearConverters`][flixopt.components.LinearConverter] define a ratio between incoming and outgoing [Flows](#flows).
+[`LinearConverters`][flixopt.components.LinearConverter] define a ratio between incoming and outgoing [Flows](Flow.md).
 
 $$ \label{eq:Linear-Transformer-Ratio}
     \sum_{f_{\text{in}} \in \mathcal F_{in}} \text a_{f_{\text{in}}}(\text{t}_i) \cdot p_{f_\text{in}}(\text{t}_i) = \sum_{f_{\text{out}} \in \mathcal F_{out}}  \text b_{f_\text{out}}(\text{t}_i) \cdot p_{f_\text{out}}(\text{t}_i)
@@ -16,6 +16,6 @@ $$ \label{eq:Linear-Transformer-Ratio-simple}
     \text a(\text{t}_i) \cdot p_{f_\text{in}}(\text{t}_i) = p_{f_\text{out}}(\text{t}_i)
 $$
 
-where $\text a$ can be interpreted as the conversion efficiency of the **LinearTransformer**.
-#### Piecewise Concersion factors
+where $\text a$ can be interpreted as the conversion efficiency of the **LinearConverter**.
+#### Piecewise Conversion factors
 The conversion efficiency can be defined as a piecewise linear approximation. See [Piecewise](Piecewise.md) for more details.

flixopt-2.1.9/docs/user-guide/Mathematical Notation/OnOffParameters.md

@@ -0,0 +1,3 @@
+# OnOffParameters
+
+This is a work in progress.

{flixopt-2.1.7 → flixopt-2.1.9}/docs/user-guide/Mathematical Notation/Storage.md

@@ -1,5 +1,5 @@
 # Storages
-**Storages** have one incoming and one outgoing **[Flow](#flows)** with a charging and discharging efficiency.
+**Storages** have one incoming and one outgoing **[Flow](Flow.md)** with a charging and discharging efficiency.
 A storage has a state of charge $c(\text{t}_i)$ which is limited by its `size` $\text C$ and relative bounds $\eqref{eq:Storage_Bounds}$.
 
 $$ \label{eq:Storage_Bounds}