flixopt 2.1.8__tar.gz → 2.1.10__tar.gz

{flixopt-2.1.8 → flixopt-2.1.10}/.github/workflows/python-app.yaml

@@ -85,11 +85,40 @@ jobs:
 
       - name: Install dependencies
         run: |
-          uv pip install --system .[dev] "pytest-xdist==3.*"
+          uv pip install --system .[dev]
 
       - name: Run tests
         run: pytest -v -p no:warnings --numprocesses=auto
 
+  test-examples:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 45
+    needs: lint
+    # Only run examples on releases (tags)
+    if: startsWith(github.ref, 'refs/tags/v')
+
+    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 ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install dependencies
+        run: |
+          uv pip install --system .[dev]
+
+      - name: Run example tests
+        run: pytest -v -p no:warnings -m examples
+
   security:
     name: Security Scan
     runs-on: ubuntu-24.04
@@ -129,7 +158,7 @@ jobs:
     runs-on: ubuntu-24.04
     permissions:
       contents: write
-    needs: [lint, test, security]
+    needs: [lint, test, test-examples, security]
     if: startsWith(github.ref, 'refs/tags/v')
 
     steps:
@@ -168,7 +197,7 @@ jobs:
   publish-testpypi:
     name: Publish to TestPyPI
     runs-on: ubuntu-24.04
-    needs: [test, create-release]  # Run after tests and release creation
+    needs: [test, test-examples, 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
@@ -313,7 +342,7 @@ jobs:
 
           # Wait and retry while PyPI indexes the package
           INSTALL_SUCCESS=false
-          for d in 10 20 40 80 120; do
+          for d in 10 20 40 80 120 240 480; do
             sleep "$d"
             echo "Attempting to install $PACKAGE_NAME==$VERSION from PyPI (retry after ${d}s)..."
 
@@ -363,10 +392,15 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
-      - name: Sync changelog to docs
+      - name: Extract changelog to docs
         run: |
-          cp CHANGELOG.md docs/changelog.md
-          echo "✅ Synced changelog to docs"
+          # Install packaging dependency for changelog extraction
+          uv pip install --system packaging
+
+          # Extract individual release files
+          python scripts/extract_changelog.py
+
+          echo "✅ Extracted changelog to docs/changelog/"
 
       - name: Install documentation dependencies
         run: |

flixopt-2.1.10/CHANGELOG.md

@@ -0,0 +1,286 @@
+# Changelog
+
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+Formatting is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) & [Gitmoji](https://gitmoji.dev).
+For more details regarding the individual PRs and contributors, please refer to our [GitHub releases](https://github.com/flixOpt/flixopt/releases).
+
+<!-- This text won't be rendered
+Note: The CI will automatically append a "What's Changed" section to the changelog for github releases.
+This contains all commits, PRs, and contributors.
+Therefore, the Changelog should focus on the user-facing changes.
+
+Please remove all irrelevant sections before releasing.
+Please keep the format of the changelog consistent with the other releases, so the extraction for mkdocs works.
+---
+
+## [Template] - ????-??-??
+
+### ✨ Added
+
+### 💥 Breaking Changes
+
+### ♻️ Changed
+
+### 🗑️ Deprecated
+
+### 🔥 Removed
+
+### 🐛 Fixed
+
+### 🔒 Security
+
+### 📦 Dependencies
+
+### 📝 Docs
+
+### 👷 Development
+
+### 🚧 Known Issues
+
+---
+
+## [Unreleased] - ????-??-??
+
+### ✨ Added
+
+### 💥 Breaking Changes
+
+### ♻️ Changed
+
+### 🗑️ Deprecated
+
+### 🔥 Removed
+
+### 🐛 Fixed
+
+### 🔒 Security
+
+### 📦 Dependencies
+
+### 📝 Docs
+- Improved CHANGELOG.md formatting by adding better categories and formating by Gitmoji.
+- Added a script to extract the release notes from the CHANGELOG.md file for better organized documentation.
+
+### 👷 Development
+
+### 🚧 Known Issues
+
+Until here -->
+---
+
+## [2.1.10] - 2025-09-29
+**Summary:** This release is a Documentation and Development release.
+
+### 📝 Docs
+- Improved CHANGELOG.md formatting by adding better categories and formating by Gitmoji.
+- Added a script to extract the release notes from the CHANGELOG.md file for better organized documentation.
+
+### 👷 Development
+- Improved `renovate.config`
+- Sped up CI by not running examples in every run and using `pytest-xdist`
+
+---
+
+## [2.1.9] - 2025-09-23
+
+**Summary:** Small bugfix release addressing network visualization error handling.
+
+### 🐛 Fixed
+- Fix error handling in network visualization if `networkx` is not installed
+
+---
+
+## [2.1.8] - 2025-09-22
+
+**Summary:** 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
+
+**Core Components:**
+- 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
+
+**Visualization:**
+- Fix color scheme selection in network_app; color pickers now update when a scheme is selected
+
+### 📝 Docs
+- Fix broken links in docs
+- Fix some docstrings in plotting.py
+
+### 👷 Development
+- Pin dev dependencies to specific versions
+- Improve CI workflows to run faster and smarter
+
+---
+
+## [2.1.7] - 2025-09-13
+
+**Summary:** Maintenance release to improve Code Quality, CI and update the dependencies. There are no changes or new features.
+
+### ✨ Added
+- Added `__version__` to flixopt
+
+### 👷 Development
+- ruff format the whole Codebase
+- Added renovate config
+- Added pre-commit
+- lint and format in CI
+- improved CI
+- Updated Dependencies
+- Updated Issue Templates
+
+---
+
+## [2.1.6] - 2025-09-02
+
+**Summary:** Enhanced Sink/Source components with multi-flow support and new interactive network visualization.
+
+### ✨ Added
+- **Network Visualization**: Added `FlowSystem.start_network_app()` and `FlowSystem.stop_network_app()` to easily visualize the network structure of a flow system in an interactive Dash web app
+  - *Note: This is still experimental and might change in the future*
+
+### ♻️ Changed
+- **Multi-Flow Support**: `Sink`, `Source`, and `SourceAndSink` now accept multiple `flows` as `inputs` and `outputs` instead of just one. This enables modeling more use cases with these classes
+- **Flow Control**: Both `Sink` and `Source` now have a `prevent_simultaneous_flow_rates` argument to prevent simultaneous flow rates of more than one of their flows
+
+### 🗑️ Deprecated
+- For the classes `Sink`, `Source` and `SourceAndSink`: `.sink`, `.source` and `.prevent_simultaneous_sink_and_source` are deprecated in favor of the new arguments `inputs`, `outputs` and `prevent_simultaneous_flow_rates`
+
+### 🐛 Fixed
+- Fixed testing issue with new `linopy` version 0.5.6
+
+### 👷 Development
+- Added dependency "nbformat>=4.2.0" to dev dependencies to resolve issue with plotly CI
+
+---
+
+## [2.1.5] - 2025-07-08
+
+### 🐛 Fixed
+- Fixed Docs deployment
+
+---
+
+## [2.1.4] - 2025-07-08
+
+### 🐛 Fixed
+- Fixing release notes of 2.1.3, as well as documentation build.
+
+---
+
+## [2.1.3] - 2025-07-08
+
+### 🐛 Fixed
+- Using `Effect.maximum_operation_per_hour` raised an error, needing an extra timestep. This has been fixed thanks to @PRse4.
+
+---
+
+## [2.1.2] - 2025-06-14
+
+### 🐛 Fixed
+- Storage losses per hour were not calculated correctly, as mentioned by @brokenwings01. This might have led to issues when modeling large losses and long timesteps.
+  - Old implementation:     $c(\text{t}_{i}) \cdot (1-\dot{\text{c}}_\text{rel,loss}(\text{t}_i)) \cdot \Delta \text{t}_{i}$
+  - Correct implementation: $c(\text{t}_{i}) \cdot (1-\dot{\text{c}}_\text{rel,loss}(\text{t}_i)) ^{\Delta \text{t}_{i}}$
+
+### 🚧 Known Issues
+- Just to mention: Plotly >= 6 may raise errors if "nbformat" is not installed. We pinned plotly to <6, but this may be fixed in the future.
+
+---
+
+## [2.1.1] - 2025-05-08
+
+### ♻️ Changed
+- Improved docstring and tests
+
+### 🐛 Fixed
+- Fixed bug in the `_ElementResults.constraints` not returning the constraints but rather the variables
+
+---
+## [2.1.0] - 2025-04-11
+
+### ✨ Added
+- Python 3.13 support added
+- Logger warning if relative_minimum is used without on_off_parameters in Flow
+- Greatly improved internal testing infrastructure by leveraging linopy's testing framework
+
+### 💥 Breaking Changes
+- Restructured the modeling of the On/Off state of Flows or Components
+  - Variable renaming: `...|consecutive_on_hours` → `...|ConsecutiveOn|hours`
+  - Variable renaming: `...|consecutive_off_hours` → `...|ConsecutiveOff|hours`
+  - Constraint renaming: `...|consecutive_on_hours_con1` → `...|ConsecutiveOn|con1`
+  - Similar pattern for all consecutive on/off constraints
+
+### 🐛 Fixed
+- Fixed the lower bound of `flow_rate` when using optional investments without OnOffParameters
+- Fixed bug that prevented divest effects from working
+- Added lower bounds of 0 to two unbounded vars (numerical improvement)
+
+---
+
+## [2.0.1] - 2025-04-10
+
+### ✨ Added
+- Logger warning if relative_minimum is used without on_off_parameters in Flow
+
+### 🐛 Fixed
+- Replace "|" with "__" in filenames when saving figures (Windows compatibility)
+- Fixed bug that prevented the load factor from working without InvestmentParameters
+
+## [2.0.0] - 2025-03-29
+
+**Summary:** 💥 **MAJOR RELEASE** - Complete framework migration from Pyomo to Linopy with redesigned architecture.
+
+### ✨ Added
+
+**Model Capabilities:**
+- Full model serialization support - save and restore unsolved Models
+- Enhanced model documentation with YAML export containing human-readable mathematical formulations
+- Extend flixopt models with native linopy language support
+- Full Model Export/Import capabilities via linopy.Model
+
+**Results & Data:**
+- Unified solution exploration through `Calculation.results` attribute
+- Compression support for result files
+- `to_netcdf/from_netcdf` methods for FlowSystem and core components
+- xarray integration for TimeSeries with improved datatypes support
+
+### 💥 Breaking Changes
+
+**Framework Migration:**
+- **Optimization Engine**: Complete migration from Pyomo to Linopy optimization framework
+- **Package Import**: Framework renamed from flixOpt to flixopt (`import flixopt as fx`)
+- **Data Architecture**: Redesigned data handling to rely on xarray.Dataset throughout the package
+- **Results System**: Results handling completely redesigned with new `CalculationResults` class
+
+**Variable Structure:**
+- Restructured the modeling of the On/Off state of Flows or Components
+  - Variable renaming: `...|consecutive_on_hours` → `...|ConsecutiveOn|hours`
+  - Variable renaming: `...|consecutive_off_hours` → `...|ConsecutiveOff|hours`
+  - Constraint renaming: `...|consecutive_on_hours_con1` → `...|ConsecutiveOn|con1`
+  - Similar pattern for all consecutive on/off constraints
+
+### 🔥 Removed
+- **Pyomo dependency** (replaced by linopy)
+- **Period concepts** in time management (simplified to timesteps)
+
+### 🐛 Fixed
+- Improved infeasible model detection and reporting
+- Enhanced time series management and serialization
+- Reduced file size through improved compression
+
+### 📝 Docs
+- Google Style Docstrings throughout the codebase

{flixopt-2.1.8/flixopt.egg-info → flixopt-2.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.8
+Version: 2.1.10
 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>
@@ -53,6 +53,7 @@ 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.0; extra == "dev"
 Requires-Dist: pre-commit==4.3.0; extra == "dev"

{flixopt-2.1.8 → flixopt-2.1.10}/docs/SUMMARY.md

@@ -4,4 +4,4 @@
 - [Examples](examples/)
 - [Contribute](contribute.md)
 - [API Reference](api-reference/)
-- [Release Notes](changelog.md)
+- [Release Notes](changelog/)

{flixopt-2.1.8 → flixopt-2.1.10}/flixopt/network_app.py

@@ -18,14 +18,12 @@ except ImportError as e:
     DASH_CYTOSCAPE_AVAILABLE = False
     VISUALIZATION_ERROR = str(e)
 
-if TYPE_CHECKING:
-    from .flow_system import FlowSystem
-
-import networkx as nx
-
 from .components import LinearConverter, Sink, Source, SourceAndSink, Storage
 from .elements import Bus
 
+if TYPE_CHECKING:
+    from .flow_system import FlowSystem
+
 logger = logging.getLogger('flixopt')
 
 

{flixopt-2.1.8 → flixopt-2.1.10/flixopt.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.8
+Version: 2.1.10
 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>
@@ -53,6 +53,7 @@ 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.0; extra == "dev"
 Requires-Dist: pre-commit==4.3.0; extra == "dev"

{flixopt-2.1.8 → flixopt-2.1.10}/flixopt.egg-info/SOURCES.txt

@@ -76,6 +76,7 @@ pics/architecture_flixOpt.png
 pics/flixOpt_plotting.jpg
 pics/flixopt-icon.svg
 pics/pics.pptx
+scripts/extract_changelog.py
 scripts/extract_release_notes.py
 scripts/gen_ref_pages.py
 tests/__init__.py

{flixopt-2.1.8 → flixopt-2.1.10}/flixopt.egg-info/requires.txt

@@ -14,6 +14,7 @@ tomli<3,>=2.0.1
 
 [dev]
 pytest==8.4.2
+pytest-xdist==3.8.0
 nbformat==5.10.4
 ruff==0.13.0
 pre-commit==4.3.0

{flixopt-2.1.8 → flixopt-2.1.10}/pyproject.toml

@@ -80,6 +80,7 @@ full = [
 # Development tools and testing
 dev = [
     "pytest==8.4.2",
+    "pytest-xdist==3.8.0",
     "nbformat==5.10.4",
     "ruff==0.13.0",
     "pre-commit==4.3.0",
@@ -176,6 +177,13 @@ docstring-code-format = true
 [tool.ruff.lint.pyupgrade]
 keep-runtime-typing = false  # Allow pyupgrade to drop runtime typing; prefer postponed annotations
 
+[tool.pytest.ini_options]
+markers = [
+    "slow: marks tests as slow",
+    "examples: marks example tests (run only on releases)",
+]
+addopts = "-m 'not examples'"  # Skip examples by default
+
 [tool.bandit]
 skips = ["B101", "B506"]  # assert_used and yaml_load
 exclude_dirs = ["tests/"]

{flixopt-2.1.8 → flixopt-2.1.10}/renovate.json

@@ -14,10 +14,18 @@
   "automerge": false,
   "labels": ["dependencies"],
   "rangeStrategy": "widen",
+  "minimumReleaseAge": "7 days",
   "packageRules": [
     {
-      "matchDepTypes": ["dev-dependencies", "devDependencies"],
-      "rangeStrategy": "pin"
+      "matchDepTypes": ["dev", "docs"],
+      "rangeStrategy": "pin",
+      "minimumReleaseAge": "14 days"
+    },
+    {
+      "matchUpdateTypes": ["patch"],
+      "matchCurrentVersion": "!/^0/",
+      "automerge": true,
+      "automergeType": "pr"
     }
   ]
 }

flixopt-2.1.10/scripts/extract_changelog.py

@@ -0,0 +1,148 @@
+#!/usr/bin/env python3
+"""
+Extract individual releases from CHANGELOG.md to docs/changelog/
+Simple script to create one file per release.
+"""
+
+import os
+import re
+from pathlib import Path
+
+from packaging.version import InvalidVersion, Version
+from packaging.version import parse as parse_version
+
+
+def extract_releases():
+    """Extract releases from CHANGELOG.md and save to individual files."""
+
+    changelog_path = Path('CHANGELOG.md')
+    output_dir = Path('docs/changelog')
+
+    if not changelog_path.exists():
+        print('❌ CHANGELOG.md not found')
+        return
+
+    # Create output directory
+    output_dir.mkdir(parents=True, exist_ok=True)
+
+    # Read changelog
+    with open(changelog_path, encoding='utf-8') as f:
+        content = f.read()
+
+    # Remove template section (HTML comments)
+    content = re.sub(r'<!-- This text won\'t be rendered.*?Until here -->', '', content, flags=re.DOTALL)
+
+    # Split by release headers
+    sections = re.split(r'^## \[', content, flags=re.MULTILINE)
+
+    releases = []
+    for section in sections[1:]:  # Skip first empty section
+        # Extract version and date from start of section
+        match = re.match(r'([^\]]+)\] - ([^\n]+)\n(.*)', section, re.DOTALL)
+        if match:
+            version, date, release_content = match.groups()
+            releases.append((version, date.strip(), release_content.strip()))
+
+    print(f'🔍 Found {len(releases)} releases')
+
+    # Sort releases by version (oldest first) to keep existing file prefixes stable.
+    def version_key(release):
+        try:
+            return parse_version(release[0])
+        except InvalidVersion:
+            return parse_version('0.0.0')  # fallback for invalid versions
+
+    releases.sort(key=version_key, reverse=False)
+
+    # Show what we captured for debugging
+    if releases:
+        print(f'🔧 First release content length: {len(releases[0][2])}')
+
+    for i, (version_str, date, release_content) in enumerate(releases):
+        # Clean up version for filename with numeric prefix (newest first)
+        index = 99999 - i  # Newest first, while keeping the same file names for old releases
+        prefix = f'{index:05d}'  # Zero-padded 5-digit number
+        filename = f'{prefix}-v{version_str.replace(" ", "-")}.md'
+        filepath = output_dir / filename
+
+        # Clean up content - remove trailing --- separators and emojis from headers
+        cleaned_content = re.sub(r'\s*---\s*$', '', release_content.strip())
+
+        # Generate navigation links
+        nav_links = []
+
+        # Previous version (older release)
+        if i > 0:
+            prev_index = 99999 - (i - 1)
+            prev_version = releases[i - 1][0]
+            prev_filename = f'{prev_index:05d}-v{prev_version.replace(" ", "-")}.md'
+            nav_links.append(f'← [Previous: {prev_version}]({prev_filename})')
+
+        # Next version (newer release)
+        if i < len(releases) - 1:
+            next_index = 99999 - (i + 1)
+            next_version = releases[i + 1][0]
+            next_filename = f'{next_index:05d}-v{next_version.replace(" ", "-")}.md'
+            nav_links.append(f'[Next: {next_version}]({next_filename}) →')
+
+        # Always add link back to index
+        nav_links.append('[📋 All Releases](index.md)')
+        # Add GitHub tag link only for valid PEP 440 versions (skip e.g. "Unreleased")
+        ver_obj = parse_version(version_str)
+        if isinstance(ver_obj, Version):
+            nav_links.append(f'[🏷️ GitHub Release](https://github.com/flixOpt/flixopt/releases/tag/v{version_str})')
+        # Create content with navigation
+        content_lines = [
+            f'# {version_str} - {date.strip()}',
+            '',
+            ' | '.join(nav_links),
+            '',
+            '---',
+            '',
+            cleaned_content,
+            '',
+            '---',
+            '',
+            ' | '.join(nav_links),
+        ]
+
+        # Write file
+        with open(filepath, 'w', encoding='utf-8') as f:
+            f.write('\n'.join(content_lines))
+
+        print(f'✅ Created {filename}')
+
+    print(f'🎉 Extracted {len(releases)} releases to docs/changelog/')
+
+
+def extract_index():
+    changelog_path = Path('CHANGELOG.md')
+    output_dir = Path('docs/changelog')
+    index_path = output_dir / 'index.md'
+
+    if not changelog_path.exists():
+        print('❌ CHANGELOG.md not found')
+        return
+
+    # Create output directory
+    output_dir.mkdir(parents=True, exist_ok=True)
+
+    # Read changelog
+    with open(changelog_path, encoding='utf-8') as f:
+        content = f.read()
+
+    intro_match = re.search(r'# Changelog\s+([\s\S]*?)(?=<!--)', content)
+    if not intro_match:
+        raise ValueError('Intro section not found before comment block')
+    final_content = intro_match.group(1).strip()
+
+    # Write file
+    with open(index_path, 'w', encoding='utf-8') as f:
+        f.write('\n'.join(['# Changelog\n', final_content]))
+
+    print('✅ Created index.md')
+
+
+if __name__ == '__main__':
+    extract_releases()
+    extract_index()

{flixopt-2.1.8 → flixopt-2.1.10}/tests/test_examples.py

@@ -16,7 +16,7 @@ EXAMPLES_DIR = Path(__file__).parent.parent / 'examples'
     ),  # Sort by parent and script name
     ids=lambda path: str(path.relative_to(EXAMPLES_DIR)),  # Show relative file paths
 )
-@pytest.mark.slow
+@pytest.mark.examples
 def test_example_scripts(example_script):
     """
     Test all example scripts in the examples directory.

flixopt-2.1.8/CHANGELOG.md

@@ -1,181 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-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] - ????-??-??
-
-### Added
-
-### Changed
-
-### Deprecated
-
-### Removed
-
-### Fixed
-
-### Known issues
-
-### *Development*
-
-Until here -->
-
-## [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.
-There are no changes or new features.
-
-### Added
-- Added __version__ to flixopt
-
-### *Development*
-- ruff format the whole Codebase
-- Added renovate config
-- Added pre-commit
-- lint and format in CI
-- improved CI
-- Updated Dependencies
-- Updated Issue Templates
-
-
-## [2.1.6] - 2025-09-02
-
-### Changed
-- `Sink`, `Source` and `SourceAndSink` now accept multiple `flows` as `inputs` and `outputs` instead of just one. This enables to model more use cases using these classes. [[#291](https://github.com/flixOpt/flixopt/pull/291) by [@FBumann](https://github.com/FBumann)]
-- Further, both `Sink` and `Source` now have a `prevent_simultaneous_flow_rates` argument to prevent simultaneous flow rates of more than one of their Flows. [[#291](https://github.com/flixOpt/flixopt/pull/291) by [@FBumann](https://github.com/FBumann)]
-
-### Added
-- Added `FlowSystem.start_network_app()` and `FlowSystem.stop_network_app()` to easily visualize the network structure of a flow system in an interactive dash web app. This is still experimental and might change in the future. [[#293](https://github.com/flixOpt/flixopt/pull/293) by [@FBumann](https://github.com/FBumann)]
-
-### Deprecated
-- For the classes `Sink`, `Source` and `SourceAndSink`: `.sink`, `.source` and `.prevent_simultaneous_sink_and_source` are deprecated in favor of the new arguments `inputs`, `outputs` and `prevent_simultaneous_flow_rates`. [[#291](https://github.com/flixOpt/flixopt/pull/291) by [@FBumann](https://github.com/FBumann)]
-
-### Fixed
-- Fixed testing issue with new `linopy` version 0.5.6 [[#296](https://github.com/flixOpt/flixopt/pull/296) by [@FBumann](https://github.com/FBumann)]
-
-## [2.1.5] - 2025-07-08
-
-### Fixed
-- Fixed Docs deployment
-
-## [2.1.4] - 2025-07-08
-
-### Fixed
-- Fixing release notes of 2.1.3, as well as documentation build.
-
-
-## [2.1.3] - 2025-07-08
-
-### Fixed
-- Using `Effect.maximum_operation_per_hour` raised an error, needing an extra timestep. This has been fixed thanks to @PRse4.
-
-## [2.1.2] - 2025-06-14
-
-### Fixed
-- Storage losses per hour where not calculated correctly, as mentioned by @brokenwings01. This might have lead to issues with modeling large losses and long timesteps.
-  - Old implementation:     $c(\text{t}_{i}) \cdot (1-\dot{\text{c}}_\text{rel,loss}(\text{t}_i)) \cdot \Delta \text{t}_{i}$
-  - Correct implementation: $c(\text{t}_{i}) \cdot (1-\dot{\text{c}}_\text{rel,loss}(\text{t}_i)) ^{\Delta \text{t}_{i}}$
-
-### Known issues
-- Just to mention: Plotly >= 6 may raise errors if "nbformat" is not installed. We pinned plotly to <6, but this may be fixed in the future.
-
-## [2.1.1] - 2025-05-08
-
-### Fixed
-- Fixed bug in the `_ElementResults.constraints` not returning the constraints but rather the variables
-
-### Changed
-- Improved docstring and tests
-
-## [2.1.0] - 2025-04-11
-
-### Added
-- Python 3.13 support added
-- Logger warning if relative_minimum is used without on_off_parameters in Flow
-- Greatly improved internal testing infrastructure by leveraging linopy's testing framework
-
-### Fixed
-- Fixed the lower bound of `flow_rate` when using optional investments without OnOffParameters
-- Fixed bug that prevented divest effects from working
-- Added lower bounds of 0 to two unbounded vars (numerical improvement)
-
-### Changed
-- **BREAKING**: Restructured the modeling of the On/Off state of Flows or Components
-  - Variable renaming: `...|consecutive_on_hours` → `...|ConsecutiveOn|hours`
-  - Variable renaming: `...|consecutive_off_hours` → `...|ConsecutiveOff|hours`
-  - Constraint renaming: `...|consecutive_on_hours_con1` → `...|ConsecutiveOn|con1`
-  - Similar pattern for all consecutive on/off constraints
-
-## [2.0.1] - 2025-04-10
-
-### Added
-- Logger warning if relative_minimum is used without on_off_parameters in Flow
-
-### Fixed
-- Replace "|" with "__" in filenames when saving figures (Windows compatibility)
-- Fixed bug that prevented the load factor from working without InvestmentParameters
-
-## [2.0.0] - 2025-03-29
-
-### Changed
-- **BREAKING**: Complete migration from Pyomo to Linopy optimization framework
-- **BREAKING**: Redesigned data handling to rely on xarray.Dataset throughout the package
-- **BREAKING**: Framework renamed from flixOpt to flixopt (`import flixopt as fx`)
-- **BREAKING**: Results handling completely redesigned with new `CalculationResults` class
-
-### Added
-- Full model serialization support - save and restore unsolved Models
-- Enhanced model documentation with YAML export containing human-readable mathematical formulations
-- Extend flixopt models with native linopy language support
-- Full Model Export/Import capabilities via linopy.Model
-- Unified solution exploration through `Calculation.results` attribute
-- Compression support for result files
-- `to_netcdf/from_netcdf` methods for FlowSystem and core components
-- xarray integration for TimeSeries with improved datatypes support
-- Google Style Docstrings throughout the codebase
-
-### Fixed
-- Improved infeasible model detection and reporting
-- Enhanced time series management and serialization
-- Reduced file size through improved compression
-
-### Removed
-- **BREAKING**: Pyomo dependency (replaced by linopy)
-- Period concepts in time management (simplified to timesteps)