Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix storage and investment storage block docstrings #735

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

Fix storage and investment storage block docstrings #735

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions src/oemof/solph/components.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,12 +312,7 @@ class GenericStorageBlock(SimpleBlock):
&- \frac{\dot{E}_o(t)}{\eta_o(t)} \cdot \tau(t)
+ \dot{E}_i(t) \cdot \eta_i(t) \cdot \tau(t)

Connect the invest variables of the input and the output flow.
.. math::
InvestmentFlow.invest(source(n), n) + existing = \\
(InvestmentFlow.invest(n, target(n)) + existing) * \\
invest\_relation\_input\_output(n) \\
\forall n \in \textrm{INVEST\_REL\_IN\_OUT}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not remove it from the docs, because this constraint exists. There should be more information added. Something like "In case invest_relation_input_output is set (or not None)`, the following constraint is build:"




Expand Down Expand Up @@ -666,13 +661,13 @@ class GenericInvestmentStorageBlock(SimpleBlock):
Rule for upper bound constraint for the storage content:

.. math::
E(t) \leq E_{invest} \cdot c_{max}(t)
E(t) \leq (E_{invest} + E_{exist}) \cdot c_{max}(t)

* :attr:`min_storage_level`

Rule for lower bound constraint for the storage content:

.. math:: E(t) \geq E_{invest} \cdot c_{min}(t)
.. math:: E(t) \geq (E_{invest} + E_{exist}) \cdot c_{min}(t)


**Objective function**
Expand Down