flixopt 2.2.0b0__py3-none-any.whl → 3.0.0__py3-none-any.whl

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

@@ -1,33 +0,0 @@
-A Bus is a simple nodal balance between its incoming and outgoing flow rates.
-
-$$ \label{eq:bus_balance}
-  \sum_{f_\text{in} \in \mathcal{F}_\text{in}} p_{f_\text{in}}(\text{t}_i) =
-  \sum_{f_\text{out} \in \mathcal{F}_\text{out}} p_{f_\text{out}}(\text{t}_i)
-$$
-
-Optionally, a Bus can have a `excess_penalty_per_flow_hour` parameter, which allows to penaltize the balance for missing or excess flow-rates.
-This is usefull as it handles a possible ifeasiblity gently.
-
-This changes the balance to
-
-$$ \label{eq:bus_balance-excess}
-  \sum_{f_\text{in} \in \mathcal{F}_\text{in}} p_{f_ \text{in}}(\text{t}_i) + \phi_\text{in}(\text{t}_i) =
-  \sum_{f_\text{out} \in \mathcal{F}_\text{out}} p_{f_\text{out}}(\text{t}_i) + \phi_\text{out}(\text{t}_i)
-$$
-
-The penalty term is defined as
-
-$$ \label{eq:bus_penalty}
-  s_{b \rightarrow \Phi}(\text{t}_i) =
-      \text a_{b \rightarrow \Phi}(\text{t}_i) \cdot \Delta \text{t}_i
-      \cdot [ \phi_\text{in}(\text{t}_i) + \phi_\text{out}(\text{t}_i) ]
-$$
-
-With:
-
-- $\mathcal{F}_\text{in}$ and $\mathcal{F}_\text{out}$ being the set of all incoming and outgoing flows
-- $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
-- $\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`)

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

@@ -1,132 +0,0 @@
-## Effects
-[`Effects`][flixopt.effects.Effect] are used to allocate things like costs, emissions, or other "effects" occuring in the system.
-These arise from so called **Shares**, which originate from **Elements** like [Flows](Flow.md).
-
-**Example:**
-
-[`Flows`][flixopt.elements.Flow] have an attribute called `effects_per_flow_hour`, defining the effect amount of per flow hour.
-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} 
-$$
-
-$$ \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)           
-$$
-
-With:
-
-- $\text{t}_i$ being the time step
-- $\mathcal{V_l}$ being the set of all optimization variables of element $e$
-- $\mathcal{V}_{l, \text{inv}}$ being the set of all optimization variables of element $e$ related to investment
-- $\mathcal{V}_{l, \text{op}}$ being the set of all optimization variables of element $e$ related to operation
-- $v$ being an optimization variable of the element $l$
-- $v(\text{t}_i)$ being an optimization variable of the element $l$ at timestep $\text{t}_i$
-- $\text a_{v \rightarrow e}$ being the factor between the optimization variable $v$ to effect $e$
-- $\text a_{v \rightarrow e}(\text{t}_i)$ being the factor between the optimization variable $v$ to effect $e$ for timestep $\text{t}_i$
-- $s_{l \rightarrow e, \text{inv}}$ being the share of element $l$ to the investment part of effect $e$
-- $s_{l \rightarrow e, \text{op}}(\text{t}_i)$ being the share of element $l$ to the operation part of effect $e$
-
-### 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}$. 
-
-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}} + 
-\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) + 
-\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)
-$$
-
-and totals to $\eqref{eq:Effect_Operation_total}$
-$$\label{eq:Effect_Operation_total}
-E_{e,\text{op},\text{tot}} = \sum_{i=1}^n  E_{e,\text{op}}(\text{t}_{i})
-$$
-
-With:
-
-- $\mathcal{L}$ being the set of all elements in the FlowSystem
-- $\mathcal{E}$ being the set of all effects in the FlowSystem
-- $\text r_{x \rightarrow e, \text{inv}}$ being the factor between the operation part of Effect $x$ and Effect $e$
-- $\text r_{x \rightarrow e, \text{op}}(\text{t}_i)$ being the factor between the invest part of Effect $x$ and Effect $e$
-
-- $\text{t}_i$ being the time step
-- $s_{l \rightarrow e, \text{inv}}$ being the share of element $l$ to the investment part of effect $e$
-- $s_{l \rightarrow e, \text{op}}(\text{t}_i)$ being the share of element $l$ to the operation part of effect $e$
-
-
-The total of an effect $E_{e}$ is given as $\eqref{eq:Effect_Total}$
-
-$$ \label{eq:Effect_Total}
-E_{e} = E_{\text{inv},e} +E_{\text{op},\text{tot},e}
-$$
-
-### Constraining Effects
-
-For each variable $v \in \{ E_{e,\text{inv}}, E_{e,\text{op},\text{tot}}, E_e\}$, a lower bound $v^\text{L}$ and upper bound $v^\text{U}$ can be defined as
-
-$$ \label{eq:Bounds_Single}
-\text v^\text{L} \leq v \leq \text v^\text{U}
-$$
-
-Furthermore, bounds for the operational shares can be set for each time step
-
-$$ \label{eq:Bounds_Time_Steps}
-\text E_{e,\text{op}}^\text{L}(\text{t}_i) \leq E_{e,\text{op}}(\text{t}_i) \leq \text E_{e,\text{op}}^\text{U}(\text{t}_i)
-$$
-
-## Penalty
-
-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 
-$\eqref{Share_invest}$ and  $\eqref{Share_operation}$.
-
-$$ \label{eq:Penalty}
-\Phi = \sum_{l \in \mathcal{L}} \left( s_{l \rightarrow \Phi}  +\sum_{\text{t}_i \in \mathcal{T}} s_{l \rightarrow \Phi}(\text{t}_{i}) \right)
-$$
-
-With:
-
-- $\mathcal{L}$ being the set of all elements in the FlowSystem
-- $\mathcal{T}$ being the set of all timesteps
-- $s_{l \rightarrow \Phi}$ being the share of element $l$ to the penalty
-
-At the moment, penalties only occur in [Buses](#buses)
-
-## Objective
-
-The optimization objective of a FlixOpt Model is defined as $\eqref{eq:Objective}$
-$$ \label{eq:Objective}
-\min(E_{\Omega} + \Phi)
-$$
-
-With:
-
-- $\Omega$ being the chosen **Objective [Effect](#effects)** (see $\eqref{eq:Effect_Total}$)
-- $\Phi$ being the [Penalty](#penalty)
-
-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.

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

@@ -1,26 +0,0 @@
-The flow_rate is the main optimization variable of the Flow. It's limited by the size of the Flow and relative bounds \eqref{eq:flow_rate}.
-
-$$ \label{eq:flow_rate}
-    \text P \cdot \text p^{\text{L}}_{\text{rel}}(\text{t}_{i})
-    \leq p(\text{t}_{i}) \leq
-    \text P \cdot \text p^{\text{U}}_{\text{rel}}(\text{t}_{i})
-$$
-
-With:
-
-- $\text P$ being the size of the Flow
-- $p(\text{t}_{i})$ being the flow-rate at time $\text{t}_{i}$
-- $\text p^{\text{L}}_{\text{rel}}(\text{t}_{i})$ being the relative lower bound (typically 0)
-- $\text p^{\text{U}}_{\text{rel}}(\text{t}_{i})$ being the relative upper bound (typically 1)
-
-With $\text p^{\text{L}}_{\text{rel}}(\text{t}_{i}) = 0$ and $\text p^{\text{U}}_{\text{rel}}(\text{t}_{i}) = 1$,
-equation \eqref{eq:flow_rate} simplifies to
-
-$$
-    0 \leq p(\text{t}_{i}) \leq \text P
-$$
-
-
-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.

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

@@ -1,115 +0,0 @@
-# Investments
-
-## Current state
-$$
-\beta_{\text{invest}} \cdot \text{max}(\epsilon, \text V^{\text L}) \leq V \leq  \beta_{\text{invest}} \cdot \text V^{\text U}
-$$
-With:
-- $V$ = size
-- $V^{\text L}$ = minimum size
-- $V^{\text U}$ = maximum size
-- $\epsilon$ = epsilon, a small number (such as $1e^{-5}$)
-- $\beta_{invest} \in {0,1}$ = wether the size is invested or not
-
-_Please edit the use cases as needed_
-## Quickfix 1: Optimize the single best size overall
-### Single variable
-This is already possible and should be, as this is a needed use case
-An additional factor to when the size is actually available might me practical (Which indicates the (fixed) time of investment)
-## Math
-$$
-V(p) = V * a(p)
-$$
-with:
-- $V$ = size
-- $a(p)$ = factor for availlability per period
-
-Factor $a(p)$ is simply multiplied with relative minimum or maximum(t). This is already possible by doing this yourself.
-Effectively, the relative minimum or maximum are altered before using the same constraiints as before.
-THis might lead to some issues regariding minimum_load factor, or others, as the size is not 0 in a scenario where the component cant produce.
-**Therefore this might not be the best choice. See (#Variable per Scenario)
-
-## Variable per Scenario
-- **size** and **invest** as a variable per period $V(s)$ and $\beta_{invest}(s)$
-- with scenario $s \in S$
-
-### Usecase 1: Optimize the size for each Scenario independently
-Restrictions are seperatly for each scenario
-No changes needed. This could be the default behaviour.
-
-### Usecase 2: Optimize ONE size for ALL scenarios
-The size is the same globally, but not a scalar, but a variable per scenario $V(s)$
-#### 2a: The same size in all scenarios
-$$
-V(s) = V(s') \quad \forall s,s' \in S
-$$
-
-With:
-- $V(s)$ and $V(s')$ = size
-- $S$ = set of scenarios
-
-#### 2b: The same size, but can be 0 prior to the first increment
-- Find the Optimal time of investment.
-- Force an investment in a certain scenario (parameter optional as a list/array ob booleans)
-- Combine optional and minimum/maximum size to force an investment inside a range if scenarios
-
-$$
-\beta_{\text{invest}}(s) \leq \beta_{\text{invest}}(s+1) \quad \forall s \in \{1,2,\ldots,S-1\}
-$$
-
-$$
-V(s') - V(s) \leq M \cdot (2 - \beta_{\text{invest}}(s) - \beta_{\text{invest}}(s')) \quad \forall s, s' \in S
-$$
-$$
-V(s') - V(s) \geq M \cdot (2 - \beta_{\text{invest}}(s) - \beta_{\text{invest}}(s')) \quad \forall s, s' \in S
-$$
-
-This could be the default behaviour. (which would be consistent with other variables)
-
-
-### Switch
-
-$$
-\begin{aligned}
-& \text{SWITCH}_s \in \{0,1\} \quad \forall s \in \{1,2,\ldots,S\} \\
-& \sum_{s=1}^{S} \text{SWITCH}_s = 1 \\
-& \beta_{\text{invest}}(s) = \sum_{s'=1}^{s} \text{SWITCH}_{s'} \quad \forall s \in \{1,2,\ldots,S\} \\
-\end{aligned}
-$$
-
-$$
-\begin{aligned}
-& V(s) \leq V_{\text{actual}} \quad \forall s \in \{1,2,\ldots,S\} \\
-& V(s) \geq V_{\text{actual}} - M \cdot (1 - \beta_{\text{invest}}(s)) \quad \forall s \in \{1,2,\ldots,S\}
-\end{aligned}
-$$
-
-
-
-
-### Usecase 3: Find the best scenario to increment the size (Timing of the investment)
-The size can only increment once (based on a starting point). This allows to optimize the timing of an investment.
-#### Math
-Treat $\beta_{invest}$ like an ON/OFF variable, and introduce a SwitchOn, that can only be active once.
-
-*Thoughts:*
-- Treating $\beta_{invest}$ like an ON/OFF variable suggest using the already presentconstraints linked to On/OffModel
-- The timing could be constraint to be first in scenario x, or last in scenario y
-- Restrict the number of consecutive scenarios
-THis might needs the OnOffModel to be more generic (HOURS). Further, the span between scenarios needs to be weighted (like dt_in_hours), or the scenarios need to be measureable (integers)
-
-
-### Others
-
-#### Usecase 4: Only increase/decrease the size
-Start from a certain size. For each scenario, the size can increase, but never decrease. (Or the other way around).
-This would mean that a size expansion is possible,
-
-#### Usecase 5: Restrict the increment in size per scenario
-Restrict how much the size can increase/decrease for in scenario, based on the prior scenario.
-
-
-
-
-
-Many more are possible

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

@@ -1,21 +0,0 @@
-[`LinearConverters`][flixopt.components.LinearConverter] define a ratio between incoming and outgoing [Flows](#flows).
-
-$$ \label{eq:Linear-Transformer-Ratio}
-    \sum_{f_{\text{in}} \in \mathcal F_{in}} \text a_{f_{\text{in}}}(\text{t}_i) \cdot p_{f_\text{in}}(\text{t}_i) = \sum_{f_{\text{out}} \in \mathcal F_{out}}  \text b_{f_\text{out}}(\text{t}_i) \cdot p_{f_\text{out}}(\text{t}_i)
-$$
-
-With:
-
-- $\mathcal F_{in}$ and $\mathcal F_{out}$ being the set of all incoming and outgoing flows
-- $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: 
-
-$$ \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)
-$$
-
-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.

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

@@ -1,49 +0,0 @@
-# Piecewise
-
-A Piecewise is a collection of [`Pieces`][flixopt.interface.Piece], which each define a valid range for a variable $v$
-
-$$ \label{eq:active_piece}
-    \beta_\text{k} = \lambda_\text{0, k} + \lambda_\text{1, k}
-$$
-
-$$ \label{eq:piece}
-    v_\text{k} = \lambda_\text{0, k} * \text{v}_{\text{start,k}} + \lambda_\text{1,k} * \text{v}_{\text{end,k}}
-$$
-
-$$ \label{eq:piecewise_in_pieces}
-\sum_{k=1}^k \beta_{k} = 1
-$$
-
-With:
-
-- $v$: The variable to be defined by the Piecewise
-- $\text{v}_{\text{start,k}}$: the start point of the piece for variable $v$
-- $\text{v}_{\text{end,k}}$: the end point of the piece for variable $v$
-- $\beta_\text{k} \in \{0, 1\}$: defining wether the Piece $k$ is active
-- $\lambda_\text{0,k} \in [0, 1]$: A variable defining the fraction of $\text{v}_{\text{start,k}}$ that is active
-- $\lambda_\text{1,k} \in [0, 1]$: A variable defining the fraction of $\text{v}_{\text{end,k}}$ that is active
-
-Which can also be described as $v \in 0 \cup [\text{v}_\text{start}, \text{v}_\text{end}]$.
-
-Instead of \eqref{eq:piecewise_in_pieces}, the following constraint is used to also allow all variables to be zero:
-
-$$ \label{eq:piecewise_in_pieces_zero}
-\sum_{k=1}^k \beta_{k} = \beta_\text{zero}
-$$
-
-With:
-
-- $\beta_\text{zero} \in \{0, 1\}$.
-
-Which can also be described as $v \in \{0\} \cup [\text{v}_{\text{start_k}}, \text{v}_{\text{end_k}}]$
-
-
-## Combining multiple Piecewises
-
-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$.
-
-The variables described in [Piecewise](#piecewise) are created for each Piece, but nor for each Piecewise.
-Rather, \eqref{eq:piece} is the only constraint that is created for each Piecewise, using the start and endpoints $\text{v}_{\text{start,k}}$ and $\text{v}_{\text{end,k}}$ of each Piece for the corresponding variable $v$

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

@@ -1,44 +0,0 @@
-# Storages
-**Storages** have one incoming and one outgoing **[Flow](#flows)** with a charging and discharging efficiency.
-A storage has a state of charge $c(\text{t}_i)$ which is limited by its `size` $\text C$ and relative bounds $\eqref{eq:Storage_Bounds}$.
-
-$$ \label{eq:Storage_Bounds}
-    \text C \cdot \text c^{\text{L}}_{\text{rel}}(\text t_{i})
-    \leq c(\text{t}_i) \leq
-    \text C \cdot \text c^{\text{U}}_{\text{rel}}(\text t_{i})
-$$
-
-Where:
-
-- $\text C$ is the size of the storage
-- $c(\text{t}_i)$ is the state of charge at time $\text{t}_i$
-- $\text c^{\text{L}}_{\text{rel}}(\text t_{i})$ is the relative lower bound (typically 0)
-- $\text c^{\text{U}}_{\text{rel}}(\text t_{i})$ is the relative upper bound (typically 1)
-
-With $\text c^{\text{L}}_{\text{rel}}(\text t_{i}) = 0$ and $\text c^{\text{U}}_{\text{rel}}(\text t_{i}) = 1$,
-Equation $\eqref{eq:Storage_Bounds}$ simplifies to
-
-$$ 0 \leq c(\text t_{i}) \leq \text C $$
-
-The state of charge $c(\text{t}_i)$ decreases by a fraction of the prior state of charge. The belonging parameter
-$ \dot{ \text c}_\text{rel, loss}(\text{t}_i)$ expresses the "loss fraction per hour". The storage balance from  $\text{t}_i$ to $\text t_{i+1}$ is
-
-$$
-\begin{align*}
-    c(\text{t}_{i+1}) &= c(\text{t}_{i}) \cdot (1-\dot{\text{c}}_\text{rel,loss}(\text{t}_i) \cdot \Delta \text{t}_{i}) \\
-    &\quad + p_{f_\text{in}}(\text{t}_i) \cdot \Delta \text{t}_i \cdot \eta_\text{in}(\text{t}_i) \\
-    &\quad - \frac{p_{f_\text{out}}(\text{t}_i) \cdot \Delta \text{t}_i}{\eta_\text{out}(\text{t}_i)}
-    \tag{3}
-\end{align*}
-$$
-
-Where:
-
-- $c(\text{t}_{i+1})$ is the state of charge at time $\text{t}_{i+1}$
-- $c(\text{t}_{i})$ is the state of charge at time $\text{t}_{i}$
-- $\dot{\text{c}}_\text{rel,loss}(\text{t}_i)$ is the relative loss rate (self-discharge) per hour
-- $\Delta \text{t}_{i}$ is the time step duration in hours
-- $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$

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

@@ -1,22 +0,0 @@
-
-# Mathematical Notation
-
-## Naming Conventions
-
-FlixOpt uses the following naming conventions:
-
-- All optimization variables are denoted by italic letters (e.g., $x$, $y$, $z$)
-- All parameters and constants are denoted by non italic small letters (e.g., $\text{a}$, $\text{b}$, $\text{c}$)
-- All Sets are denoted by greek capital letters (e.g., $\mathcal{F}$, $\mathcal{E}$)
-- All units of a set are denoted by greek small letters (e.g., $\mathcal{f}$, $\mathcal{e}$)
-- The letter $i$ is used to denote an index (e.g., $i=1,\dots,\text n$)
-- All time steps are denoted by the letter $\text{t}$ (e.g., $\text{t}_0$, $\text{t}_1$, $\text{t}_i$)
-
-## 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 
-
-$$\Delta \text{t}_i = \text{t}_{i+1} - \text{t}_i \quad \text{for} \quad i \in \{1, 2, \dots, \text{n}-1\}$$
-
-The final time interval $\Delta \text{t}_\text n$ defaults to $\Delta \text{t}_\text n = \Delta \text{t}_{\text n-1}$, but is of course customizable.
-Non-equidistant time steps are also supported.

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

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

docs/user-guide/index.md

@@ -1,124 +0,0 @@
-# FlixOpt Concepts
-
-FlixOpt is built around a set of core concepts that work together to represent and optimize energy and material flow systems. This page provides a high-level overview of these concepts and how they interact.
-
-## Core Concepts
-
-### FlowSystem
-
-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
-- Contains and connects [components](#components), [buses](#buses), and [flows](#flows)
-- Manages the [effects](#effects) (objectives and constraints)
-
-### Flows
-
-[`Flow`][flixopt.elements.Flow] objects represent the movement of energy or material between a [Bus](#buses) and a [Component](#components) in a predefined direction.
-
-- Have a `size` which, generally speaking, defines how fast energy or material can be moved. Usually measured in MW, kW, m³/h, etc.
-- Have a `flow_rate`, which is defines how fast energy or material is transported. Usually measured in MW, kW, m³/h, etc.
-- Have constraints to limit the flow-rate (min/max, total flow hours, on/off etc.)
-- Can have fixed profiles (for demands or renewable generation)
-- Can have [Effects](#effects) associated by their use (operation, investment, on/off, ...)
-
-#### Flow Hours
-While the **Flow Rate** defines the rate in which energy or material is transported, the **Flow Hours** define the amount of energy or material that is transported.
-Its defined by the flow_rate times the duration of the timestep in hours.
-
-Examples:
-
-| Flow Rate | Timestep | Flow Hours |
-|-----------|----------|------------|
-| 10 (MW)   | 1 hour   | 10 (MWh)   |
-| 10 (MW)   | 6 minutes | 0.1 (MWh) |
-| 10 (kg/h) | 1 hour   | 10 (kg)    |
-
-### Buses
-
-[`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 
-- Handle infeasible balances gently by allowing the balance to be closed in return for a big Penalty (optional)
-
-### Components
-
-[`Component`][flixopt.elements.Component] objects usually represent physical entities in your system that interact with [`Flows`][flixopt.elements.Flow]. They include:
-
-- [`LinearConverters`][flixopt.components.LinearConverter] - Converts input flows to output flows with (piecewise) linear relationships
-- [`Storages`][flixopt.components.Storage] - Stores energy or material over time
-- [`Sources`][flixopt.components.Source] / [`Sinks`][flixopt.components.Sink] / [`SourceAndSinks`][flixopt.components.SourceAndSink] - Produce or consume flows. They are usually used to model external demands or supplies.
-- [`Transmissions`][flixopt.components.Transmission] - Moves flows between locations with possible losses
-- Specialized [`LinearConverters`][flixopt.components.LinearConverter] like [`Boilers`][flixopt.linear_converters.Boiler], [`HeatPumps`][flixopt.linear_converters.HeatPump], [`CHPs`][flixopt.linear_converters.CHP], etc. These simplify the usage of the `LinearConverter` class and can also be used as blueprint on how to define custom classes or parameterize existing ones.
-
-### Effects
-
-[`Effect`][flixopt.effects.Effect] objects represent impacts or metrics related to your system, such as:
-
-- Costs (investment, operation)
-- Emissions (CO₂, NOx, etc.)
-- Resource consumption
-- Area demand
-
-These can be freely defined and crosslink to each other (`CO₂` ──[specific CO₂-costs]─→ `Costs`).
-One effect is designated as the **optimization objective** (typically Costs), while others can be constrained.
-This approach allows for a multi-criteria optimization using both...
- - ... the **Weigted Sum**Method, by Optimizing a theoretical Effect which other Effects crosslink to.
- - ... the ($\epsilon$-constraint method) by constraining effects.
-
-### Calculation
-
-A [`FlowSystem`][flixopt.flow_system.FlowSystem] can be converted to a Model and optimized by creating a [`Calculation`][flixopt.calculation.Calculation] from it.
-
-FlixOpt offers different calculation modes:
-
-- [`FullCalculation`][flixopt.calculation.FullCalculation] - Solves the entire problem at once
-- [`SegmentedCalculation`][flixopt.calculation.SegmentedCalculation] - Solves the problem in segments (with optioinal overlap), improving performance for large problems
-- [`AggregatedCalculation`][flixopt.calculation.AggregatedCalculation] - Uses typical periods to reduce computational requirements
-
-### Results
-
-The results of a calculation are stored in a [`CalculationResults`][flixopt.results.CalculationResults] object.
-This object contains the solutions of the optimization as well as all information about the [`Calculation`][flixopt.calculation.Calculation] and the [`FlowSystem`][flixopt.flow_system.FlowSystem] it was created from.
-The solutions is stored as an `xarray.Dataset`, but can be accessed through their assotiated Component, Bus or Effect.
-
-This [`CalculationResults`][flixopt.results.CalculationResults] object can be saved to file and reloaded from file, allowing you to analyze the results anytime after the solve.
-
-## How These Concepts Work Together
-
-The process of working with FlixOpt can be divided into 3 steps:
-
-1. Create a [`FlowSystem`][flixopt.flow_system.FlowSystem], containing all the elements and data of your system
-     -  Define the time series of your system
-     -  Add [`Components`][flixopt.components] like [`Boilers`][flixopt.linear_converters.Boiler], [`HeatPumps`][flixopt.linear_converters.HeatPump], [`CHPs`][flixopt.linear_converters.CHP], etc.
-     -  Add [`Buses`][flixopt.elements.Bus] as connection points in your system
-     -  Add [`Effects`][flixopt.effects.Effect] to represent costs, emissions, etc.
-     - *This [`FlowSystem`][flixopt.flow_system.FlowSystem] can also be loaded from a netCDF file*
-2. Translate the model to a mathematical optimization problem
-     - Create a [`Calculation`][flixopt.calculation.Calculation] from your FlowSystem and choose a Solver
-     - ...The Calculation is translated internaly to a mathematical optimization problem...
-     - ...and solved by the chosen solver.
-3. Analyze the results
-     - The results are stored in a [`CalculationResults`][flixopt.results.CalculationResults] object
-     - This object can be saved to file and reloaded from file, retaining all information about the calculation
-     - As it contains the used [`FlowSystem`][flixopt.flow_system.FlowSystem], it can be used to start a new calculation
-
-<figure markdown>
-  ![FlixOpt Conceptual Usage](../images/architecture_flixOpt.png)
-  <figcaption>Conceptual Usage and IO operations of FlixOpt</figcaption>
-</figure>
-
-## Advanced Usage
-As flixopt is build on [linopy](https://github.com/PyPSA/linopy), any model created with FlixOpt can be extended or modified using the great [linopy API](https://linopy.readthedocs.io/en/latest/api.html).
-This allows to adjust your model to very specific requirements without loosing the convenience of FlixOpt.
-
-<!--## Next Steps-->
-<!---->
-<!--Now that you understand the basic concepts, learn more about each one:-->
-<!---->
-<!--- [FlowSystem](api/flow_system.md) - Time series and system organization-->
-<!--- [Components](api/components.md) - Available component types and how to use them-->
-<!--- [Effects](apieffects.md) - Costs, emissions, and other impacts-->
-<!--- [Calculation Modes](api/calculation.md) - Different approaches to solving your model-->

flixopt/config.yaml

@@ -1,10 +0,0 @@
-# Default configuration of flixopt
-config_name: flixopt  # Name of the config file. This has no effect on the configuration itself.
-logging:
-  level: INFO
-  file: flixopt.log
-  rich: false  # logging output is formatted using rich. This is only advisable when using a proper terminal
-modeling:
-  BIG: 10000000  # 1e notation not possible in yaml
-  EPSILON: 0.00001
-  BIG_BINARY_BOUND: 100000