flixopt 2.1.1__py3-none-any.whl → 2.1.2__py3-none-any.whl

flixopt/components.py

@@ -491,7 +491,7 @@ class StorageModel(ComponentModel):
         self.add(
             self._model.add_constraints(
                 charge_state.isel(time=slice(1, None))
-                == charge_state.isel(time=slice(None, -1)) * (1 - rel_loss * hours_per_step)
+                == charge_state.isel(time=slice(None, -1)) * ((1 - rel_loss) ** hours_per_step)
                 + charge_rate * eff_charge * hours_per_step
                 - discharge_rate * eff_discharge * hours_per_step,
                 name=f'{self.label_full}|charge_state',

{flixopt-2.1.1.dist-info → flixopt-2.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.1
+Version: 2.1.2
 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>
@@ -22,40 +22,40 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: numpy>=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: numpy<3,>=1.21.5
+Requires-Dist: pandas<3,>=2.0.0
+Requires-Dist: linopy<0.6.0,>=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: pandas<3,>=2
-Requires-Dist: matplotlib>=3.5.2
-Requires-Dist: plotly>=5.15
-Requires-Dist: tomli>=2.0.1
+Requires-Dist: matplotlib<4.0.0,>=3.5.2
+Requires-Dist: plotly<6.0.0,>=5.15.0
 Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: ruff>=0.9.0; 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"
+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"
 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"
+Requires-Dist: tsam<3.0.0,>=2.3.1; extra == "full"
+Requires-Dist: scipy<2.0.0,>=1.15.1; extra == "full"
+Requires-Dist: streamlit<2.0.0,>=1.44.0; extra == "full"
+Requires-Dist: gurobipy>=10.0.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"
+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,>=1.1.0; extra == "docs"
 Dynamic: license-file
 
 # FlixOpt: Energy and Material Flow Optimization Framework

{flixopt-2.1.1.dist-info → flixopt-2.1.2.dist-info}/RECORD

@@ -9,12 +9,6 @@ docs/images/architecture_flixOpt-pre2.0.0.png,sha256=9RWSA3vys588aadr2437zor-_-x
 docs/images/architecture_flixOpt.png,sha256=KjN1bJwESbkHmTW7UsJ7dZyiKZlTO7Dx20dg8KlR1HU,260219
 docs/images/flixopt-icon.svg,sha256=_1a6bk2pDOVEy233LC1nM6jZ35NdzD8Hd3UqGxW1Xpg,135341
 docs/javascripts/mathjax.js,sha256=lkPNMk5XrDlyut9e5nGHgpN7gFl8OejpdJJ_gRW_14k,401
-docs/release-notes/_template.txt,sha256=j65E_FDxzimkcMXBrXyF6b2KPm0KAiQlGTxfhQHnN7c,496
-docs/release-notes/index.md,sha256=6VslOEfF3KQQCbntguRKz7uGWd_W_KIYotP8L1fzAeI,227
-docs/release-notes/v2.0.0.md,sha256=eauxvCH3O0B054vhbP0G8GdeF2LM__J57VAGYRFQzBg,4676
-docs/release-notes/v2.0.1.md,sha256=_0oqZjogRv_x6DToWih78uhHu65-J1tat5A1asYxg50,398
-docs/release-notes/v2.1.0.md,sha256=uUnlzG61rI2PYce1SxIySYOnW55e_vnJYJN7l8lcB8A,1325
-docs/release-notes/v2.1.1.md,sha256=Y9cMiB6LeO6rZexJ9DD9BEl5mnrP8GLcf9nDtOLfIgc,217
 docs/user-guide/index.md,sha256=fxI_bMjz7czJ5aF_7D7l5rQVpc03WV2EAaBo9y3gB2g,7452
 docs/user-guide/Mathematical Notation/Bus.md,sha256=getjae_-rNTXbotO0euXwYCq2arBoayKsN9KeFb2u60,1612
 "docs/user-guide/Mathematical Notation/Effects, Penalty & Objective.md",sha256=RNqcJzNI1E-U01gaeoKu7m-7gjmtDWvjr2Y5JK9YgTA,5685
@@ -28,7 +22,7 @@ flixopt/__init__.py,sha256=F49OK5QLUnMGmsaKQ-G0dXsVuKr9Ow_pjM4KMSNZ918,614
 flixopt/aggregation.py,sha256=UaAYh34C4XhDgiSs4lm31XEMLr4YO5BzLKUAx4NQuyI,17002
 flixopt/calculation.py,sha256=1Hs9dc6eqdJoHT6Dd3NlwdRORFO2vKdKx38o95FPxJE,20016
 flixopt/commons.py,sha256=ZNlUN1z-h9OGHPo-s-n5OLlJaoPZKVGcAdRyGKpMk4M,1256
-flixopt/components.py,sha256=WXSljJNnEXyQLXMQQRwMfkugus3qTmIu9bPcknzvr1w,29121
+flixopt/components.py,sha256=7vI0IzWBLj81IErPllWHbMMqrrPlplYOPcH3aHvDbeY,29124
 flixopt/config.py,sha256=Kt8QYk7hX5qHcQUtfgjM862C6SQr4K2lDvtk_LLER8Y,9085
 flixopt/config.yaml,sha256=imzAnnhcJhIfKNTTXFB5Td7Pvk5ARn5j720k-oGGRug,392
 flixopt/core.py,sha256=JGsnw-VsNCQW2zDl0kMwhcPIzq08DJmcRQ02nLyDvIg,37633
@@ -44,16 +38,16 @@ flixopt/results.py,sha256=GKSZmz0GCuJwspTC8Ot6MOKinvy_mhnDXCafb_f7uVY,35161
 flixopt/solvers.py,sha256=k1bSoiXec3asWED70-erXkgtpn2C8KRBfSZj0FLviSM,2436
 flixopt/structure.py,sha256=QS0IFBHzdEMKYTgd6uosudhoDD4X0JcdF7LlS-XRacs,26295
 flixopt/utils.py,sha256=f-_vFDvvG27-c_VMpzkv3lb79Yny4rvoSmemushbzhU,1687
-flixopt-2.1.1.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
+flixopt-2.1.2.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
 pics/architecture_flixOpt-pre2.0.0.png,sha256=9RWSA3vys588aadr2437zor-_-xBTQNQ0bAf8xGcu5g,70605
 pics/architecture_flixOpt.png,sha256=KjN1bJwESbkHmTW7UsJ7dZyiKZlTO7Dx20dg8KlR1HU,260219
 pics/flixOpt_plotting.jpg,sha256=zn7ZPAtXm5eRTxtOj86e4-PPhHpCar1jqGh7vMBgQGY,518862
 pics/flixopt-icon.svg,sha256=_1a6bk2pDOVEy233LC1nM6jZ35NdzD8Hd3UqGxW1Xpg,135341
 pics/pics.pptx,sha256=ImWeGGvjtWJ6BGruipsnZYmWtHj5sWdbw1NSFePbkC8,683344
+scripts/extract_release_notes.py,sha256=0v8B9c6VXz55PJ0I08W7FdxGp7jEY5NOkrqMY6MNdYU,1249
 scripts/gen_ref_pages.py,sha256=AYRtXyz78x5I_Hn0oRtGVbTxgLLj2QNyRX6vWRefPjc,1960
-site/release-notes/_template.txt,sha256=j65E_FDxzimkcMXBrXyF6b2KPm0KAiQlGTxfhQHnN7c,496
 tests/ressources/Zeitreihen2020.csv,sha256=kbsDTKZS0iUsNZAS7m3DohzZI_OHHWe44s3GwLvcTLw,1918412
-flixopt-2.1.1.dist-info/METADATA,sha256=3n5YyOC_w1ySnHAFZwJtYGUGEfboRLbYYFXOSKiNxaU,7155
-flixopt-2.1.1.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-flixopt-2.1.1.dist-info/top_level.txt,sha256=U8aoMBkjiSFi7j4zgUOVgvgmyT5a1LnIArZI6TWdk-g,37
-flixopt-2.1.1.dist-info/RECORD,,
+flixopt-2.1.2.dist-info/METADATA,sha256=bwiwG5v5T-LhmGRZVvRZJZrUclJwEW7j74v1s1Qfhdc,7343
+flixopt-2.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flixopt-2.1.2.dist-info/top_level.txt,sha256=DEuo4R1z7GmEp5R3pjbQEJbaPRjKHFvNX2ceiBnVOL0,32
+flixopt-2.1.2.dist-info/RECORD,,

{flixopt-2.1.1.dist-info → flixopt-2.1.2.dist-info}/WHEEL

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

{flixopt-2.1.1.dist-info → flixopt-2.1.2.dist-info}/top_level.txt

@@ -2,5 +2,4 @@ docs
 flixopt
 pics
 scripts
-site
 tests

scripts/extract_release_notes.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+"""
+Extract release notes from CHANGELOG.md for a specific version.
+Usage: python extract_release_notes.py <version>
+"""
+
+import re
+import sys
+from pathlib import Path
+
+
+def extract_release_notes(version: str) -> str:
+    """Extract release notes for a specific version from CHANGELOG.md"""
+    changelog_path = Path("CHANGELOG.md")
+
+    if not changelog_path.exists():
+        print("❌ Error: CHANGELOG.md not found", file=sys.stderr)
+        sys.exit(1)
+
+    content = changelog_path.read_text(encoding='utf-8')
+
+    # Pattern to match version section: ## [2.1.2] - 2025-06-14
+    pattern = rf'## \[{re.escape(version)}\] - [^\n]+\n(.*?)(?=\n## \[|\n\[Unreleased\]|\Z)'
+    match = re.search(pattern, content, re.DOTALL)
+
+    if not match:
+        print(f"❌ Error: No release notes found for version '{version}'", file=sys.stderr)
+        sys.exit(1)
+
+    return match.group(1).strip()
+
+
+def main():
+    if len(sys.argv) != 2:
+        print("Usage: python extract_release_notes.py <version>")
+        print("Example: python extract_release_notes.py 2.1.2")
+        sys.exit(1)
+
+    version = sys.argv[1]
+    release_notes = extract_release_notes(version)
+    print(release_notes)
+
+
+if __name__ == "__main__":
+    main()

docs/release-notes/_template.txt

@@ -1,32 +0,0 @@
-# Release v{version}
-
-**Release Date:** YYYY-MM-DD
-
-## What's New
-
-* Feature 1 - Description
-* Feature 2 - Description
-
-## Improvements
-
-* Improvement 1 - Description
-* Improvement 2 - Description
-
-## Bug Fixes
-
-* Fixed issue with X
-* Resolved problem with Y
-
-## Breaking Changes
-
-* Change 1 - Migration instructions
-* Change 2 - Migration instructions
-
-## Deprecations
-
-* Feature X will be removed in v{next_version}
-
-## Dependencies
-
-* Added dependency X v1.2.3
-* Updated dependency Y to v2.0.0

docs/release-notes/index.md

@@ -1,7 +0,0 @@
-# Release Notes
-
-This page provides links to release notes for all versions of flixopt.
-
-## Latest Release
-
-* [v2.0.0](v2.0.0.md) - 29.03.2025 - Migration from pyomo to linopy. Alround improvements in performance and usability

docs/release-notes/v2.0.0.md

@@ -1,93 +0,0 @@
-# Release v2.0.0
-
-**Release Date:** March 29, 2025
-
-## 🚀 Major Framework Changes
-
-- **Migration from Pyomo to Linopy**: Completely rebuilt the optimization foundation to use Linopy instead of Pyomo
-    - Significant performance improvements, especially for large models
-    - Internal useage of linopys mathematical modeling language
-- **xarray-Based Data Architecture**: Redesigned data handling to rely on xarray.Dataset throughout the package for:
-    - Improved solution representation and analysis
-    - Enhanced time series management
-    - Consistent serialization across all elements
-    - Reduced file size and improved performance
-- **Saving and restoring unsolved Models**: The FlowSystem is now fully serializable and can be saved to a file.
-    - Share your work with others by saving the FlowSystem to a file
-    - Load a FlowSystem from a file to extend  or modify your work
-
-## 🔧 Key Improvements
-
-### Model Handling
-
-- **Extend every flixopt model with the linopy language**: Add any additional constraint or variable to your flixopt model by using the linopy language.
-- **Full Model Export/Import**: As a result of the migration to Linopy, the linopy.Model can be exported before or after the solve.
-- **Improved Infeasible Model Handling**: Added better detection and reporting for infeasible optimization models
-- **Improved Model Documentation**: Every model can be documented in a .yaml file, containing human readable mathematical formulations of all variables and constraints. THis is used to document every Calculation.
-
-### Calculation Results and documentation: 
-The `CalculationResults` class has been completely redesigned to provide a more streamlined and intuitive interface.
-Accessing the results of a Calculation is now as simple as:
-```python
-fx.FullCalculation('Sim1', flow_system)
-calculation.solve(fx.solvers.HighsSolver())
-calculation.results  # This object can be entirely saved and reloaded to file without any information loss
-```
-This access doesn't change if you save and load the results to a file or use them in your script directly!
-
-- **Improved Documentation**: The FlowSystem as well as a model Documentation is created for every model run.
-- **Results without saving to file**: The results of a Calculation can now be properly accessed without saving the results to a file first.
-- **Unified Solution exploration**: Every `Calculation` has a `Calculation.results` attribute, which accesses the solution. This can be saved and reloaded without any information loss.
-- **Improved Calculation Results**: The results of a Calculation are now more intuitive and easier to access. The `CalculationResults` class has been completely redesigned to provide a more streamlined and intuitive interface.
-
-### Data Management & I/O
-
-- **Unified Serialization**: Standardized serialization and deserialization across all elements
-- **Compression Support**: Added data compression when saving results to reduce file size
-- **to_netcdf/from_netcdf Methods**: Added for FlowSystem and other core components
-
-### Details
-#### TimeSeries Enhancements
-
-- **xarray Integration**: Redesigned TimeSeries to depend on xr.DataArray
-- **datatypes**: Added support for more datatypes, with methods for conversion to TimeSeries
-- **Improved TimeSeriesCollection**: Enhanced indexing, representation, and dataset conversion
-- **Simplified Time Management**: Removed period concepts and focused on timesteps for more intuitive time handling
-
-## 📚 Documentation
-
-- Improved documentation of the FlixOpt API and mathematical formulations
-- **Google Style Docstrings**: Updated all docstrings to Google style format
-
-## 🔄 Dependencies
-
-- **Linopy**: Added as the core dependency replacing Pyomo
-- **xarray**: Now a critical dependency for data handling and file I/O
-- **netcdf4**: Dependency for fast and efficient file I/O
-
-### Dropped Dependencies
-- **pyomo**: Replaced by linopy as the modeling language
-
-## 📋 Migration Notes
-
-This version represents a significant architecture change. If you're upgrading:
-
-- Code that directly accessed Pyomo models will need to be updated to work with Linopy
-- Data handling now uses xarray.Dataset throughout, which may require changes in how you interact with results
-- The way labels are constructed has changed throughout the system
-- The results of calculations are now handled differently, and may require changes in how you access results
-- The framework was renamed from flixOpt to flixopt. Use `import flixopt as fx`.
-
-For complete details, please refer to the full commit history.
-
-## Installation
-
-```bash
-pip install flixopt==2.0.0
-```
-
-## Upgrading
-
-```bash
-pip install --upgrade flixopt
-```

docs/release-notes/v2.0.1.md

@@ -1,12 +0,0 @@
-# Release v2.0.1
-
-**Release Date:** 2025-04-10
-
-## Improvements
-
-* Add logger warning if relative_minimum is used without on_off_parameters in Flow, as this prevents the flow_rate from switching "OFF"
-
-## Bug Fixes
-
-* Replace "|" with "__" in filenames when saving figures, as "|" can lead to issues on windows
-* Fixed a Bug that prevented the load factor from working without InvestmentParameters

docs/release-notes/v2.1.0.md

@@ -1,31 +0,0 @@
-# Release v2.1.0
-
-**Release Date:** 2025-04-11
-
-## Improvements
-
-* Add logger warning if relative_minimum is used without on_off_parameters in Flow, as this prevents the flow_rate from switching "OFF"
-* Python 3.13 support added
-* Greatly improved internal testing infrastructure by leveraging linopy's testing framework
-
-## Bug Fixes
-
-* Bugfixing the lower bound of `flow_rate` when using optional investments without OnOffParameters.
-* Fixes a Bug that prevented divest effects from working.
-* added lower bounds of 0 to two unbounded vars (only numerical better)
-
-## Breaking Changes
-
-* We restructured the modeling of the On/Off state of FLows or Components. This leads to slightly renaming of variables and constraints.
-
-### Variable renaming
-* "...|consecutive_on_hours" is now "...|ConsecutiveOn|hours"
-* "...|consecutive_off_hours" is now "...|ConsecutiveOff|hours"
-
-### Constraint renaming
-* "...|consecutive_on_hours_con1" is now "...|ConsecutiveOn|con1"
-* "...|consecutive_on_hours_con2a" is now "...|ConsecutiveOn|con2a"
-* "...|consecutive_on_hours_con2b" is now "...|ConsecutiveOn|con2b"
-* "...|consecutive_on_hours_initial" is now "...|ConsecutiveOn|initial"
-* "...|consecutive_on_hours_minimum_duration" is now "...|ConsecutiveOn|minimum"
-The same goes for "...|consecutive_off..." --> "...|ConsecutiveOff|..."

docs/release-notes/v2.1.1.md

@@ -1,11 +0,0 @@
-# Release v2.1.1
-
-**Release Date:** 2025-05-08
-
-## Improvements
-
-* Improving docstring and tests
-
-## Bug Fixes
-
-* Fixing bug in the `_ElementResults.constraints` not returning the constraints but rather the variables

site/release-notes/_template.txt

@@ -1,32 +0,0 @@
-# Release v{version}
-
-**Release Date:** YYYY-MM-DD
-
-## What's New
-
-* Feature 1 - Description
-* Feature 2 - Description
-
-## Improvements
-
-* Improvement 1 - Description
-* Improvement 2 - Description
-
-## Bug Fixes
-
-* Fixed issue with X
-* Resolved problem with Y
-
-## Breaking Changes
-
-* Change 1 - Migration instructions
-* Change 2 - Migration instructions
-
-## Deprecations
-
-* Feature X will be removed in v{next_version}
-
-## Dependencies
-
-* Added dependency X v1.2.3
-* Updated dependency Y to v2.0.0