flixopt 2.1.6__py3-none-any.whl → 2.1.8__py3-none-any.whl

flixopt/solvers.py

@@ -2,9 +2,11 @@
 This module contains the solvers of the flixopt framework, making them available to the end user in a compact way.
 """
 
+from __future__ import annotations
+
 import logging
 from dataclasses import dataclass, field
-from typing import Any, ClassVar, Dict, Optional
+from typing import Any, ClassVar
 
 logger = logging.getLogger('flixopt')
 
@@ -14,41 +16,42 @@ class _Solver:
     """
     Abstract base class for solvers.
 
-    Attributes:
-        mip_gap (float): Solver's mip gap setting. The MIP gap describes the accepted (MILP) objective,
-            and the lower bound, which is the theoretically optimal solution (LP)
-        logfile_name (str): Filename for saving the solver log.
+    Args:
+        mip_gap: Acceptable relative optimality gap in [0.0, 1.0].
+        time_limit_seconds: Time limit in seconds.
+        extra_options: Additional solver options merged into `options`.
     """
 
     name: ClassVar[str]
     mip_gap: float
     time_limit_seconds: int
-    extra_options: Dict[str, Any] = field(default_factory=dict)
+    extra_options: dict[str, Any] = field(default_factory=dict)
 
     @property
-    def options(self) -> Dict[str, Any]:
+    def options(self) -> dict[str, Any]:
         """Return a dictionary of solver options."""
         return {key: value for key, value in {**self._options, **self.extra_options}.items() if value is not None}
 
     @property
-    def _options(self) -> Dict[str, Any]:
+    def _options(self) -> dict[str, Any]:
         """Return a dictionary of solver options, translated to the solver's API."""
         raise NotImplementedError
 
 
 class GurobiSolver(_Solver):
     """
+    Gurobi solver configuration.
+
     Args:
-        mip_gap (float): Solver's mip gap setting. The MIP gap describes the accepted (MILP) objective,
-            and the lower bound, which is the theoretically optimal solution (LP)
-        time_limit_seconds (int): Solver's time limit in seconds.
-        extra_options (str): Filename for saving the solver log.
+        mip_gap: Acceptable relative optimality gap in [0.0, 1.0]; mapped to Gurobi `MIPGap`.
+        time_limit_seconds: Time limit in seconds; mapped to Gurobi `TimeLimit`.
+        extra_options: Additional solver options merged into `options`.
     """
 
     name: ClassVar[str] = 'gurobi'
 
     @property
-    def _options(self) -> Dict[str, Any]:
+    def _options(self) -> dict[str, Any]:
         return {
             'MIPGap': self.mip_gap,
             'TimeLimit': self.time_limit_seconds,
@@ -57,19 +60,20 @@ class GurobiSolver(_Solver):
 
 class HighsSolver(_Solver):
     """
-    Args:
-        mip_gap (float): Solver's mip gap setting. The MIP gap describes the accepted (MILP) objective,
-            and the lower bound, which is the theoretically optimal solution (LP)
-        time_limit_seconds (int): Solver's time limit in seconds.
-        threads (int): Number of threads to use.
-        extra_options (str): Filename for saving the solver log.
+    HiGHS solver configuration.
+
+    Attributes:
+        mip_gap: Acceptable relative optimality gap in [0.0, 1.0]; mapped to HiGHS `mip_rel_gap`.
+        time_limit_seconds: Time limit in seconds; mapped to HiGHS `time_limit`.
+        extra_options: Additional solver options merged into `options`.
+        threads (int | None): Number of threads to use. If None, HiGHS chooses.
     """
 
-    threads: Optional[int] = None
+    threads: int | None = None
     name: ClassVar[str] = 'highs'
 
     @property
-    def _options(self) -> Dict[str, Any]:
+    def _options(self) -> dict[str, Any]:
         return {
             'mip_rel_gap': self.mip_gap,
             'time_limit': self.time_limit_seconds,

flixopt/structure.py

@@ -3,25 +3,28 @@ This module contains the core structure of the flixopt framework.
 These classes are not directly used by the end user, but are used by other modules.
 """
 
+from __future__ import annotations
+
 import inspect
 import json
 import logging
-import pathlib
 from datetime import datetime
 from io import StringIO
-from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, Tuple, Union
+from typing import TYPE_CHECKING, Any, Literal
 
 import linopy
 import numpy as np
-import pandas as pd
 import xarray as xr
 from rich.console import Console
 from rich.pretty import Pretty
 
-from .config import CONFIG
-from .core import NumericData, Scalar, TimeSeries, TimeSeriesCollection, TimeSeriesData
+from .core import TimeSeries, TimeSeriesData
 
 if TYPE_CHECKING:  # for type checking and preventing circular imports
+    import pathlib
+
+    import pandas as pd
+
     from .effects import EffectCollectionModel
     from .flow_system import FlowSystem
 
@@ -49,7 +52,7 @@ class SystemModel(linopy.Model):
     It is used to create and store the variables and constraints for the flow_system.
     """
 
-    def __init__(self, flow_system: 'FlowSystem'):
+    def __init__(self, flow_system: FlowSystem):
         """
         Args:
             flow_system: The flow_system that is used to create the model.
@@ -57,7 +60,7 @@ class SystemModel(linopy.Model):
         super().__init__(force_dim_names=True)
         self.flow_system = flow_system
         self.time_series_collection = flow_system.time_series_collection
-        self.effects: Optional[EffectCollectionModel] = None
+        self.effects: EffectCollectionModel | None = None
 
     def do_modeling(self):
         self.effects = self.flow_system.effects.create_model(self)
@@ -99,11 +102,11 @@ class SystemModel(linopy.Model):
         return self.time_series_collection.hours_of_previous_timesteps
 
     @property
-    def coords(self) -> Tuple[pd.DatetimeIndex]:
+    def coords(self) -> tuple[pd.DatetimeIndex]:
         return (self.time_series_collection.timesteps,)
 
     @property
-    def coords_extra(self) -> Tuple[pd.DatetimeIndex]:
+    def coords_extra(self) -> tuple[pd.DatetimeIndex]:
         return (self.time_series_collection.timesteps_extra,)
 
 
@@ -112,11 +115,11 @@ class Interface:
     This class is used to collect arguments about a Model. Its the base class for all Elements and Models in flixopt.
     """
 
-    def transform_data(self, flow_system: 'FlowSystem'):
+    def transform_data(self, flow_system: FlowSystem):
         """Transforms the data of the interface to match the FlowSystem's dimensions"""
         raise NotImplementedError('Every Interface needs a transform_data() method')
 
-    def infos(self, use_numpy: bool = True, use_element_label: bool = False) -> Dict:
+    def infos(self, use_numpy: bool = True, use_element_label: bool = False) -> dict:
         """
         Generate a dictionary representation of the object's constructor arguments.
         Excludes default values and empty dictionaries and lists.
@@ -150,7 +153,7 @@ class Interface:
             details[name] = copy_and_convert_datatypes(value, use_numpy, use_element_label)
         return details
 
-    def to_json(self, path: Union[str, pathlib.Path]):
+    def to_json(self, path: str | pathlib.Path):
         """
         Saves the element to a json file.
         This not meant to be reloaded and recreate the object, but rather used to document or compare the object.
@@ -162,7 +165,7 @@ class Interface:
         with open(path, 'w', encoding='utf-8') as f:
             json.dump(data, f, indent=4, ensure_ascii=False)
 
-    def to_dict(self) -> Dict:
+    def to_dict(self) -> dict:
         """Convert the object to a dictionary representation."""
         data = {'__class__': self.__class__.__name__}
 
@@ -200,7 +203,7 @@ class Interface:
         return {k: self._serialize_value(v) for k, v in d.items()}
 
     @classmethod
-    def _deserialize_dict(cls, data: Dict) -> Union[Dict, 'Interface']:
+    def _deserialize_dict(cls, data: dict) -> dict | Interface:
         if '__class__' in data:
             class_name = data.pop('__class__')
             try:
@@ -217,7 +220,7 @@ class Interface:
             return {k: cls._deserialize_value(v) for k, v in data.items()}
 
     @classmethod
-    def _deserialize_list(cls, data: List) -> List:
+    def _deserialize_list(cls, data: list) -> list:
         return [cls._deserialize_value(value) for value in data]
 
     @classmethod
@@ -232,7 +235,7 @@ class Interface:
         return value
 
     @classmethod
-    def from_dict(cls, data: Dict) -> 'Interface':
+    def from_dict(cls, data: dict) -> Interface:
         """
         Create an instance from a dictionary representation.
 
@@ -257,7 +260,7 @@ class Interface:
 class Element(Interface):
     """This class is the basic Element of flixopt. Every Element has a label"""
 
-    def __init__(self, label: str, meta_data: Dict = None):
+    def __init__(self, label: str, meta_data: dict | None = None):
         """
         Args:
             label: The label of the element
@@ -265,13 +268,14 @@ class Element(Interface):
         """
         self.label = Element._valid_label(label)
         self.meta_data = meta_data if meta_data is not None else {}
-        self.model: Optional[ElementModel] = None
+        self.model: ElementModel | None = None
 
     def _plausibility_checks(self) -> None:
-        """This function is used to do some basic plausibility checks for each Element during initialization"""
+        """This function is used to do some basic plausibility checks for each Element during initialization.
+        This is run after all data is transformed to the correct format/type"""
         raise NotImplementedError('Every Element needs a _plausibility_checks() method')
 
-    def create_model(self, model: SystemModel) -> 'ElementModel':
+    def create_model(self, model: SystemModel) -> ElementModel:
         raise NotImplementedError('Every Element needs a create_model() method')
 
     @property
@@ -303,9 +307,7 @@ class Element(Interface):
 class Model:
     """Stores Variables and Constraints."""
 
-    def __init__(
-        self, model: SystemModel, label_of_element: str, label: str = '', label_full: Optional[str] = None
-    ):
+    def __init__(self, model: SystemModel, label_of_element: str, label: str = '', label_full: str | None = None):
         """
         Args:
             model: The SystemModel that is used to create the model.
@@ -318,21 +320,21 @@ class Model:
         self._label = label
         self._label_full = label_full
 
-        self._variables_direct: List[str] = []
-        self._constraints_direct: List[str] = []
-        self.sub_models: List[Model] = []
+        self._variables_direct: list[str] = []
+        self._constraints_direct: list[str] = []
+        self.sub_models: list[Model] = []
 
-        self._variables_short: Dict[str, str] = {}
-        self._constraints_short: Dict[str, str] = {}
-        self._sub_models_short: Dict[str, str] = {}
+        self._variables_short: dict[str, str] = {}
+        self._constraints_short: dict[str, str] = {}
+        self._sub_models_short: dict[str, str] = {}
         logger.debug(f'Created {self.__class__.__name__}  "{self.label_full}"')
 
     def do_modeling(self):
         raise NotImplementedError('Every Model needs a do_modeling() method')
 
     def add(
-        self, item: Union[linopy.Variable, linopy.Constraint, 'Model'], short_name: Optional[str] = None
-    ) -> Union[linopy.Variable, linopy.Constraint, 'Model']:
+        self, item: linopy.Variable | linopy.Constraint | Model, short_name: str | None = None
+    ) -> linopy.Variable | linopy.Constraint | Model:
         """
         Add a variable, constraint or sub-model to the model
 
@@ -358,8 +360,8 @@ class Model:
 
     def filter_variables(
         self,
-        filter_by: Optional[Literal['binary', 'continuous', 'integer']] = None,
-        length: Literal['scalar', 'time'] = None,
+        filter_by: Literal['binary', 'continuous', 'integer'] | None = None,
+        length: Literal['scalar', 'time'] | None = None,
     ):
         if filter_by is None:
             all_variables = self.variables
@@ -401,7 +403,7 @@ class Model:
         return self._model.constraints[self._constraints_direct]
 
     @property
-    def _variables(self) -> List[str]:
+    def _variables(self) -> list[str]:
         all_variables = self._variables_direct.copy()
         for sub_model in self.sub_models:
             for variable in sub_model._variables:
@@ -413,7 +415,7 @@ class Model:
         return all_variables
 
     @property
-    def _constraints(self) -> List[str]:
+    def _constraints(self) -> list[str]:
         all_constraints = self._constraints_direct.copy()
         for sub_model in self.sub_models:
             for constraint in sub_model._constraints:
@@ -431,7 +433,7 @@ class Model:
         return self._model.constraints[self._constraints]
 
     @property
-    def all_sub_models(self) -> List['Model']:
+    def all_sub_models(self) -> list[Model]:
         return [model for sub_model in self.sub_models for model in [sub_model] + sub_model.all_sub_models]
 
 
@@ -549,7 +551,7 @@ def copy_and_convert_datatypes(data: Any, use_numpy: bool = True, use_element_la
         raise TypeError(f'copy_and_convert_datatypes() did get unexpected data of type "{type(data)}": {data=}')
 
 
-def get_compact_representation(data: Any, array_threshold: int = 50, decimals: int = 2) -> Dict:
+def get_compact_representation(data: Any, array_threshold: int = 50, decimals: int = 2) -> dict:
     """
     Generate a compact json serializable representation of deeply nested data.
     Numpy arrays are statistically described if they exceed a threshold and converted to lists.
@@ -560,7 +562,7 @@ def get_compact_representation(data: Any, array_threshold: int = 50, decimals: i
         decimals (int): Number of decimal places in which to describe the arrays.
 
     Returns:
-        Dict: A dictionary representation of the data
+        dict: A dictionary representation of the data
     """
 
     def format_np_array_if_found(value: Any) -> Any:
@@ -579,7 +581,7 @@ def get_compact_representation(data: Any, array_threshold: int = 50, decimals: i
             )
             return value
 
-    def describe_numpy_arrays(arr: np.ndarray) -> Union[str, List]:
+    def describe_numpy_arrays(arr: np.ndarray) -> str | list:
         """Shortens NumPy arrays if they exceed the specified length."""
 
         def normalized_center_of_mass(array: Any) -> float:

flixopt/utils.py

@@ -2,21 +2,24 @@
 This module contains several utility functions used throughout the flixopt framework.
 """
 
+from __future__ import annotations
+
 import logging
-from typing import Any, Dict, List, Literal, Optional, Union
+from typing import TYPE_CHECKING, Any, Literal
 
-import numpy as np
-import xarray as xr
+if TYPE_CHECKING:
+    import numpy as np
+    import xarray as xr
 
 logger = logging.getLogger('flixopt')
 
 
-def is_number(number_alias: Union[int, float, str]):
-    """Returns True is string is a number."""
+def is_number(number_alias: int | float | str) -> bool:
+    """Returns True if value is a number or a number-like string."""
     try:
         float(number_alias)
         return True
-    except ValueError:
+    except (ValueError, TypeError):
         return False
 
 
@@ -32,7 +35,7 @@ def round_floats(obj, decimals=2):
 
 def convert_dataarray(
     data: xr.DataArray, mode: Literal['py', 'numpy', 'xarray', 'structure']
-) -> Union[List, np.ndarray, xr.DataArray, str]:
+) -> list[Any] | np.ndarray | xr.DataArray | str:
     """
     Convert a DataArray to a different format.
 

{flixopt-2.1.6.dist-info → flixopt-2.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.6
+Version: 2.1.8
 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>
@@ -18,58 +18,64 @@ 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
 Requires-Dist: numpy<3,>=1.21.5
 Requires-Dist: pandas<3,>=2.0.0
-Requires-Dist: linopy<0.5.6,>=0.5.1
+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: 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: matplotlib<4.0.0,>=3.5.2
-Requires-Dist: plotly<6.0.0,>=5.15.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"
+Requires-Dist: highspy<2,>=1.5.3
+Requires-Dist: matplotlib<4,>=3.5.2
+Requires-Dist: plotly<7,>=5.15.0
 Provides-Extra: network-viz
-Requires-Dist: dash>=3.0.0; extra == "network-viz"
-Requires-Dist: dash-cytoscape>=1.0.0; extra == "network-viz"
-Requires-Dist: dash-daq>=0.6.0; extra == "network-viz"
-Requires-Dist: networkx>=3.0.0; extra == "network-viz"
-Requires-Dist: werkzeug>=3.0.0; extra == "network-viz"
+Requires-Dist: dash<4,>=3.0.0; extra == "network-viz"
+Requires-Dist: dash-cytoscape<2,>=1.0.0; extra == "network-viz"
+Requires-Dist: dash-daq<1,>=0.6.0; extra == "network-viz"
+Requires-Dist: networkx<4,>=3.0.0; extra == "network-viz"
+Requires-Dist: werkzeug<4,>=3.0.0; extra == "network-viz"
+Requires-Dist: flask<4,>=3.0.0; extra == "network-viz"
 Provides-Extra: full
-Requires-Dist: pyvis==0.3.1; 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: gurobipy>=10.0.0; extra == "full"
-Requires-Dist: dash>=3.0.0; extra == "full"
-Requires-Dist: dash-cytoscape>=1.0.0; extra == "full"
-Requires-Dist: dash-daq>=0.6.0; extra == "full"
-Requires-Dist: networkx>=3.0.0; extra == "full"
-Requires-Dist: werkzeug>=3.0.0; extra == "full"
+Requires-Dist: pyvis==0.3.2; extra == "full"
+Requires-Dist: tsam<3,>=2.3.1; extra == "full"
+Requires-Dist: scipy<2,>=1.15.1; extra == "full"
+Requires-Dist: gurobipy<13,>=10.0.0; extra == "full"
+Requires-Dist: dash<4,>=3.0.0; extra == "full"
+Requires-Dist: dash-cytoscape<2,>=1.0.0; extra == "full"
+Requires-Dist: dash-daq<1,>=0.6.0; extra == "full"
+Requires-Dist: networkx<4,>=3.0.0; extra == "full"
+Requires-Dist: werkzeug<4,>=3.0.0; extra == "full"
+Requires-Dist: flask<4,>=3.0.0; extra == "full"
 Provides-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<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"
-Requires-Dist: dash>=3.0.0; extra == "dev"
-Requires-Dist: dash-cytoscape>=1.0.0; extra == "dev"
-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"
+Requires-Dist: pytest==8.4.2; 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"
+Requires-Dist: pyvis==0.3.2; extra == "dev"
+Requires-Dist: tsam==2.3.1; 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"
+Requires-Dist: dash-cytoscape==1.0.2; extra == "dev"
+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<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"
+Requires-Dist: mkdocs-material==9.6.19; 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"
+Requires-Dist: mkdocs-include-markdown-plugin==7.1.7; extra == "docs"
+Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "docs"
+Requires-Dist: markdown-include==0.8.1; extra == "docs"
+Requires-Dist: pymdown-extensions==10.16.1; extra == "docs"
+Requires-Dist: pygments==2.19.2; extra == "docs"
+Requires-Dist: mike==2.1.3; extra == "docs"
 Dynamic: license-file
 
 # FlixOpt: Energy and Material Flow Optimization Framework
@@ -92,7 +98,7 @@ Dynamic: license-file
 
 **flixopt** provides a user-friendly interface with options for advanced users.
 
-It was originally developed by [TU Dresden](https://github.com/gewv-tu-dresden) as part of the SMARTBIOGRID project, funded by the German Federal Ministry for Economic Affairs and Energy (FKZ: 03KB159B). Building on the Matlab-based flixOptMat framework (developed in the FAKS project), FlixOpt also incorporates concepts from [oemof/solph](https://github.com/oemof/oemof-solph). 
+It was originally developed by [TU Dresden](https://github.com/gewv-tu-dresden) as part of the SMARTBIOGRID project, funded by the German Federal Ministry for Economic Affairs and Energy (FKZ: 03KB159B). Building on the Matlab-based flixOptMat framework (developed in the FAKS project), FlixOpt also incorporates concepts from [oemof/solph](https://github.com/oemof/oemof-solph).
 
 ---
 
@@ -117,7 +123,7 @@ It was originally developed by [TU Dresden](https://github.com/gewv-tu-dresden)
 
 - **Calculation Modes**
     - **Full** - Solve the model with highest accuracy and computational requirements.
-    - **Segmented** - Speed up solving by using a rolling horizon. 
+    - **Segmented** - Speed up solving by using a rolling horizon.
     - **Aggregated** - Speed up solving by identifying typical periods using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam). Suitable for large models.
 
 ---
@@ -139,22 +145,27 @@ The documentation is available at [https://flixopt.github.io/flixopt/latest/](ht
 
 ---
 
-## 🛠️ Solver Integration
+## 🎯️ Solver Integration
 
-By default, FlixOpt uses the open-source solver [HiGHS](https://highs.dev/) which is installed by default. However, it is compatible with additional solvers such as:  
+By default, FlixOpt uses the open-source solver [HiGHS](https://highs.dev/) which is installed by default. However, it is compatible with additional solvers such as:
 
-- [Gurobi](https://www.gurobi.com/)  
-- [CBC](https://github.com/coin-or/Cbc)  
+- [Gurobi](https://www.gurobi.com/)
+- [CBC](https://github.com/coin-or/Cbc)
 - [GLPK](https://www.gnu.org/software/glpk/)
 - [CPLEX](https://www.ibm.com/analytics/cplex-optimizer)
 
-For detailed licensing and installation instructions, refer to the respective solver documentation.  
+For detailed licensing and installation instructions, refer to the respective solver documentation.
+
+---
+
+## 🛠 Development Setup
+Look into our docs for [development setup](https://flixopt.github.io/flixopt/latest/contribute/)
 
 ---
 
 ## 📖 Citation
 
-If you use FlixOpt in your research or project, please cite the following:  
+If you use FlixOpt in your research or project, please cite the following:
 
-- **Main Citation:** [DOI:10.18086/eurosun.2022.04.07](https://doi.org/10.18086/eurosun.2022.04.07)  
-- **Short Overview:** [DOI:10.13140/RG.2.2.14948.24969](https://doi.org/10.13140/RG.2.2.14948.24969)  
+- **Main Citation:** [DOI:10.18086/eurosun.2022.04.07](https://doi.org/10.18086/eurosun.2022.04.07)
+- **Short Overview:** [DOI:10.13140/RG.2.2.14948.24969](https://doi.org/10.13140/RG.2.2.14948.24969)

flixopt-2.1.8.dist-info/RECORD

@@ -0,0 +1,56 @@
+docs/examples/00-Minimal Example.md,sha256=TjtnI8o96YNOCFwRC8BSXFGoVqfB53BtvOG4b29FwkQ,80
+docs/examples/01-Basic Example.md,sha256=sZHonC6A_wtZ2IEy_6BAMY8wViyIcivmcj8GYIZ_qck,78
+docs/examples/02-Complex Example.md,sha256=5cczYkXFpzpQTNp9dkmOEdTXxoWLETKty417q6MyT8s,287
+docs/examples/03-Calculation Modes.md,sha256=FZPBXmrkir6QhQsiXwWp2sOOntIIkODCgh3lVqOrP6w,231
+docs/examples/index.md,sha256=KwXrsxxiHk563bny4I4B2X_CfPNiSXx8TsfI671MLdg,179
+docs/faq/contribute.md,sha256=CL7Z85zyPes1Kl16_8oWLU2RTTbMdPfhmvt4tsnkikU,2508
+docs/faq/index.md,sha256=MH_SPZllm_5npxPP6DHXbJlpLXZc-nbWTFJvMmZYz9Q,50
+docs/images/architecture_flixOpt-pre2.0.0.png,sha256=9RWSA3vys588aadr2437zor-_-xBTQNQ0bAf8xGcu5g,70605
+docs/images/architecture_flixOpt.png,sha256=KjN1bJwESbkHmTW7UsJ7dZyiKZlTO7Dx20dg8KlR1HU,260219
+docs/images/flixopt-icon.svg,sha256=_1a6bk2pDOVEy233LC1nM6jZ35NdzD8Hd3UqGxW1Xpg,135341
+docs/javascripts/mathjax.js,sha256=LJDaO5MM_5W8gI5-S5SiZ17qeMgeoVJO-inMyBNy7UE,402
+docs/user-guide/index.md,sha256=TBO7lk13M95w2A9WiT5asfZn9oU9GZ1O0XW9eUm5GLo,7450
+docs/user-guide/Mathematical Notation/Bus.md,sha256=pqjGa3PZBSmuO4YR44bK21bMmRcWC8dkzP3z0XX-PJw,1613
+"docs/user-guide/Mathematical Notation/Effects, Penalty & Objective.md",sha256=vXQWt-UyITOVTJWPkKfjJzucbyml2OTQ6URQiMoc9dU,5671
+docs/user-guide/Mathematical Notation/Flow.md,sha256=zxCp02o0t2EwB-hlwGtmh8aQveRGgcgwqMN8MvLxaI0,1099
+docs/user-guide/Mathematical Notation/InvestParameters.md,sha256=UeuCpAyhOfDS2C3efmi_2EFkaFBK7HcqhHeBXl9BhFw,48
+docs/user-guide/Mathematical Notation/LinearConverter.md,sha256=mKYbpnYxXW9xI2ybVfAyxDJdwahnj7L9ZTY0mnq3_l0,1321
+docs/user-guide/Mathematical Notation/OnOffParameters.md,sha256=QEgxhqb53VlyBifIdExwaQpsdeE0Cyb8aN3-aCHQ21U,47
+docs/user-guide/Mathematical Notation/Piecewise.md,sha256=GgTQ7dVTTb0lq14GFuuZeGYrUXtMy1wkztJLIVchchw,1993
+docs/user-guide/Mathematical Notation/Storage.md,sha256=-QiZN2vA-f-P8JGkQDPYBdt2xt6J0Z2jbKDuk6j-rIs,2201
+docs/user-guide/Mathematical Notation/index.md,sha256=2d6k4zbKET1kg7zBt1fEdKsG8jM5j2IIe6yclMTUlDw,1254
+docs/user-guide/Mathematical Notation/others.md,sha256=z6LOzcnvfI-1qQx0Fg7Q6wSK9tAzH2d34KbW4lYNyCE,48
+flixopt/__init__.py,sha256=xTxHXC-_lWa65roGUM3J3HXfiYcMCJHoQsuL5mS0Xkg,688
+flixopt/aggregation.py,sha256=BFy2ngr0a0By5wfBZet9fX8X5ZPmkn1x6HMRaw1ZsTo,16892
+flixopt/calculation.py,sha256=VBcvpQr7ZXvWZfryfilwUzK161br4ZP3zTwvYHraGjY,24476
+flixopt/commons.py,sha256=ZNlUN1z-h9OGHPo-s-n5OLlJaoPZKVGcAdRyGKpMk4M,1256
+flixopt/components.py,sha256=efUwx_eqgVPsQEn8u0HUrgkvU2eU2tgv7wKwT2eeX_I,54632
+flixopt/config.py,sha256=2GJ9NZl35OKMUvofIpztgKh3kdca1m1wa77RjsUaob0,9509
+flixopt/config.yaml,sha256=imzAnnhcJhIfKNTTXFB5Td7Pvk5ARn5j720k-oGGRug,392
+flixopt/core.py,sha256=HnXnUXnAL8yqBExdsXGgwu5HnfWRH0omjjMKgp_SBKc,37824
+flixopt/effects.py,sha256=HcalPMUaAfuzD2p1OeQ9nLY2vmHv_GxwyGLLeqNGNZ8,19435
+flixopt/elements.py,sha256=IWtr0zyS1GEttYMiBZxC6sEX7y8pCWEbySxok3nDxwI,33535
+flixopt/features.py,sha256=m61ixTFJ_Jh-Emx6QKVxo04Heswm89XsPUqbH8ezNr8,43891
+flixopt/flow_system.py,sha256=qvR4uktXERDKCI40w9tJidkWxt5B36XVoebCw5bJons,20886
+flixopt/interface.py,sha256=e5tom-aTEPfl4FQg8abyDv7g1tTvxeOWiSWg_IGti-g,47575
+flixopt/io.py,sha256=BziCFlHfqx1kWFBhr1EZi-odZaqTVZdfmHhl-_rf5Ug,11367
+flixopt/linear_converters.py,sha256=rKa0AZlJHgDsPF_LVsvrhxhsmVTRanPE0NuKP7OICtg,22668
+flixopt/network_app.py,sha256=JlEbufeg3WK89ILwz2gXq6xdZzHEo5urIcz1eBpgJyc,29456
+flixopt/plotting.py,sha256=cGM8f5QDMOkKuBapgD6-EhN1X-f5WkDqyoxGPberjzI,59661
+flixopt/results.py,sha256=121FoO3WrAuHm18_-OP93_-9JxuCVVm5JWvmC33P3-8,40682
+flixopt/solvers.py,sha256=m38Smc22MJfHYMiqfNf1MA3OmvbTRm5OWS9nECkDdQk,2355
+flixopt/structure.py,sha256=vyD1lc80NH3JLexKJuar9btgHhEbcNEmihCQkBWea8k,26254
+flixopt/utils.py,sha256=a-YKR7C7HtD8dSIcxzlJTgryV5HMS7zELSXNYr_Lz9Q,1775
+flixopt-2.1.8.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=3UUE4hWhdd2t2m2x0ZpchGP-A0MvfqO2Wc5EdNN-fgE,1249
+scripts/gen_ref_pages.py,sha256=7bxRu2VfqFrnr7wln1BjMAqpQUzuTkLPJSBh83uikIQ,1948
+tests/ressources/Zeitreihen2020.csv,sha256=kbsDTKZS0iUsNZAS7m3DohzZI_OHHWe44s3GwLvcTLw,1918412
+flixopt-2.1.8.dist-info/METADATA,sha256=OMNIQF_kyzEFA1H3d-IUWwEEL84bG4t8KfS2nbW-TTU,8432
+flixopt-2.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flixopt-2.1.8.dist-info/top_level.txt,sha256=DEuo4R1z7GmEp5R3pjbQEJbaPRjKHFvNX2ceiBnVOL0,32
+flixopt-2.1.8.dist-info/RECORD,,

scripts/extract_release_notes.py

@@ -11,10 +11,10 @@ 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")
+    changelog_path = Path('CHANGELOG.md')
 
     if not changelog_path.exists():
-        print("❌ Error: CHANGELOG.md not found", file=sys.stderr)
+        print('❌ Error: CHANGELOG.md not found', file=sys.stderr)
         sys.exit(1)
 
     content = changelog_path.read_text(encoding='utf-8')
@@ -32,8 +32,8 @@ def extract_release_notes(version: str) -> str:
 
 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")
+        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]
@@ -41,5 +41,5 @@ def main():
     print(release_notes)
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     main()