flixopt 2.1.10__py3-none-any.whl → 2.2.0__py3-none-any.whl

flixopt/elements.py

@@ -248,7 +248,7 @@ class Flow(Element):
         size: Flow capacity or nominal rating. Can be:
             - Scalar value for fixed capacity
             - InvestParameters for investment-based sizing decisions
-            - None to use large default value (CONFIG.modeling.BIG)
+            - None to use large default value (CONFIG.Modeling.big)
         relative_minimum: Minimum flow rate as fraction of size.
             Example: 0.2 means flow cannot go below 20% of rated capacity.
         relative_maximum: Maximum flow rate as fraction of size (typically 1.0).
@@ -356,7 +356,7 @@ class Flow(Element):
         `relative_maximum` for upper bounds on optimization variables.
 
     Notes:
-        - Default size (CONFIG.modeling.BIG) is used when size=None
+        - Default size (CONFIG.Modeling.big) is used when size=None
         - list inputs for previous_flow_rate are converted to NumPy arrays
         - Flow direction is determined by component input/output designation
 
@@ -383,7 +383,7 @@ class Flow(Element):
         meta_data: dict | None = None,
     ):
         super().__init__(label, meta_data=meta_data)
-        self.size = CONFIG.modeling.BIG if size is None else size
+        self.size = CONFIG.Modeling.big if size is None else size
         self.relative_minimum = relative_minimum
         self.relative_maximum = relative_maximum
         self.fixed_relative_profile = fixed_relative_profile
@@ -455,11 +455,11 @@ class Flow(Element):
             raise PlausibilityError(self.label_full + ': Take care, that relative_minimum <= relative_maximum!')
 
         if (
-            self.size == CONFIG.modeling.BIG and self.fixed_relative_profile is not None
+            self.size == CONFIG.Modeling.big and self.fixed_relative_profile is not None
         ):  # Default Size --> Most likely by accident
             logger.warning(
                 f'Flow "{self.label}" has no size assigned, but a "fixed_relative_profile". '
-                f'The default size is {CONFIG.modeling.BIG}. As "flow_rate = size * fixed_relative_profile", '
+                f'The default size is {CONFIG.Modeling.big}. As "flow_rate = size * fixed_relative_profile", '
                 f'the resulting flow_rate will be very high. To fix this, assign a size to the Flow {self}.'
             )
 

flixopt/features.py

@@ -143,7 +143,7 @@ class InvestmentModel(Model):
             # eq2: P_invest >= isInvested * max(epsilon, investSize_min)
             self.add(
                 self._model.add_constraints(
-                    self.size >= self.is_invested * np.maximum(CONFIG.modeling.EPSILON, self.parameters.minimum_size),
+                    self.size >= self.is_invested * np.maximum(CONFIG.Modeling.epsilon, self.parameters.minimum_size),
                     name=f'{self.label_full}|is_invested_lb',
                 ),
                 'is_invested_lb',
@@ -304,7 +304,7 @@ class StateModel(Model):
             # Constraint: on * lower_bound <= def_var
             self.add(
                 self._model.add_constraints(
-                    self.on * np.maximum(CONFIG.modeling.EPSILON, lb) <= def_var, name=f'{self.label_full}|on_con1'
+                    self.on * np.maximum(CONFIG.Modeling.epsilon, lb) <= def_var, name=f'{self.label_full}|on_con1'
                 ),
                 'on_con1',
             )
@@ -314,7 +314,7 @@ class StateModel(Model):
         else:
             # Case for multiple defining variables
             ub = sum(bound[1] for bound in self._defining_bounds) / nr_of_def_vars
-            lb = CONFIG.modeling.EPSILON  # TODO: Can this be a bigger value? (maybe the smallest bound?)
+            lb = CONFIG.Modeling.epsilon  # TODO: Can this be a bigger value? (maybe the smallest bound?)
 
             # Constraint: on * epsilon <= sum(all_defining_variables)
             self.add(
@@ -337,7 +337,7 @@ class StateModel(Model):
     @property
     def previous_states(self) -> np.ndarray:
         """Computes the previous states {0, 1} of defining variables as a binary array from their previous values."""
-        return StateModel.compute_previous_states(self._previous_values, epsilon=CONFIG.modeling.EPSILON)
+        return StateModel.compute_previous_states(self._previous_values, epsilon=CONFIG.Modeling.epsilon)
 
     @property
     def previous_on_states(self) -> np.ndarray:
@@ -603,14 +603,14 @@ class ConsecutiveStateModel(Model):
         elif np.isscalar(binary_values) and not np.isscalar(hours_per_timestep):
             return binary_values * hours_per_timestep[-1]
 
-        if np.isclose(binary_values[-1], 0, atol=CONFIG.modeling.EPSILON):
+        if np.isclose(binary_values[-1], 0, atol=CONFIG.Modeling.epsilon):
             return 0
 
         if np.isscalar(hours_per_timestep):
             hours_per_timestep = np.ones(len(binary_values)) * hours_per_timestep
         hours_per_timestep: np.ndarray
 
-        indexes_with_zero_values = np.where(np.isclose(binary_values, 0, atol=CONFIG.modeling.EPSILON))[0]
+        indexes_with_zero_values = np.where(np.isclose(binary_values, 0, atol=CONFIG.Modeling.epsilon))[0]
         if len(indexes_with_zero_values) == 0:
             nr_of_indexes_with_consecutive_ones = len(binary_values)
         else:

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/interface.py

@@ -650,10 +650,10 @@ class InvestParameters(Interface):
         fixed_size: When specified, creates a binary investment decision at exactly
             this size. When None, allows continuous sizing between minimum and maximum bounds.
         minimum_size: Lower bound for continuous sizing decisions. Defaults to a small
-            positive value (CONFIG.modeling.EPSILON) to avoid numerical issues.
+            positive value (CONFIG.Modeling.epsilon) to avoid numerical issues.
             Ignored when fixed_size is specified.
         maximum_size: Upper bound for continuous sizing decisions. Defaults to a large
-            value (CONFIG.modeling.BIG) representing unlimited capacity.
+            value (CONFIG.Modeling.big) representing unlimited capacity.
             Ignored when fixed_size is specified.
         optional: Controls whether investment is required. When True (default),
             optimization can choose not to invest. When False, forces investment
@@ -833,8 +833,8 @@ class InvestParameters(Interface):
         self.optional = optional
         self.specific_effects: EffectValuesUserScalar = specific_effects or {}
         self.piecewise_effects = piecewise_effects
-        self._minimum_size = minimum_size if minimum_size is not None else CONFIG.modeling.EPSILON
-        self._maximum_size = maximum_size if maximum_size is not None else CONFIG.modeling.BIG  # default maximum
+        self._minimum_size = minimum_size if minimum_size is not None else CONFIG.Modeling.epsilon
+        self._maximum_size = maximum_size if maximum_size is not None else CONFIG.Modeling.big  # default maximum
 
     def transform_data(self, flow_system: FlowSystem):
         self.fix_effects = flow_system.effects.create_effect_values_dict(self.fix_effects)

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/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.dist-info → flixopt-2.2.0.dist-info}/METADATA

@@ -1,16 +1,15 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.10
+Version: 2.2.0
 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"
@@ -55,10 +53,10 @@ 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: ruff==0.13.2; extra == "dev"
 Requires-Dist: pre-commit==4.3.0; extra == "dev"
 Requires-Dist: pyvis==0.3.2; extra == "dev"
-Requires-Dist: tsam==2.3.1; extra == "dev"
+Requires-Dist: tsam==2.3.9; 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"
@@ -67,7 +65,7 @@ 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==9.6.19; extra == "docs"
+Requires-Dist: mkdocs-material==9.6.20; 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"

flixopt-2.2.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+flixopt/__init__.py,sha256=WodgPpH8UHORIGh9EucATUTK6ct4ebPDBuSxymZgl3E,666
+flixopt/aggregation.py,sha256=BFy2ngr0a0By5wfBZet9fX8X5ZPmkn1x6HMRaw1ZsTo,16892
+flixopt/calculation.py,sha256=2Dfgpwjmg_dCz9jWHOUpEwIgzggvIPXhiIg8nGl1YMc,24476
+flixopt/commons.py,sha256=ZNlUN1z-h9OGHPo-s-n5OLlJaoPZKVGcAdRyGKpMk4M,1256
+flixopt/components.py,sha256=GhALvEkjGagm6iy2VxU3lVkUPlQOtsnFmu6ZsUDrcwM,54632
+flixopt/config.py,sha256=Gy2k1J4A-TS01jILwgUy9xp38AEMawU_pk0_XseufKI,19889
+flixopt/core.py,sha256=HnXnUXnAL8yqBExdsXGgwu5HnfWRH0omjjMKgp_SBKc,37824
+flixopt/effects.py,sha256=HcalPMUaAfuzD2p1OeQ9nLY2vmHv_GxwyGLLeqNGNZ8,19435
+flixopt/elements.py,sha256=tzQVeh1z98CDv2nm8wiwxY_B2cKMLLZyYwGAoYsNLso,33535
+flixopt/features.py,sha256=hX2485foIxzKQ6DMv73FlIXcSmVhe6n1taeLmfyXE-A,43891
+flixopt/flow_system.py,sha256=tOOGtEzZFISL87lmxNOsYf9uiSfE9XLUzenDBsSf8ns,20895
+flixopt/interface.py,sha256=sBJJxVKIPrl3w8NQ-BRnr_1C65A5i1ZWispPdV6YeVM,47575
+flixopt/io.py,sha256=huFIS1c_1qXR5LJBl1hUmaN_nCxqj0GC1MUqvzObMfA,11477
+flixopt/linear_converters.py,sha256=rKa0AZlJHgDsPF_LVsvrhxhsmVTRanPE0NuKP7OICtg,22668
+flixopt/network_app.py,sha256=LnVAlAgzL1BgMYLsJ20a62j6nQUmNccF1zo4ACUXzL4,29433
+flixopt/plotting.py,sha256=cGM8f5QDMOkKuBapgD6-EhN1X-f5WkDqyoxGPberjzI,59661
+flixopt/results.py,sha256=zSOFbDV7gpvoEUvRvmlP5JUHe-QhOJOuGKgZUsFjiGQ,40701
+flixopt/solvers.py,sha256=m38Smc22MJfHYMiqfNf1MA3OmvbTRm5OWS9nECkDdQk,2355
+flixopt/structure.py,sha256=vyD1lc80NH3JLexKJuar9btgHhEbcNEmihCQkBWea8k,26254
+flixopt/utils.py,sha256=a-YKR7C7HtD8dSIcxzlJTgryV5HMS7zELSXNYr_Lz9Q,1775
+flixopt-2.2.0.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
+flixopt-2.2.0.dist-info/METADATA,sha256=yvVKc1LFjiGo8zDKAVQcaSsMzlrEDbXsn3nhoi4kg0o,8385
+flixopt-2.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flixopt-2.2.0.dist-info/top_level.txt,sha256=fanTzb9NylIXfv6Ic7spU97fVmRgGDPKvI_91tw4S3E,8
+flixopt-2.2.0.dist-info/RECORD,,

flixopt-2.2.0.dist-info/top_level.txt

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

docs/examples/00-Minimal Example.md

@@ -1,5 +0,0 @@
-# Minimal Example
-
-```python
-{! ../examples/00_Minmal/minimal_example.py !}
-```

docs/examples/01-Basic Example.md

@@ -1,5 +0,0 @@
-# Simple example
-
-```python
-{! ../examples/01_Simple/simple_example.py !}
-```

docs/examples/02-Complex Example.md

@@ -1,10 +0,0 @@
-# Complex example
-This saves the results of a calculation to file and reloads them to analyze the results
-## Build the Model
-```python
-{! ../examples/02_Complex/complex_example.py !}
-```
-## Load the Results from file
-```python
-{! ../examples/02_Complex/complex_example_results.py !}
-```

docs/examples/03-Calculation Modes.md

@@ -1,5 +0,0 @@
-# Calculation Mode comparison
-**Note:** This example relies on time series data. You can find it in the `examples` folder of the FlixOpt repository.
-```python
-{! ../examples/03_Calculation_types/example_calculation_types.py !}
-```

docs/examples/index.md

@@ -1,5 +0,0 @@
-# Examples
-
-Here you can find a collection of examples that demonstrate how to use FlixOpt.
-
-We work on improving this gallery. If you have something to share, please contact us!

docs/faq/contribute.md

@@ -1,61 +0,0 @@
-# Contributing to the Project
-
-We warmly welcome contributions from the community! This guide will help you get started with contributing to our project.
-
-## Development Setup
-1. Clone the repository `git clone https://github.com/flixOpt/flixopt.git`
-2. Install the development dependencies `pip install -e ".[dev]"`
-3. Install pre-commit hooks `pre-commit install` (one-time setup)
-4. Run `pytest` to ensure your code passes all tests
-
-## Code Quality
-We use [Ruff](https://github.com/astral-sh/ruff) for linting and formatting. After the one-time setup above, **code quality checks run automatically on every commit**.
-
-To run manually:
-- `ruff check --fix .` to check and fix linting issues
-- `ruff format .` to format code
-
-## Documentation (Optional)
-FlixOpt uses [mkdocs](https://www.mkdocs.org/) to generate documentation.
-To work on documentation:
-```bash
-pip install -e ".[docs]"
-mkdocs serve
-```
-Then navigate to http://127.0.0.1:8000/
-
-## Testing
-- `pytest` to run the test suite
-- You can also run the provided python script `run_all_test.py`
-
----
-# Best practices
-
-## Coding Guidelines
-
-- Follow PEP 8 style guidelines
-- Write clear, commented code
-- Include type hints
-- Create or update tests for new functionality
-- Ensure 100% test coverage for new code
-
-## Branches
-As we start to think FlixOpt in **Releases**, we decided to introduce multiple **dev**-branches instead of only one:
-Following the **Semantic Versioning** guidelines, we introduced:
-- `next/patch`: This is where all pull requests for the next patch release (1.0.x) go.
-- `next/minor`: This is where all pull requests for the next minor release (1.x.0) go.
-- `next/major`: This is where all pull requests for the next major release (x.0.0) go.
-
-Everything else remains in `feature/...`-branches.
-
-## Pull requests
-Every feature or bugfix should be merged into one of the 3 [release branches](#branches), using **Squash and merge** or a regular **single commit**.
-At some point, `next/minor` or `next/major` will get merged into `main` using a regular **Merge**  (not squash).
-*This ensures that Features are kept separate, and the `next/...`branches stay in synch with ``main`.*
-
-## Releases
-As stated, we follow **Semantic Versioning**.
-Right after one of the 3 [release branches](#branches) is merged into main, a **Tag** should be added to the merge commit and pushed to the main branch. The tag has the form `v1.2.3`.
-With this tag,  a release with **Release Notes** must be created.
-
-*This is our current best practice*

docs/faq/index.md

@@ -1,3 +0,0 @@
-# Frequently Asked Questions
-
-## Work in progress