flixopt 3.0.0__tar.gz → 3.0.1__tar.gz

{flixopt-3.0.0 → flixopt-3.0.1}/CHANGELOG.md

@@ -69,8 +69,22 @@ Please keep the format of the changelog consistent with the other releases, so t
 ---
 Until here -->
 
+## [3.0.1] - 2025-10-14
+**Summary**: Adding a Migration Guide for the new **flixopt 3** and fixing docs
+See the [Migration Guide](https://flixopt.github.io/flixopt/user-guide/migration-guide-v3/).
+
+### 📝 Docs
+- Fixed deployed docs
+- Added Migration Guide for flixopt 3
+
+### 👷 Development
+- Added missing type hints
+
+---
+
 ## [3.0.0] - 2025-10-13
 **Summary**: This release introduces new model dimensions (periods and scenarios) for multi-period investments and stochastic modeling, along with a redesigned effect sharing system and enhanced I/O capabilities.
+For detailed migration instructions, see the [Migration Guide](https://flixopt.github.io/flixopt/user-guide/migration-guide-v3/).
 
 ### ✨ Added
 

{flixopt-3.0.0/flixopt.egg-info → flixopt-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 3.0.0
+Version: 3.0.1
 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>
@@ -54,7 +54,7 @@ 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.2; extra == "dev"
+Requires-Dist: ruff==0.13.3; extra == "dev"
 Requires-Dist: pre-commit==4.3.0; extra == "dev"
 Requires-Dist: pyvis==0.3.2; extra == "dev"
 Requires-Dist: tsam==2.3.9; extra == "dev"
@@ -66,7 +66,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.20; extra == "docs"
+Requires-Dist: mkdocs-material==9.6.21; 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-3.0.0 → flixopt-3.0.1}/flixopt/calculation.py

@@ -23,7 +23,7 @@ import yaml
 
 from . import io as fx_io
 from . import utils as utils
-from .aggregation import AggregationModel, AggregationParameters
+from .aggregation import Aggregation, AggregationModel, AggregationParameters
 from .components import Storage
 from .config import CONFIG
 from .core import DataConverter, Scalar, TimeSeriesData, drop_constant_arrays
@@ -286,7 +286,10 @@ class AggregatedCalculation(FullCalculation):
             This equalizes variables in the components according to the typical periods computed in the aggregation
         active_timesteps: DatetimeIndex of timesteps to use for calculation. If None, all timesteps are used
         folder: Folder where results should be saved. If None, current working directory is used
-        aggregation: contains the aggregation model
+
+    Attributes:
+        aggregation (Aggregation | None): Contains the clustered time series data
+        aggregation_model (AggregationModel | None): Contains Variables and Constraints that equalize clusters of the time series data
     """
 
     def __init__(
@@ -306,7 +309,8 @@ class AggregatedCalculation(FullCalculation):
         super().__init__(name, flow_system, active_timesteps, folder=folder)
         self.aggregation_parameters = aggregation_parameters
         self.components_to_clusterize = components_to_clusterize
-        self.aggregation = None
+        self.aggregation: Aggregation | None = None
+        self.aggregation_model: AggregationModel | None = None
 
     def do_modeling(self) -> AggregatedCalculation:
         t_start = timeit.default_timer()
@@ -317,10 +321,10 @@ class AggregatedCalculation(FullCalculation):
         self.model = self.flow_system.create_model(self.normalize_weights)
         self.model.do_modeling()
         # Add Aggregation Submodel after modeling the rest
-        self.aggregation = AggregationModel(
+        self.aggregation_model = AggregationModel(
             self.model, self.aggregation_parameters, self.flow_system, self.aggregation, self.components_to_clusterize
         )
-        self.aggregation.do_modeling()
+        self.aggregation_model.do_modeling()
         self.durations['modeling'] = round(timeit.default_timer() - t_start, 2)
         return self
 

{flixopt-3.0.0 → flixopt-3.0.1}/flixopt/config.py

@@ -286,7 +286,7 @@ class CONFIG:
                 setattr(cls, key, value)
 
     @classmethod
-    def to_dict(cls):
+    def to_dict(cls) -> dict:
         """Convert the configuration class into a dictionary for JSON serialization.
 
         Returns:

{flixopt-3.0.0 → flixopt-3.0.1}/flixopt/core.py

@@ -6,7 +6,7 @@ It provides Datatypes, logging functionality, and some functions to transform da
 import logging
 import warnings
 from itertools import permutations
-from typing import Literal, Union
+from typing import Any, Literal, Union
 
 import numpy as np
 import pandas as pd
@@ -46,12 +46,12 @@ class TimeSeriesData(xr.DataArray):
 
     def __init__(
         self,
-        *args,
+        *args: Any,
         aggregation_group: str | None = None,
         aggregation_weight: float | None = None,
         agg_group: str | None = None,
         agg_weight: float | None = None,
-        **kwargs,
+        **kwargs: Any,
     ):
         """
         Args:

{flixopt-3.0.0 → flixopt-3.0.1}/flixopt/modeling.py

@@ -396,7 +396,7 @@ class BoundingPatterns:
         variable: linopy.Variable,
         bounds: tuple[TemporalData, TemporalData],
         name: str = None,
-    ):
+    ) -> list[linopy.constraints.Constraint]:
         """Create simple bounds.
         variable ∈ [lower_bound, upper_bound]
 
@@ -409,9 +409,7 @@ class BoundingPatterns:
             bounds: Tuple of (lower_bound, upper_bound) absolute bounds
 
         Returns:
-            Tuple containing:
-                - variables (Dict): Empty dict
-                - constraints (Dict[str, linopy.Constraint]): 'ub', 'lb'
+            List containing lower_bound and upper_bound constraints
         """
         if not isinstance(model, Submodel):
             raise ValueError('BoundingPatterns.basic_bounds() can only be used with a Submodel')

{flixopt-3.0.0 → flixopt-3.0.1}/flixopt/results.py

@@ -1243,7 +1243,7 @@ class ComponentResults(_NodeResults):
 class EffectResults(_ElementResults):
     """Results for an Effect"""
 
-    def get_shares_from(self, element: str):
+    def get_shares_from(self, element: str) -> xr.Dataset:
         """Get effect shares from specific element.
 
         Args:
@@ -1399,7 +1399,7 @@ class SegmentedCalculationResults:
         )
 
     @classmethod
-    def from_file(cls, folder: str | pathlib.Path, name: str):
+    def from_file(cls, folder: str | pathlib.Path, name: str) -> SegmentedCalculationResults:
         """Load SegmentedCalculationResults from saved files.
 
         Args:

{flixopt-3.0.0 → flixopt-3.0.1}/flixopt/utils.py

@@ -5,7 +5,7 @@ This module contains several utility functions used throughout the flixopt frame
 from __future__ import annotations
 
 import logging
-from typing import Literal
+from typing import Any, Literal
 
 import numpy as np
 import xarray as xr
@@ -13,7 +13,7 @@ import xarray as xr
 logger = logging.getLogger('flixopt')
 
 
-def round_nested_floats(obj, decimals=2):
+def round_nested_floats(obj: dict | list | float | int | Any, decimals: int = 2) -> dict | list | float | int | Any:
     """Recursively round floating point numbers in nested data structures.
 
     This function traverses nested data structures (dictionaries, lists) and rounds
@@ -27,9 +27,7 @@ def round_nested_floats(obj, decimals=2):
         decimals (int, optional): Number of decimal places to round to. Defaults to 2.
 
     Returns:
-        The processed object with the same structure as the input, but with all
-        floating point numbers rounded to the specified precision. NumPy arrays
-        and xarray DataArrays are converted to lists.
+        The processed object with the same structure as the input, but with all floating point numbers rounded to the specified precision. NumPy arrays and xarray DataArrays are converted to lists.
 
     Examples:
         >>> data = {'a': 3.14159, 'b': [1.234, 2.678]}

{flixopt-3.0.0 → flixopt-3.0.1/flixopt.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 3.0.0
+Version: 3.0.1
 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>
@@ -54,7 +54,7 @@ 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.2; extra == "dev"
+Requires-Dist: ruff==0.13.3; extra == "dev"
 Requires-Dist: pre-commit==4.3.0; extra == "dev"
 Requires-Dist: pyvis==0.3.2; extra == "dev"
 Requires-Dist: tsam==2.3.9; extra == "dev"
@@ -66,7 +66,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.20; extra == "docs"
+Requires-Dist: mkdocs-material==9.6.21; 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-3.0.0 → flixopt-3.0.1}/flixopt.egg-info/requires.txt

@@ -17,7 +17,7 @@ numexpr<2.14,>=2.8.4
 pytest==8.4.2
 pytest-xdist==3.8.0
 nbformat==5.10.4
-ruff==0.13.2
+ruff==0.13.3
 pre-commit==4.3.0
 pyvis==0.3.2
 tsam==2.3.9
@@ -30,7 +30,7 @@ networkx==3.0.0
 werkzeug==3.0.0
 
 [docs]
-mkdocs-material==9.6.20
+mkdocs-material==9.6.21
 mkdocstrings-python==1.18.2
 mkdocs-table-reader-plugin==3.1.0
 mkdocs-gen-files==0.5.0

{flixopt-3.0.0 → flixopt-3.0.1}/pyproject.toml

@@ -83,7 +83,7 @@ dev = [
     "pytest==8.4.2",
     "pytest-xdist==3.8.0",
     "nbformat==5.10.4",
-    "ruff==0.13.2",
+    "ruff==0.13.3",
     "pre-commit==4.3.0",
     "pyvis==0.3.2",
     "tsam==2.3.9",
@@ -98,7 +98,7 @@ dev = [
 
 # Documentation building
 docs = [
-    "mkdocs-material==9.6.20",
+    "mkdocs-material==9.6.21",
     "mkdocstrings-python==1.18.2",
     "mkdocs-table-reader-plugin==3.1.0",
     "mkdocs-gen-files==0.5.0",