flixopt 2.1.10__tar.gz → 2.1.11__tar.gz

{flixopt-2.1.10 → flixopt-2.1.11}/CHANGELOG.md

@@ -46,6 +46,7 @@ Please keep the format of the changelog consistent with the other releases, so t
 ### 💥 Breaking Changes
 
 ### ♻️ Changed
+- Using `h5netcdf` instead of `netCDF4` for dataset I/O operations. This follows the update in `xarray==2025.09.01`
 
 ### 🗑️ Deprecated
 
@@ -58,8 +59,6 @@ Please keep the format of the changelog consistent with the other releases, so t
 ### 📦 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
 
@@ -68,6 +67,20 @@ Please keep the format of the changelog consistent with the other releases, so t
 Until here -->
 ---
 
+## [2.1.11] - 2025-10-05
+**Summary:** Important bugfix in `Storage` leading to wrong results due to incorrect discharge losses.
+
+### ♻️ Changed
+- Using `h5netcdf` instead of `netCDF4` for dataset I/O operations. This follows the update in `xarray==2025.09.01`
+
+### 🐛 Fixed
+- Fix `charge_state` Constraint in `Storage` leading to incorrect losses in discharge and therefore incorrect charge states and discharge values.
+
+### 📦 Dependencies
+- Updated `renovate.config` to treat CalVer packages (xarray and dask) with more care
+
+---
+
 ## [2.1.10] - 2025-09-29
 **Summary:** This release is a Documentation and Development release.
 

flixopt-2.1.11/MANIFEST.in

@@ -0,0 +1,26 @@
+# Include essential files from source distribution
+include LICENSE
+include README.md
+include CHANGELOG.md
+include pyproject.toml
+
+# Include package source and data
+recursive-include flixopt *.py *.yaml
+
+# Exclude everything else
+global-exclude *.pyc *.pyo __pycache__
+prune .github
+prune docs
+prune examples
+prune tests
+prune pics
+prune scripts
+prune build
+prune dist
+prune .venv
+prune venv
+exclude .gitignore
+exclude .pre-commit-config.yaml
+exclude renovate.json
+exclude mkdocs.yml
+exclude test_package.sh

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

@@ -1,16 +1,15 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.10
+Version: 2.1.11
 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
+License-Expression: MIT
 Project-URL: homepage, https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschung/forschungsprojekte/flixopt
 Project-URL: repository, https://github.com/flixOpt/flixopt
 Project-URL: documentation, https://flixopt.github.io/flixopt/
 Keywords: optimization,energy systems,numerical analysis
 Classifier: Development Status :: 3 - Alpha
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -18,7 +17,6 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering
-Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -26,7 +24,7 @@ Requires-Dist: numpy<3,>=1.21.5
 Requires-Dist: pandas<3,>=2.0.0
 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: h5netcdf<2,>=1.0.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"

{flixopt-2.1.10 → flixopt-2.1.11}/flixopt/components.py

@@ -791,7 +791,7 @@ class StorageModel(ComponentModel):
                 charge_state.isel(time=slice(1, None))
                 == 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,
+                - discharge_rate * hours_per_step / eff_discharge,
                 name=f'{self.label_full}|charge_state',
             ),
             'charge_state',

{flixopt-2.1.10 → flixopt-2.1.11}/flixopt/flow_system.py

@@ -211,9 +211,10 @@ class FlowSystem:
         ds.attrs = self.as_dict(data_mode='name')
         return ds
 
-    def to_netcdf(self, path: str | pathlib.Path, compression: int = 0, constants_in_dataset: bool = True):
+    def to_netcdf(self, path: str | pathlib.Path, compression: int = 0, constants_in_dataset: bool = True) -> None:
         """
         Saves the FlowSystem to a netCDF file.
+
         Args:
             path: The path to the netCDF file.
             compression: The compression level to use when saving the file.

{flixopt-2.1.10 → flixopt-2.1.11}/flixopt/io.py

@@ -208,6 +208,7 @@ def save_dataset_to_netcdf(
     ds: xr.Dataset,
     path: str | pathlib.Path,
     compression: int = 0,
+    engine: Literal['netcdf4', 'scipy', 'h5netcdf'] = 'h5netcdf',
 ) -> None:
     """
     Save a dataset to a netcdf file. Store the attrs as a json string in the 'attrs' attribute.
@@ -226,12 +227,12 @@ def save_dataset_to_netcdf(
 
     apply_encoding = False
     if compression != 0:
-        if importlib.util.find_spec('netCDF4') is not None:
+        if importlib.util.find_spec(engine) is not None:
             apply_encoding = True
         else:
             logger.warning(
-                'Dataset was exported without compression due to missing dependency "netcdf4".'
-                'Install netcdf4 via `pip install netcdf4`.'
+                f'Dataset was exported without compression due to missing dependency "{engine}".'
+                f'Install {engine} via `pip install {engine}`.'
             )
     ds = ds.copy(deep=True)
     ds.attrs = {'attrs': json.dumps(ds.attrs)}
@@ -240,6 +241,7 @@ def save_dataset_to_netcdf(
         encoding=None
         if not apply_encoding
         else {data_var: {'zlib': True, 'complevel': compression} for data_var in ds.data_vars},
+        engine=engine,
     )
 
 
@@ -253,7 +255,7 @@ def load_dataset_from_netcdf(path: str | pathlib.Path) -> xr.Dataset:
     Returns:
         Dataset: Loaded dataset.
     """
-    ds = xr.load_dataset(str(path))
+    ds = xr.load_dataset(str(path), engine='h5netcdf')
     ds.attrs = json.loads(ds.attrs['attrs'])
     return ds
 

{flixopt-2.1.10 → flixopt-2.1.11}/flixopt/results.py

@@ -338,7 +338,7 @@ class CalculationResults:
             if self.model is None:
                 logger.critical('No model in the CalculationResults. Saving the model is not possible.')
             else:
-                self.model.to_netcdf(paths.linopy_model)
+                self.model.to_netcdf(paths.linopy_model, engine='h5netcdf')
 
         if document_model:
             if self.model is None:

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

@@ -1,16 +1,15 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.10
+Version: 2.1.11
 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
+License-Expression: MIT
 Project-URL: homepage, https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschung/forschungsprojekte/flixopt
 Project-URL: repository, https://github.com/flixOpt/flixopt
 Project-URL: documentation, https://flixopt.github.io/flixopt/
 Keywords: optimization,energy systems,numerical analysis
 Classifier: Development Status :: 3 - Alpha
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -18,7 +17,6 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering
-Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -26,7 +24,7 @@ Requires-Dist: numpy<3,>=1.21.5
 Requires-Dist: pandas<3,>=2.0.0
 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: h5netcdf<2,>=1.0.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"

flixopt-2.1.11/flixopt.egg-info/SOURCES.txt

@@ -0,0 +1,31 @@
+CHANGELOG.md
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+flixopt/__init__.py
+flixopt/aggregation.py
+flixopt/calculation.py
+flixopt/commons.py
+flixopt/components.py
+flixopt/config.py
+flixopt/config.yaml
+flixopt/core.py
+flixopt/effects.py
+flixopt/elements.py
+flixopt/features.py
+flixopt/flow_system.py
+flixopt/interface.py
+flixopt/io.py
+flixopt/linear_converters.py
+flixopt/network_app.py
+flixopt/plotting.py
+flixopt/results.py
+flixopt/solvers.py
+flixopt/structure.py
+flixopt/utils.py
+flixopt.egg-info/PKG-INFO
+flixopt.egg-info/SOURCES.txt
+flixopt.egg-info/dependency_links.txt
+flixopt.egg-info/requires.txt
+flixopt.egg-info/top_level.txt

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

@@ -2,7 +2,7 @@ numpy<3,>=1.21.5
 pandas<3,>=2.0.0
 xarray<2026.0,>=2024.2.0
 linopy<0.6,>=0.5.1
-netcdf4<2,>=1.6.1
+h5netcdf<2,>=1.0.0
 pyyaml<7,>=6.0.0
 rich<15,>=13.0.0
 highspy<2,>=1.5.3

flixopt-2.1.11/flixopt.egg-info/top_level.txt

@@ -0,0 +1 @@
+flixopt

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

@@ -8,7 +8,7 @@ dynamic = ["version"]
 description = "Vector based energy and material flow optimization framework in Python."
 readme = "README.md"
 requires-python = ">=3.10"
-license = { text = "MIT License" }
+license = "MIT"
 authors = [
     { name = "Chair of Building Energy Systems and Heat Supply, TU Dresden", email = "peter.stange@tu-dresden.de" },
     { name = "Felix Bumann", email = "felixbumann387@gmail.com" },
@@ -22,7 +22,6 @@ maintainers = [
 keywords = ["optimization", "energy systems", "numerical analysis"]
 classifiers = [
     "Development Status :: 3 - Alpha",
-    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -30,7 +29,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "Intended Audience :: Science/Research",
     "Topic :: Scientific/Engineering",
-    "License :: OSI Approved :: MIT License",
 ]
 dependencies = [
     # Core scientific computing
@@ -39,7 +37,7 @@ dependencies = [
     "xarray >= 2024.2.0, < 2026.0",  # CalVer: allow through next calendar year
     # Optimization and data handling
     "linopy >= 0.5.1, < 0.6",  # Widened from patch pin to minor range
-    "netcdf4 >= 1.6.1, < 2",
+    "h5netcdf>=1.0.0, < 2",
     # Utilities
     "pyyaml >= 6.0.0, < 7",
     "rich >= 13.0.0, < 15",
@@ -116,11 +114,18 @@ documentation = "https://flixopt.github.io/flixopt/"
 
 [tool.setuptools.packages.find]
 where = ["."]
-exclude = ["tests", "docs", "examples", "examples.*", "Tutorials", ".git", ".vscode", "build", ".venv", "venv/"]
+include = ["flixopt*"]
+exclude = ["tests*", "docs*", "examples*", "Tutorials*"]
 
 [tool.setuptools.package-data]
 "flixopt" = ["config.yaml"]
 
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.exclude-package-data]
+"*" = ["*.md", ".git*", "*.ipynb", "renovate.json"]
+
 [tool.setuptools_scm]
 version_scheme = "post-release"
 

flixopt-2.1.10/.github/CONTRIBUTING.md

@@ -1,85 +0,0 @@
-# Contributing to FlixOpt
-
-Thanks for your interest in contributing to FlixOpt! 🚀
-
-## Quick Start
-
-1. **Fork & Clone**
-   ```bash
-   git clone https://github.com/yourusername/flixopt.git
-   cd flixopt
-   ```
-
-2. **Install for Development**
-   ```bash
-   pip install -e ".[full]"
-   ```
-
-3. **Make Changes & Submit PR**
-   ```bash
-   git checkout -b feature/your-change
-   # Make your changes
-   git commit -m "Add: description of changes"
-   git push origin feature/your-change
-   # Create Pull Request on GitHub
-   ```
-
-## How to Contribute
-
-### 🐛 **Found a Bug?**
-Use our [bug report template](https://github.com/flixOpt/flixopt/issues/new?template=bug_report.yml) with:
-- Minimal code example
-- FlixOpt version, Python version, solver used
-- Expected vs actual behavior
-
-### ✨ **Have a Feature Idea?**
-Use our [feature request template](https://github.com/flixOpt/flixopt/issues/new?template=feature_request.yml) with:
-- Clear energy system use case
-- Specific examples of what you want to model
-
-### ❓ **Need Help?**
-- Check the [documentation](https://flixopt.github.io/flixopt/latest/) first
-- Search [existing issues](https://github.com/flixOpt/flixopt/issues)
-- Start a [discussion](https://github.com/flixOpt/flixopt/discussions)
-
-## Code Guidelines
-
-- **Style**: Follow PEP 8, use descriptive names
-- **Documentation**: Add docstrings with units (kW, kWh, etc.) if applicable
-- **Energy Focus**: Use energy domain terminology consistently
-- **Testing**: Test with different solvers when applicable
-
-### Example
-```python
-def create_storage(
-    label: str,
-    capacity_kwh: float,
-    charging_power_kw: float
-) -> Storage:
-    """
-    Create a battery storage component.
-
-    Args:
-        label: Unique identifier
-        capacity_kwh: Storage capacity [kWh]
-        charging_power_kw: Maximum charging power [kW]
-    """
-```
-
-## What We Welcome
-
-- 🔧 New energy components (batteries, heat pumps, etc.)
-- 📚 Documentation improvements
-- 🐛 Bug fixes
-- 🧪 Test cases
-- 💡 Energy system examples
-
-## Questions?
-
-- 📖 [Documentation](https://flixopt.github.io/flixopt/latest/)
-- 💬 [Discussions](https://github.com/flixOpt/flixopt/discussions)
-- 📧 Contact maintainers (see README)
-
----
-
-**Every contribution helps advance sustainable energy solutions! 🌱⚡**

flixopt-2.1.10/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,111 +0,0 @@
-name: 🐛 Bug Report
-description: Report a bug in flixopt
-title: "[BUG] "
-labels: ["type: bug"]
-body:
-- type: markdown
-  attributes:
-    value: |
-      Thanks for taking the time to fill out this bug report!
-
-      **Before submitting**: Please search [existing issues](https://github.com/flixOpt/flixopt/issues) to avoid duplicates.
-
-- type: checkboxes
-  id: checks
-  attributes:
-    label: Version Confirmation
-    description: Please confirm you can reproduce this on a supported version
-    options:
-    - label: I have confirmed this bug exists on the latest [release](https://github.com/flixOpt/flixopt/releases) of FlixOpt
-      required: true
-
-- type: textarea
-  id: problem
-  attributes:
-    label: Bug Description
-    description: Clearly describe what went wrong
-    placeholder: |
-      What happened? What did you expect to happen instead?
-
-      Include any error messages or unexpected outputs.
-  validations:
-    required: true
-
-- type: textarea
-  id: example
-  attributes:
-    label: Minimal Reproducible Example
-    description: |
-      Provide the smallest possible code example that reproduces the bug.
-      See [how to create minimal bug reports](https://matthewrocklin.com/minimal-bug-reports).
-    placeholder: |
-      import flixopt as fx
-      import pandas as pd
-
-      # Minimal example that reproduces the bug
-      timesteps = pd.date_range('2024-01-01', periods=24, freq='h')
-      flow_system = fx.FlowSystem(timesteps)
-
-      # Add components that trigger the bug...
-
-      # Show the problematic operation
-      result = flow_system.solve()  # This should fail/behave unexpectedly
-    render: python
-  validations:
-    required: true
-
-- type: textarea
-  id: error-output
-  attributes:
-    label: Error Output
-    description: If there's an error message, paste the full traceback here
-    render: shell
-
-- type: dropdown
-  id: solver
-  attributes:
-    label: Solver Used
-    description: Which solver were you using?
-    options:
-      - HiGHS (default)
-      - Gurobi
-      - CPLEX
-      - GLPK
-      - CBC
-      - Other (specify below)
-  validations:
-    required: true
-
-- type: input
-  id: os
-  attributes:
-    label: Operating System
-    placeholder: "e.g., Windows 11, macOS 14.2, Ubuntu 22.04"
-  validations:
-    required: true
-
-- type: input
-  id: python-version
-  attributes:
-    label: Python Version
-    placeholder: "e.g., 3.11.5"
-  validations:
-    required: true
-
-- type: textarea
-  id: environment
-  attributes:
-    label: Environment Info
-    description: |
-      Run one of these commands and paste the output:
-      - `pip freeze`
-      - `conda env export`
-    render: shell
-    value: >
-      <details>
-
-      ```
-      Replace this with your environment info
-      ```
-
-      </details>

flixopt-2.1.10/.github/ISSUE_TEMPLATE/config.yml

@@ -1,14 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: 🤔 Modeling Questions
-    url: https://github.com/flixOpt/flixopt/discussions/categories/q-a
-    about: "How to model specific energy systems, components, and constraints"
-  - name: ⚡ Performance & Optimization
-    url: https://github.com/flixOpt/flixopt/discussions/categories/performance
-    about: "Solver performance, memory usage, and optimization speed issues"
-  - name: 💡 Ideas & Suggestions
-    url: https://github.com/flixOpt/flixopt/discussions/categories/ideas
-    about: "Share ideas and discuss potential improvements with the community"
-  - name: 📖 Documentation
-    url: https://flixopt.github.io/flixopt/latest/
-    about: "Browse guides, API reference, and examples"

flixopt-2.1.10/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,127 +0,0 @@
-name: ✨ Feature Request
-description: Suggest a new feature or enhancement
-title: "[FEATURE] "
-labels: ["type: feature"]
-body:
-- type: markdown
-  attributes:
-    value: |
-      Thanks for suggesting a new feature!
-
-      **Before submitting**: Please search [existing issues](https://github.com/flixOpt/flixopt/issues) and check our [roadmap](https://github.com/flixOpt/flixopt/discussions) to avoid duplicates.
-
-- type: checkboxes
-  id: checks
-  attributes:
-    label: Prerequisites
-    options:
-    - label: I have searched existing issues and discussions
-      required: true
-    - label: I have checked the [documentation](https://flixopt.github.io/flixopt/latest/)
-      required: true
-
-- type: dropdown
-  id: feature-type
-  attributes:
-    label: Feature Category
-    description: What type of feature is this?
-    options:
-      - New Component (storage, generation, conversion, etc.)
-      - Enhancement to Existing Component
-      - New Optimization Feature
-      - Data Input/Output Improvement
-      - Results/Visualization Enhancement
-      - Performance/Solver Improvement
-      - API/Usability Improvement
-      - Documentation/Examples
-      - Other
-  validations:
-    required: true
-
-- type: textarea
-  id: problem
-  attributes:
-    label: Problem Statement
-    description: What problem would this feature solve?
-    placeholder: |
-      Current limitation: "FlixOpt doesn't support [specific energy system component/feature]..."
-
-      Impact: "This prevents users from modeling [specific scenarios]..."
-
-- type: textarea
-  id: solution
-  attributes:
-    label: Proposed Solution
-    description: Describe your proposed solution in detail
-    placeholder: |
-      I propose adding a new component/feature that would...
-
-      Key capabilities:
-      - Feature 1
-      - Feature 2
-      - Feature 3
-  validations:
-    required: true
-
-- type: textarea
-  id: use-case
-  attributes:
-    label: Use Case & Examples
-    description: Provide concrete examples of how this would be used
-    placeholder: |
-      Real-world scenario: "I'm modeling a microgrid with battery storage and need to..."
-
-      Specific requirements:
-      - Must handle [specific constraint]
-      - Should support [specific behavior]
-      - Would benefit [specific user group]
-  validations:
-    required: true
-
-- type: textarea
-  id: code-example
-  attributes:
-    label: Desired API (Optional)
-    description: Show how you'd like to use this feature
-    placeholder: |
-      # Example of proposed API
-      component = fx.NewComponent(
-          label='example',
-          parameter1=value1,
-          parameter2=value2
-      )
-
-      flow_system.add_component(component)
-    render: python
-
-- type: textarea
-  id: alternatives
-  attributes:
-    label: Alternatives Considered
-    description: What workarounds or alternatives have you tried?
-    placeholder: |
-      Current workaround: "I'm currently using [existing component] but it doesn't support..."
-
-      Other approaches considered: "I looked into [alternative] but..."
-
-- type: dropdown
-  id: priority
-  attributes:
-    label: Priority/Impact
-    description: How important is this feature for your work?
-    options:
-      - Critical - Blocking important work
-      - High - Would significantly improve workflow
-      - Medium - Nice to have enhancement
-      - Low - Minor improvement
-
-- type: textarea
-  id: additional-context
-  attributes:
-    label: Additional Context
-    description: References, papers, examples from other tools, etc.
-    placeholder: |
-      References:
-      - Research paper: [Title and link]
-      - Similar feature in [other tool]: [description]
-      - Industry standard: [description]