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

docs/examples/00-Minimal Example.md

@@ -2,4 +2,4 @@
 
 ```python
 {! ../examples/00_Minmal/minimal_example.py !}
-```
+```

docs/examples/01-Basic Example.md

@@ -2,4 +2,4 @@
 
 ```python
 {! ../examples/01_Simple/simple_example.py !}
-```
+```

docs/examples/02-Complex Example.md

@@ -7,4 +7,4 @@ This saves the results of a calculation to file and reloads them to analyze the
 ## Load the Results from file
 ```python
 {! ../examples/02_Complex/complex_example_results.py !}
-```
+```

docs/examples/index.md

@@ -2,4 +2,4 @@
 
 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!
+We work on improving this gallery. If you have something to share, please contact us!

docs/faq/contribute.md

@@ -4,17 +4,29 @@ We warmly welcome contributions from the community! This guide will help you get
 
 ## Development Setup
 1. Clone the repository `git clone https://github.com/flixOpt/flixopt.git`
-2. Install the development dependencies `pip install -editable .[dev, docs]`
-3. Run `pytest` and `ruff check .` to ensure your code passes all tests
-
-## Documentation
-FlixOpt uses [mkdocs](https://www.mkdocs.org/) to generate documentation. To preview the documentation locally, run `mkdocs serve` in the root directory.
-
-## Helpful Commands
-- `mkdocs serve` to preview the documentation locally. Navigate to `http://127.0.0.1:8000/` to view the documentation.
-- `pytest` to run the test suite (You can also run the provided python script `run_all_test.py`)
-- `ruff check .` to run the linter
-- `ruff check . --fix` to automatically fix linting issues
+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
@@ -30,8 +42,8 @@ FlixOpt uses [mkdocs](https://www.mkdocs.org/) to generate documentation. To pre
 ## 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/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.
@@ -44,6 +56,6 @@ At some point, `next/minor` or `next/major` will get merged into `main` using a
 ## 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. 
+With this tag,  a release with **Release Notes** must be created.
 
 *This is our current best practice*

docs/faq/index.md

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

docs/javascripts/mathjax.js

@@ -15,4 +15,4 @@ document$.subscribe(() => {
   MathJax.typesetClear()
   MathJax.texReset()
   MathJax.typesetPromise()
-})
+})

docs/user-guide/Mathematical Notation/Bus.md

@@ -30,4 +30,4 @@ With:
 - $\phi_\text{in}(\text{t}_i)$ and $\phi_\text{out}(\text{t}_i)$ being the missing or excess flow-rate at time $\text{t}_i$, respectively
 - $\text{t}_i$ being the time step
 - $s_{b \rightarrow \Phi}(\text{t}_i)$ being the penalty term
-- $\text a_{b \rightarrow \Phi}(\text{t}_i)$ being the penalty coefficient (`excess_penalty_per_flow_hour`)
+- $\text a_{b \rightarrow \Phi}(\text{t}_i)$ being the penalty coefficient (`excess_penalty_per_flow_hour`)

docs/user-guide/Mathematical Notation/Effects, Penalty & Objective.md

@@ -8,17 +8,17 @@ These arise from so called **Shares**, which originate from **Elements** like [F
 Assiziated effects could be:
 - costs - given in [€/kWh]...
 - ...or emissions - given in [kg/kWh].
-- 
+-
 Effects are allocated seperatly for investments and operation.
 
 ### Shares to Effects
 
 $$ \label{eq:Share_invest}
-s_{l \rightarrow e, \text{inv}} = \sum_{v \in \mathcal{V}_{l, \text{inv}}} v \cdot \text a_{v \rightarrow e} 
+s_{l \rightarrow e, \text{inv}} = \sum_{v \in \mathcal{V}_{l, \text{inv}}} v \cdot \text a_{v \rightarrow e}
 $$
 
 $$ \label{eq:Share_operation}
-s_{l \rightarrow e, \text{op}}(\text{t}_i) = \sum_{v \in \mathcal{V}_{l,\text{op}}} v(\text{t}_i) \cdot \text a_{v \rightarrow e}(\text{t}_i)           
+s_{l \rightarrow e, \text{op}}(\text{t}_i) = \sum_{v \in \mathcal{V}_{l,\text{op}}} v(\text{t}_i) \cdot \text a_{v \rightarrow e}(\text{t}_i)
 $$
 
 With:
@@ -36,26 +36,26 @@ With:
 
 ### Shares between different Effects
 
-Furthermore, the Effect $x$ can contribute a share to another Effect ${e} \in \mathcal{E}\backslash x$. 
-This share is defined by the factor $\text r_{x \rightarrow e}$. 
+Furthermore, the Effect $x$ can contribute a share to another Effect ${e} \in \mathcal{E}\backslash x$.
+This share is defined by the factor $\text r_{x \rightarrow e}$.
 
-For example, the Effect "CO$_2$ emissions" (unit: kg) 
-can cause an additional share to Effect "monetary costs" (unit: €). 
+For example, the Effect "CO$_2$ emissions" (unit: kg)
+can cause an additional share to Effect "monetary costs" (unit: €).
 In this case, the factor $\text a_{x \rightarrow e}$ is the specific CO$_2$ price in €/kg. However, circular references have to be avoided.
 
 The overall sum of investment shares of an Effect $e$ is given by $\eqref{Effect_invest}$
 
 $$ \label{eq:Effect_invest}
-E_{e, \text{inv}} = 
-\sum_{l \in \mathcal{L}} s_{l \rightarrow e,\text{inv}} + 
+E_{e, \text{inv}} =
+\sum_{l \in \mathcal{L}} s_{l \rightarrow e,\text{inv}} +
 \sum_{x \in \mathcal{E}\backslash e} E_{x, \text{inv}}  \cdot \text{r}_{x \rightarrow  e,\text{inv}}
 $$
 
 The overall sum of operation shares is given by $\eqref{eq:Effect_Operation}$
 
 $$ \label{eq:Effect_Operation}
-E_{e, \text{op}}(\text{t}_{i}) = 
-\sum_{l \in \mathcal{L}} s_{l \rightarrow e, \text{op}}(\text{t}_i) + 
+E_{e, \text{op}}(\text{t}_{i}) =
+\sum_{l \in \mathcal{L}} s_{l \rightarrow e, \text{op}}(\text{t}_i) +
 \sum_{x \in \mathcal{E}\backslash e} E_{x, \text{op}}(\text{t}_i) \cdot \text{r}_{x \rightarrow {e},\text{op}}(\text{t}_i)
 $$
 
@@ -100,7 +100,7 @@ $$
 
 Additionally to the user defined [Effects](#effects), a Penalty $\Phi$ is part of every FlixOpt Model.
 Its used to prevent unsolvable problems and simplify troubleshooting.
-Shares to the penalty can originate from every Element and are constructed similarly to 
+Shares to the penalty can originate from every Element and are constructed similarly to
 $\eqref{Share_invest}$ and  $\eqref{Share_operation}$.
 
 $$ \label{eq:Penalty}
@@ -129,4 +129,4 @@ With:
 
 This approach allows for a multi-criteria optimization using both...
  - ... the **Weigted Sum**Method, as the chosen **Objective Effect** can incorporate other Effects.
- - ... the ($\epsilon$-constraint method) by constraining effects.
+ - ... the ($\epsilon$-constraint method) by constraining effects.

docs/user-guide/Mathematical Notation/Flow.md

@@ -23,4 +23,4 @@ $$
 
 This mathematical Formulation can be extended or changed when using [OnOffParameters](#onoffparameters)
 to define the On/Off state of the Flow, or [InvestParameters](#investments),
-which changes the size of the Flow from a constant to an optimization variable.
+which changes the size of the Flow from a constant to an optimization variable.

docs/user-guide/Mathematical Notation/LinearConverter.md

@@ -10,7 +10,7 @@ With:
 - $p_{f_\text{in}}(\text{t}_i)$ and $p_{f_\text{out}}(\text{t}_i)$ being the flow-rate at time $\text{t}_i$ for flow $f_\text{in}$ and $f_\text{out}$, respectively
 - $\text a_{f_\text{in}}(\text{t}_i)$ and $\text b_{f_\text{out}}(\text{t}_i)$ being the ratio of the flow-rate at time $\text{t}_i$ for flow $f_\text{in}$ and $f_\text{out}$, respectively
 
-With one incoming **Flow** and one outgoing **Flow**, this can be simplified to: 
+With one incoming **Flow** and one outgoing **Flow**, this can be simplified to:
 
 $$ \label{eq:Linear-Transformer-Ratio-simple}
     \text a(\text{t}_i) \cdot p_{f_\text{in}}(\text{t}_i) = p_{f_\text{out}}(\text{t}_i)
@@ -18,4 +18,4 @@ $$
 
 where $\text a$ can be interpreted as the conversion efficiency of the **LinearTransformer**.
 #### Piecewise Concersion factors
-The conversion efficiency can be defined as a piecewise linear approximation. See [Piecewise](Piecewise.md) for more details.
+The conversion efficiency can be defined as a piecewise linear approximation. See [Piecewise](Piecewise.md) for more details.

docs/user-guide/Mathematical Notation/Piecewise.md

@@ -40,7 +40,7 @@ Which can also be described as $v \in \{0\} \cup [\text{v}_{\text{start_k}}, \te
 
 ## Combining multiple Piecewises
 
-Piecewise allows representing non-linear relationships. 
+Piecewise allows representing non-linear relationships.
 This is a powerful technique in linear optimization to model non-linear behaviors while maintaining the problem's linearity.
 
 Therefore, each Piecewise must have the same number of Pieces $k$.

docs/user-guide/Mathematical Notation/Storage.md

@@ -41,4 +41,4 @@ Where:
 - $p_{f_\text{in}}(\text{t}_i)$ is the input flow rate at time $\text{t}_i$
 - $\eta_\text{in}(\text{t}_i)$ is the charging efficiency at time $\text{t}_i$
 - $p_{f_\text{out}}(\text{t}_i)$ is the output flow rate at time $\text{t}_i$
-- $\eta_\text{out}(\text{t}_i)$ is the discharging efficiency at time $\text{t}_i$
+- $\eta_\text{out}(\text{t}_i)$ is the discharging efficiency at time $\text{t}_i$

docs/user-guide/Mathematical Notation/index.md

@@ -14,7 +14,7 @@ FlixOpt uses the following naming conventions:
 
 ## Timesteps
 Time steps are defined as a sequence of discrete time steps $\text{t}_i \in \mathcal{T} \quad \text{for} \quad i \in \{1, 2, \dots, \text{n}\}$ (left-aligned in its timespan).
-From this sequence, the corresponding time intervals $\Delta \text{t}_i \in \Delta \mathcal{T}$ are derived as 
+From this sequence, the corresponding time intervals $\Delta \text{t}_i \in \Delta \mathcal{T}$ are derived as
 
 $$\Delta \text{t}_i = \text{t}_{i+1} - \text{t}_i \quad \text{for} \quad i \in \{1, 2, \dots, \text{n}-1\}$$
 

docs/user-guide/Mathematical Notation/others.md

@@ -1,3 +1,3 @@
 # Work in Progress
 
-This is a work in progress.
+This is a work in progress.

docs/user-guide/index.md

@@ -6,7 +6,7 @@ FlixOpt is built around a set of core concepts that work together to represent a
 
 ### FlowSystem
 
-The [`FlowSystem`][flixopt.flow_system.FlowSystem] is the central organizing unit in FlixOpt. 
+The [`FlowSystem`][flixopt.flow_system.FlowSystem] is the central organizing unit in FlixOpt.
 Every FlixOpt model starts with creating a FlowSystem. It:
 
 - Defines the timesteps for the optimization
@@ -40,7 +40,7 @@ Examples:
 [`Bus`][flixopt.elements.Bus] objects represent nodes or connection points in a FlowSystem. They:
 
 - Balance incoming and outgoing flows
-- Can represent physical networks like heat, electricity, or gas 
+- Can represent physical networks like heat, electricity, or gas
 - Handle infeasible balances gently by allowing the balance to be closed in return for a big Penalty (optional)
 
 ### Components

flixopt/__init__.py

@@ -2,6 +2,10 @@
 This module bundles all common functionality of flixopt and sets up the logging
 """
 
+from importlib.metadata import version
+
+__version__ = version('flixopt')
+
 from .commons import (
     CONFIG,
     AggregatedCalculation,

flixopt/calculation.py

@@ -62,13 +62,9 @@ class Calculation:
         self.folder = pathlib.Path.cwd() / 'results' if folder is None else pathlib.Path(folder)
         self.results: Optional[CalculationResults] = None
 
-        if not self.folder.exists():
-            try:
-                self.folder.mkdir(parents=False)
-            except FileNotFoundError as e:
-                raise FileNotFoundError(
-                    f'Folder {self.folder} and its parent do not exist. Please create them first.'
-                ) from e
+        if self.folder.exists() and not self.folder.is_dir():
+            raise NotADirectoryError(f'Path {self.folder} exists and is not a directory.')
+        self.folder.mkdir(parents=False, exist_ok=True)
 
     @property
     def main_results(self) -> Dict[str, Union[Scalar, Dict]]:

flixopt/components.py

@@ -674,7 +674,7 @@ class Source(Component):
         outputs: List[Flow] = None,
         meta_data: Optional[Dict] = None,
         prevent_simultaneous_flow_rates: bool = False,
-        **kwargs
+        **kwargs,
     ):
         """
         Args:
@@ -694,7 +694,12 @@ class Source(Component):
             outputs = [source]
 
         self.prevent_simultaneous_flow_rates = prevent_simultaneous_flow_rates
-        super().__init__(label, outputs=outputs, meta_data=meta_data, prevent_simultaneous_flows=outputs if prevent_simultaneous_flow_rates else None)
+        super().__init__(
+            label,
+            outputs=outputs,
+            meta_data=meta_data,
+            prevent_simultaneous_flows=outputs if prevent_simultaneous_flow_rates else None,
+        )
 
     @property
     def source(self) -> Flow:
@@ -714,7 +719,7 @@ class Sink(Component):
         inputs: List[Flow] = None,
         meta_data: Optional[Dict] = None,
         prevent_simultaneous_flow_rates: bool = False,
-        **kwargs
+        **kwargs,
     ):
         """
         Args:
@@ -734,7 +739,12 @@ class Sink(Component):
             inputs = [sink]
 
         self.prevent_simultaneous_flow_rates = prevent_simultaneous_flow_rates
-        super().__init__(label, inputs=inputs, meta_data=meta_data, prevent_simultaneous_flows=inputs if prevent_simultaneous_flow_rates else None)
+        super().__init__(
+            label,
+            inputs=inputs,
+            meta_data=meta_data,
+            prevent_simultaneous_flows=inputs if prevent_simultaneous_flow_rates else None,
+        )
 
     @property
     def sink(self) -> Flow:

flixopt/core.py

@@ -62,17 +62,21 @@ class DataConverter:
                 return xr.DataArray(data, coords=coords, dims=dims)
             elif isinstance(data, pd.DataFrame):
                 if not data.index.equals(timesteps):
-                    raise ConversionError(f"DataFrame index doesn't match timesteps index. "
-                                          f"Its missing the following time steps: {timesteps.difference(data.index)}. "
-                                          f"Some parameters might need an extra timestep at the end.")
+                    raise ConversionError(
+                        f"DataFrame index doesn't match timesteps index. "
+                        f'Its missing the following time steps: {timesteps.difference(data.index)}. '
+                        f'Some parameters might need an extra timestep at the end.'
+                    )
                 if not len(data.columns) == 1:
                     raise ConversionError('DataFrame must have exactly one column')
                 return xr.DataArray(data.values.flatten(), coords=coords, dims=dims)
             elif isinstance(data, pd.Series):
                 if not data.index.equals(timesteps):
-                    raise ConversionError(f"Series index doesn't match timesteps index. "
-                                          f"Its missing the following time steps: {timesteps.difference(data.index)}. "
-                                          f"Some parameters might need an extra timestep at the end.")
+                    raise ConversionError(
+                        f"Series index doesn't match timesteps index. "
+                        f'Its missing the following time steps: {timesteps.difference(data.index)}. '
+                        f'Some parameters might need an extra timestep at the end.'
+                    )
                 return xr.DataArray(data.values, coords=coords, dims=dims)
             elif isinstance(data, np.ndarray):
                 if data.ndim != 1:

flixopt/effects.py

@@ -94,7 +94,8 @@ class Effect(Element):
             f'{self.label_full}|minimum_operation_per_hour', self.minimum_operation_per_hour
         )
         self.maximum_operation_per_hour = flow_system.create_time_series(
-            f'{self.label_full}|maximum_operation_per_hour', self.maximum_operation_per_hour,
+            f'{self.label_full}|maximum_operation_per_hour',
+            self.maximum_operation_per_hour,
         )
 
         self.specific_share_to_other_effects_operation = flow_system.create_effect_time_series(

flixopt/elements.py

@@ -352,8 +352,10 @@ class FlowModel(ElementModel):
                     label_of_element=self.label_of_element,
                     parameters=self.element.size,
                     defining_variable=self.flow_rate,
-                    relative_bounds_of_defining_variable=(self.flow_rate_lower_bound_relative,
-                                                          self.flow_rate_upper_bound_relative),
+                    relative_bounds_of_defining_variable=(
+                        self.flow_rate_lower_bound_relative,
+                        self.flow_rate_upper_bound_relative,
+                    ),
                     on_variable=self.on_off.on if self.on_off is not None else None,
                 ),
                 'investment',
@@ -448,7 +450,7 @@ class FlowModel(ElementModel):
 
     @property
     def flow_rate_upper_bound_relative(self) -> NumericData:
-        """ Returns the upper bound of the flow_rate relative to its size"""
+        """Returns the upper bound of the flow_rate relative to its size"""
         fixed_profile = self.element.fixed_relative_profile
         if fixed_profile is None:
             return self.element.relative_maximum.active_data

flixopt/features.py

@@ -90,7 +90,10 @@ class InvestmentModel(Model):
             # share: divest_effects - isInvested * divest_effects
             self._model.effects.add_share_to_effects(
                 name=self.label_of_element,
-                expressions={effect: -self.is_invested * factor + factor for effect, factor in self.parameters.divest_effects.items()},
+                expressions={
+                    effect: -self.is_invested * factor + factor
+                    for effect, factor in self.parameters.divest_effects.items()
+                },
                 target='invest',
             )
 
@@ -304,13 +307,11 @@ class StateModel(Model):
             )
 
             # Constraint: on * upper_bound >= def_var
-            self.add(
-                self._model.add_constraints(self.on * ub >= def_var, name=f'{self.label_full}|on_con2'), 'on_con2'
-            )
+            self.add(self._model.add_constraints(self.on * ub >= def_var, name=f'{self.label_full}|on_con2'), 'on_con2')
         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(
@@ -426,7 +427,9 @@ class SwitchStateModel(Model):
 
         # Mutual exclusivity constraint
         self.add(
-            self._model.add_constraints(self.switch_on + self.switch_off <= 1.1, name=f'{self.label_full}|switch_on_or_off'),
+            self._model.add_constraints(
+                self.switch_on + self.switch_off <= 1.1, name=f'{self.label_full}|switch_on_or_off'
+            ),
             'switch_on_or_off',
         )
 
@@ -502,9 +505,7 @@ class ConsecutiveStateModel(Model):
 
         # Upper bound constraint
         self.add(
-            self._model.add_constraints(
-                self.duration <= self._state_variable * mega, name=f'{self.label_full}|con1'
-            ),
+            self._model.add_constraints(self.duration <= self._state_variable * mega, name=f'{self.label_full}|con1'),
             'con1',
         )
 
@@ -556,8 +557,8 @@ class ConsecutiveStateModel(Model):
         # Set initial value
         self.add(
             self._model.add_constraints(
-                self.duration.isel(time=0) ==
-                (hours_per_step.isel(time=0) + self.previous_duration) * self._state_variable.isel(time=0),
+                self.duration.isel(time=0)
+                == (hours_per_step.isel(time=0) + self.previous_duration) * self._state_variable.isel(time=0),
                 name=f'{self.label_full}|initial',
             ),
             'initial',
@@ -568,7 +569,7 @@ class ConsecutiveStateModel(Model):
     @property
     def previous_duration(self) -> Scalar:
         """Computes the previous duration of the state variable"""
-        #TODO: Allow for other/dynamic timestep resolutions
+        # TODO: Allow for other/dynamic timestep resolutions
         return ConsecutiveStateModel.compute_consecutive_hours_in_state(
             self._previous_states, self._model.hours_per_step.isel(time=0).item()
         )
@@ -619,7 +620,10 @@ class ConsecutiveStateModel(Model):
                 f'as {binary_values=}'
             )
 
-        return np.sum(binary_values[-nr_of_indexes_with_consecutive_ones:] * hours_per_timestep[-nr_of_indexes_with_consecutive_ones:])
+        return np.sum(
+            binary_values[-nr_of_indexes_with_consecutive_ones:]
+            * hours_per_timestep[-nr_of_indexes_with_consecutive_ones:]
+        )
 
 
 class OnOffModel(Model):

flixopt/flow_system.py

@@ -257,9 +257,9 @@ class FlowSystem:
 
         if not DASH_CYTOSCAPE_AVAILABLE:
             raise ImportError(
-                f"Network visualization requires optional dependencies. "
-                f"Install with: pip install flixopt[viz], flixopt[full] or pip install dash dash_cytoscape networkx werkzeug. "
-                f"Original error: {VISUALIZATION_ERROR}"
+                f'Network visualization requires optional dependencies. '
+                f'Install with: pip install flixopt[viz], flixopt[full] or pip install dash dash_cytoscape networkx werkzeug. '
+                f'Original error: {VISUALIZATION_ERROR}'
             )
 
         if not self._connected:
@@ -274,6 +274,7 @@ class FlowSystem:
     def stop_network_app(self):
         """Stop the network visualization server."""
         from .network_app import DASH_CYTOSCAPE_AVAILABLE, VISUALIZATION_ERROR
+
         if not DASH_CYTOSCAPE_AVAILABLE:
             raise ImportError(
                 f'Network visualization requires optional dependencies. '