From bcc3bebd5f75fe25e7c967e3fe17b1e0ebece6a5 Mon Sep 17 00:00:00 2001 From: eosram <> Date: Mon, 18 May 2020 00:26:56 +0200 Subject: [PATCH 1/9] Add math notation substition This is a proof of concept to substitute varbiable and parameter names in formulas adhering to the MODEX terminology. This allows for later changes of that terminology. --- doc/source/conf.py | 1 + doc/source/frameworks/technologies.rst | 34 ++++++++++++++++++++++---- 2 files changed, 30 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 2d5102d..18d8918 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -29,6 +29,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'fluiddoc.mathmacro' ] # Add any paths that contain templates here, relative to this directory. diff --git a/doc/source/frameworks/technologies.rst b/doc/source/frameworks/technologies.rst index f844f7a..9563e52 100644 --- a/doc/source/frameworks/technologies.rst +++ b/doc/source/frameworks/technologies.rst @@ -2,6 +2,30 @@ Modelling of technologies ========================= Here the framework's representations of technologies are shown +Declaration of notation +*********************** + +.. |vg| mathmacro:: v^{gen} +.. |vu| mathmacro:: v^{use} +.. |kk| mathmacro:: \kappa^{capa} +.. |go| mathmacro:: \gamma^{out,gen} +.. |gi| mathmacro:: \gamma^{in,gen} +.. |yrgt| mathmacro:: \forall y \in Y, r \in R, g \in G, t \in T + ++--------------------------+--------------------------------+ +| Notation | Short description | ++==========================+================================+ +| .. math:: \vg | Electricity production | ++--------------------------+--------------------------------+ +| .. math:: \vu | Fuel usage | ++--------------------------+--------------------------------+ +| .. math:: \kk | Installed capacity | ++--------------------------+--------------------------------+ +| .. math:: \go | Plant efficiency (input) | ++--------------------------+--------------------------------+ +| .. math:: \gi | Plant efficiency (output) | ++--------------------------+--------------------------------+ + Generation ********** @@ -13,9 +37,9 @@ Dispatchable .. math:: - & {0 <= v^{gen}_{y,r,g,t} <= \kappa}^{capa}_{r,g} + & {0 <= \vg_{y,r,g,t} <= \kk_{r,g}} \\ - & \forall y \in Y, r \in R, g \in G, t \in T + & \yrgt Conversion @@ -23,10 +47,10 @@ Conversion .. math:: - & {v^{fuse}_{y,r,g,t}} = - \frac{1}{\gamma^{out,gen}_{r,g}}{v^{gen}_{y,r,g,t}} + & {\vu_{y,r,g,t}} = + \frac{1}{\go_{r,g}}{\vg_{y,r,g,t}} \\ - & \forall y \in Y, r \in R, g \in G, t \in T + & \yrgt Volatile From 95f5a6e07b90f2a6218ed61fd549078c5fba852f Mon Sep 17 00:00:00 2001 From: eosram <> Date: Mon, 18 May 2020 15:37:43 +0200 Subject: [PATCH 2/9] Extend substitution of parameters and variables --- doc/source/frameworks/technologies.rst | 72 +++++++++++++++++++------- 1 file changed, 53 insertions(+), 19 deletions(-) diff --git a/doc/source/frameworks/technologies.rst b/doc/source/frameworks/technologies.rst index 9563e52..b1ddf73 100644 --- a/doc/source/frameworks/technologies.rst +++ b/doc/source/frameworks/technologies.rst @@ -2,21 +2,33 @@ Modelling of technologies ========================= Here the framework's representations of technologies are shown -Declaration of notation -*********************** - +.. substitutions of variable and parameter names .. |vg| mathmacro:: v^{gen} -.. |vu| mathmacro:: v^{use} +.. |vh| mathmacro:: v^{gen,heat} +.. |vu| mathmacro:: v^{fuse} .. |kk| mathmacro:: \kappa^{capa} .. |go| mathmacro:: \gamma^{out,gen} .. |gi| mathmacro:: \gamma^{in,gen} +.. |gV| mathmacro:: \gamma^{CV} +.. |gB| mathmacro:: \gamma^{CB} + + +.. other substitutions .. |yrgt| mathmacro:: \forall y \in Y, r \in R, g \in G, t \in T +Declaration of notation +*********************** + +Variables and parameters +'''''''''''''''''''''''' + +--------------------------+--------------------------------+ | Notation | Short description | +==========================+================================+ | .. math:: \vg | Electricity production | +--------------------------+--------------------------------+ +| .. math:: \vh | Heat production | ++--------------------------+--------------------------------+ | .. math:: \vu | Fuel usage | +--------------------------+--------------------------------+ | .. math:: \kk | Installed capacity | @@ -25,6 +37,28 @@ Declaration of notation +--------------------------+--------------------------------+ | .. math:: \gi | Plant efficiency (output) | +--------------------------+--------------------------------+ +| .. math:: \gV | | ++--------------------------+--------------------------------+ +| .. math:: \gB | Back-pressure coefficient | ++--------------------------+--------------------------------+ + +Sets +'''' + ++--------------------------+--------------------------------+ +| Notation | Short description | ++==========================+================================+ +| .. math:: y \in Y | Years | ++--------------------------+--------------------------------+ +| .. math:: r \in R | Regions | ++--------------------------+--------------------------------+ +| .. math:: g \in G | Technologies | ++--------------------------+--------------------------------+ +| .. math:: t \in T | Timesteps | ++--------------------------+--------------------------------+ +| .. math:: a \in A | | ++--------------------------+--------------------------------+ + Generation ********** @@ -58,9 +92,9 @@ Volatile .. math:: - & {v^{gen}_{y,r,g,t} = \kappa^{capa}_{r,g} \cdot \gamma^{capa}_{y,r,g,t}} + & {\vg_{y,r,g,t} = \kk_{r,g} \cdot \gamma^{capa}_{y,r,g,t}} \\ - & \forall y \in Y, r \in R, g \in G, t \in T + & \yrgt Consumption @@ -76,7 +110,7 @@ Load & {E^{gen}_{y,r,g,t} = E^{capa}_{y,r,g,t}} \\ - & \forall y \in Y, r \in R, g \in G, t \in T + & \yrgt Bus @@ -90,9 +124,9 @@ Bus .. math:: - & {v^{in}_{y,r,g,t} = v^{gen}_{y,r,g,t}} + & {v^{in}_{y,r,g,t} = \vg_{y,r,g,t}} \\ - & \forall y \in Y, r \in R, g \in G, t \in T + & \yrgt Grid @@ -112,7 +146,7 @@ Link & {v^{trans,in_i}_{y,r,g,t} = \frac{1}{\gamma^{trans}_{r,g}} \cdot v^{trans,gen_i}_{y,r,g,t}} \\ - & \forall y \in Y, r \in R, g \in G, t \in T, i \in \{1, 2\} + & \yrgt, i \in \{1, 2\} Electricity-only units @@ -128,7 +162,7 @@ The related equation for this technology is: .. math:: - {v^{fuse}_{y,a,g,t}} = \frac{v^{gen}_{y,a,g,t}}{\gamma^{in,gen}_{g}} \quad \forall y \in Y, a\in A, g\in G, t\in T + {\vu_{y,a,g,t}} = \frac{\vg_{y,a,g,t}}{\gi_{g}} \quad \forall y \in Y, a\in A, g\in G, t\in T Heat-only units *************** @@ -143,7 +177,7 @@ The related equation for this technology is: .. math:: - {v^{fuse}_{y,a,g,t}} = \frac{v^{gen,heat}_{y,a,g,t}}{\gamma^{in,gen}_{g}} \quad \forall y \in Y, a\in A, g\in G, t\in T + {\vu_{y,a,g,t}} = \frac{\vh_{y,a,g,t}}{\gi_{g}} \quad \forall y \in Y, a\in A, g\in G, t\in T CHP units: backpressure *********************** @@ -162,7 +196,7 @@ The related equations for this technology is: .. math:: - & {v^{fuse}_{y,a,g,t}} = \frac{v^{gen}_{y,a,g,t} + \gamma^{CV}_g \cdot v^{gen,heat}_{y,a,g,t}}{\gamma^{in,gen}_{g}} + & {\vu_{y,a,g,t}} = \frac{\vg_{y,a,g,t} + \gV_g \cdot \vh_{y,a,g,t}}{\gi_{g}} & \forall y \in Y, a\in A, g\in G, t\in T @@ -170,7 +204,7 @@ The related equations for this technology is: .. math:: - v^{gen}_{y,a,g,t} = v^{gen,heat}_{y,a,g,t} \cdot \gamma^{CB}_g \quad \forall y \in Y, a\in A, g\in G, t\in T + \vg_{y,a,g,t} = \vh_{y,a,g,t} \cdot \gB_g \quad \forall y \in Y, a\in A, g\in G, t\in T CHP units: extraction ********************* @@ -187,7 +221,7 @@ The related equations for this technology is: .. math:: - & {v^{fuse}_{y,a,g,t}} = \frac{v^{gen}_{y,a,g,t} + \gamma^{CV}_g \cdot v^{gen,heat}_{y,a,g,t}}{\gamma^{in,gen}_{g}} + & {\vu_{y,a,g,t}} = \frac{\vg_{y,a,g,t} + \gV_g \cdot \vh_{y,a,g,t}}{\gi_{g}} & \forall y \in Y, a\in A, g\in G, t\in T @@ -195,13 +229,13 @@ The related equations for this technology is: .. math:: - v^{gen}_{y,a,g,t} \geq v^{gen,heat}_{y,a,g,t} \cdot \gamma^{CB}_g \quad \forall y \in Y, a\in A, g\in G, t\in T + \vg_{y,a,g,t} \geq \vh_{y,a,g,t} \cdot \gB_g \quad \forall y \in Y, a\in A, g\in G, t\in T 3. Limited by Cv-line: .. math:: - v^{gen}_{y,a,g,t} \leq \kappa^{capa}_{y,a,g} + v^{capa}_{y,a,g} - v^{gen,heat}_{y,a,g,t} \cdot \gamma^{CV}_g \quad \forall y \in Y, a\in A, g\in G, t\in T + \vg_{y,a,g,t} \leq \kk_{y,a,g} + v^{capa}_{y,a,g} - \vh_{y,a,g,t} \cdot \gV_g \quad \forall y \in Y, a\in A, g\in G, t\in T Generic processes ***************** @@ -227,7 +261,7 @@ This equation counts for all processes, no matter how many input or output fuels .. math:: - &\frac{{v^{gen}_{f,g,m,r,t,y}}}{\gamma^{out_gen}_{f,g,m,r,y}} = \sum_{f\in F} v^{fuse}_{f,g,m,r,t,y} \cdot \gamma^{in_gen}_{f,g,m,r,y} \quad \forall f \in F, g \in G, m \in M, r \in R, t \in T, y \in Y\\ + &\frac{{\vg_{f,g,m,r,t,y}}}{\gamma^{out_gen}_{f,g,m,r,y}} = \sum_{f\in F} \vu_{f,g,m,r,t,y} \cdot \gamma^{in_gen}_{f,g,m,r,y} \quad \forall f \in F, g \in G, m \in M, r \in R, t \in T, y \in Y\\ Storages ******** @@ -241,7 +275,7 @@ Balmorel The necessary equation for this technology is: .. math:: - & v^{sto,vol}_{y,a,g,t+1} = v^{sto,vol}_{y,a,g,t}\cdot \gamma^{total,gen}_{g} + v^{sto,load}_{y,a,g,t}\cdot \gamma^{in,gen}_{g} - v^{gen}_{y,a,g,t} \cdot \gamma^{out,gen}_{g} + & v^{sto,vol}_{y,a,g,t+1} = v^{sto,vol}_{y,a,g,t}\cdot \gamma^{total,gen}_{g} + v^{sto,load}_{y,a,g,t}\cdot \gi_{g} - \vg_{y,a,g,t} \cdot \go_{g} & \forall y \in Y, a\in A, g\in G, t\in T From 26dc67428c5fcb6c23be497153b431883a909a38 Mon Sep 17 00:00:00 2001 From: eosram <> Date: Mon, 18 May 2020 16:56:44 +0200 Subject: [PATCH 3/9] Extend substitution of parameters and variables --- doc/source/frameworks/technologies.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/source/frameworks/technologies.rst b/doc/source/frameworks/technologies.rst index 1b3ca97..4170bf0 100644 --- a/doc/source/frameworks/technologies.rst +++ b/doc/source/frameworks/technologies.rst @@ -11,6 +11,7 @@ Here the framework's representations of technologies are shown .. |gi| mathmacro:: \gamma^{in,gen} .. |gV| mathmacro:: \gamma^{CV} .. |gB| mathmacro:: \gamma^{CB} +.. |gL| mathmacro:: \gamma^{loss,con} .. other substitutions @@ -41,6 +42,8 @@ Variables and parameters +--------------------------+--------------------------------+ | .. math:: \gB | Back-pressure coefficient | +--------------------------+--------------------------------+ +| .. math:: \gL | Energy loss | ++--------------------------+--------------------------------+ Sets '''' @@ -215,7 +218,7 @@ oemof.tabular .. math:: & \epsilon^{con}_{y,r,g,t} = - \epsilon^{con}_{y,r,g,t-1} \cdot (1 - \gamma^{loss,con}_{r,g}) + \epsilon^{con}_{y,r,g,t-1} \cdot (1 - \gL_{r,g}) - \frac{\epsilon^{out}_{y,r,g,t}}{\gamma^{out}_{r,g}} + \epsilon^{in}_{y,r,g,t} \cdot \gamma^{in}_{y,r,g} \\ From 60a897e90f890c34ef6f0372a78245c51d7f07f5 Mon Sep 17 00:00:00 2001 From: eosram <> Date: Tue, 19 May 2020 14:19:17 +0000 Subject: [PATCH 4/9] Update environment file --- mathdoc.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mathdoc.yml b/mathdoc.yml index 9523d60..f44b071 100644 --- a/mathdoc.yml +++ b/mathdoc.yml @@ -1,6 +1,7 @@ name: mathdoc channels: - defaults + - conda-forge dependencies: - _libgcc_mutex=0.1 - alabaster=0.7.12 @@ -12,6 +13,7 @@ dependencies: - chardet=3.0.4 - cryptography=2.8 - docutils=0.15.2 + - fluiddyn=0.3.2 - idna=2.8 - imagesize=1.1.0 - jinja2=2.10.3 From cb0c10f5017ce7bcb4e24e4fd5364026c79d74d3 Mon Sep 17 00:00:00 2001 From: eosram <> Date: Wed, 20 May 2020 19:21:48 +0200 Subject: [PATCH 5/9] Move substitutions to a separate file Substitutions are made available in other `rst`-files by an `include` directive of said file. --- doc/source/frameworks/technologies.rst | 17 ++--------------- doc/source/index.rst | 2 ++ doc/source/macros.rst | 15 +++++++++++++++ 3 files changed, 19 insertions(+), 15 deletions(-) create mode 100644 doc/source/macros.rst diff --git a/doc/source/frameworks/technologies.rst b/doc/source/frameworks/technologies.rst index 4170bf0..a03cbac 100644 --- a/doc/source/frameworks/technologies.rst +++ b/doc/source/frameworks/technologies.rst @@ -1,22 +1,9 @@ +.. include:: ../macros.rst + Modelling of technologies ========================= Here the framework's representations of technologies are shown -.. substitutions of variable and parameter names -.. |vg| mathmacro:: v^{gen} -.. |vh| mathmacro:: v^{gen,heat} -.. |vu| mathmacro:: v^{fuse} -.. |kk| mathmacro:: \kappa^{capa} -.. |go| mathmacro:: \gamma^{out,gen} -.. |gi| mathmacro:: \gamma^{in,gen} -.. |gV| mathmacro:: \gamma^{CV} -.. |gB| mathmacro:: \gamma^{CB} -.. |gL| mathmacro:: \gamma^{loss,con} - - -.. other substitutions -.. |yrgt| mathmacro:: \forall y \in Y, r \in R, g \in G, t \in T - Declaration of notation *********************** diff --git a/doc/source/index.rst b/doc/source/index.rst index f5ebcc9..4b352e5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,6 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +.. include:: macros.rst + Welcome to the mathematical documentation of the open_MODEX Frameworks! ======================================================================= diff --git a/doc/source/macros.rst b/doc/source/macros.rst new file mode 100644 index 0000000..a0e5a4a --- /dev/null +++ b/doc/source/macros.rst @@ -0,0 +1,15 @@ +.. Definition of substitions for each variable and parameter name + +.. |vg| mathmacro:: v^{gen} +.. |vh| mathmacro:: v^{gen,heat} +.. |vu| mathmacro:: v^{fuse} +.. |kk| mathmacro:: \kappa^{capa} +.. |go| mathmacro:: \gamma^{out,gen} +.. |gi| mathmacro:: \gamma^{in,gen} +.. |gV| mathmacro:: \gamma^{CV} +.. |gB| mathmacro:: \gamma^{CB} +.. |gL| mathmacro:: \gamma^{loss,con} + +.. Additional substitutions +.. |yrgt| mathmacro:: \forall y \in Y, r \in R, g \in G, t \in T + From 668fef638e8d2291d1f56395d9f8e7288357114b Mon Sep 17 00:00:00 2001 From: eosram <> Date: Wed, 20 May 2020 19:30:27 +0200 Subject: [PATCH 6/9] Move mathematical notation to separate file This information is essential and should be more visible. --- doc/source/frameworks/technologies.rst | 45 ------------------------- doc/source/index.rst | 3 +- doc/source/notation.rst | 46 ++++++++++++++++++++++++++ 3 files changed, 47 insertions(+), 47 deletions(-) create mode 100644 doc/source/notation.rst diff --git a/doc/source/frameworks/technologies.rst b/doc/source/frameworks/technologies.rst index a03cbac..bce5a57 100644 --- a/doc/source/frameworks/technologies.rst +++ b/doc/source/frameworks/technologies.rst @@ -4,51 +4,6 @@ Modelling of technologies ========================= Here the framework's representations of technologies are shown -Declaration of notation -*********************** - -Variables and parameters -'''''''''''''''''''''''' - -+--------------------------+--------------------------------+ -| Notation | Short description | -+==========================+================================+ -| .. math:: \vg | Electricity production | -+--------------------------+--------------------------------+ -| .. math:: \vh | Heat production | -+--------------------------+--------------------------------+ -| .. math:: \vu | Fuel usage | -+--------------------------+--------------------------------+ -| .. math:: \kk | Installed capacity | -+--------------------------+--------------------------------+ -| .. math:: \go | Plant efficiency (input) | -+--------------------------+--------------------------------+ -| .. math:: \gi | Plant efficiency (output) | -+--------------------------+--------------------------------+ -| .. math:: \gV | | -+--------------------------+--------------------------------+ -| .. math:: \gB | Back-pressure coefficient | -+--------------------------+--------------------------------+ -| .. math:: \gL | Energy loss | -+--------------------------+--------------------------------+ - -Sets -'''' - -+--------------------------+--------------------------------+ -| Notation | Short description | -+==========================+================================+ -| .. math:: y \in Y | Years | -+--------------------------+--------------------------------+ -| .. math:: r \in R | Regions | -+--------------------------+--------------------------------+ -| .. math:: g \in G | Technologies | -+--------------------------+--------------------------------+ -| .. math:: t \in T | Timesteps | -+--------------------------+--------------------------------+ -| .. math:: a \in A | | -+--------------------------+--------------------------------+ - VRE-units ********* diff --git a/doc/source/index.rst b/doc/source/index.rst index 4b352e5..959e6e2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,8 +3,6 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -.. include:: macros.rst - Welcome to the mathematical documentation of the open_MODEX Frameworks! ======================================================================= @@ -16,6 +14,7 @@ For a basic introduction into the syntax of rst, check out the `sphinx help Date: Wed, 20 May 2020 19:34:38 +0200 Subject: [PATCH 7/9] Fix typo --- doc/source/notation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/notation.rst b/doc/source/notation.rst index 042e99e..242f6bd 100644 --- a/doc/source/notation.rst +++ b/doc/source/notation.rst @@ -17,9 +17,9 @@ Variables and parameters +--------------------------+--------------------------------+ | .. math:: \kk | Installed capacity | +--------------------------+--------------------------------+ -| .. math:: \go | Plant efficiency (input) | +| .. math:: \go | Plant efficiency (output) | +--------------------------+--------------------------------+ -| .. math:: \gi | Plant efficiency (output) | +| .. math:: \gi | Plant efficiency (input) | +--------------------------+--------------------------------+ | .. math:: \gV | | +--------------------------+--------------------------------+ From f5668f9c57075e43640f6f69aae0b75cead18b0b Mon Sep 17 00:00:00 2001 From: eosram <> Date: Mon, 25 May 2020 15:04:04 +0200 Subject: [PATCH 8/9] Extend substitution of parameters and variables --- doc/source/frameworks/technologies.rst | 6 +++--- doc/source/macros.rst | 4 ++++ doc/source/notation.rst | 8 ++++++++ 3 files changed, 15 insertions(+), 3 deletions(-) diff --git a/doc/source/frameworks/technologies.rst b/doc/source/frameworks/technologies.rst index bce5a57..73584e5 100644 --- a/doc/source/frameworks/technologies.rst +++ b/doc/source/frameworks/technologies.rst @@ -132,7 +132,7 @@ Balmorel The necessary equation for this technology is: .. math:: - & v^{sto,vol}_{y,a,g,t+1} = v^{sto,vol}_{y,a,g,t}\cdot \gamma^{total,gen}_{g} + v^{sto,load}_{y,a,g,t}\cdot \gi_{g} - \vg_{y,a,g,t} \cdot \go_{g} + & \vsv_{y,a,g,t+1} = \vsv_{y,a,g,t}\cdot \gt_{g} + \vsl_{y,a,g,t}\cdot \gi_{g} - \vg_{y,a,g,t} \cdot \go_{g} & \forall y \in Y, a\in A, g\in G, t\in T @@ -146,11 +146,11 @@ urbs GENeSYS-MOD ''''''''''' -Do I understand it correct with Balmorel that v^{sto,vol} refers to the amount of energy in a storage at a given time? Then I will use it this way here as well. +Do I understand it correct with Balmorel that \vsv refers to the amount of energy in a storage at a given time? Then I will use it this way here as well. .. math:: - &v^{sto,vol}_{g,r,t,y} = v^{sto,vol}_{g,r,t-1,y} + v^{sto,load}_{g,r,t-1,y}\cdot \gamma^{in}_{g,y} - \frac{v^{sto,unload}_{g,r,t-1,y}}{\gamma^{in}_{g,y}} \quad \forall g \in G, r \in R, t \in T, y \in Y\\ + &\vsv_{g,r,t,y} = \vsv_{g,r,t-1,y} + \vsl_{g,r,t-1,y}\cdot \gamma^{in}_{g,y} - \frac{\vsu_{g,r,t-1,y}}{\gamma^{in}_{g,y}} \quad \forall g \in G, r \in R, t \in T, y \in Y\\ diff --git a/doc/source/macros.rst b/doc/source/macros.rst index a0e5a4a..b6bae33 100644 --- a/doc/source/macros.rst +++ b/doc/source/macros.rst @@ -6,9 +6,13 @@ .. |kk| mathmacro:: \kappa^{capa} .. |go| mathmacro:: \gamma^{out,gen} .. |gi| mathmacro:: \gamma^{in,gen} +.. |gt| mathmacro:: \gamma^{total,gen} .. |gV| mathmacro:: \gamma^{CV} .. |gB| mathmacro:: \gamma^{CB} .. |gL| mathmacro:: \gamma^{loss,con} +.. |vsv| mathmacro:: v^{sto,vol} +.. |vsl| mathmacro:: v^{sto,load} +.. |vsu| mathmacro:: v^{sto,unload} .. Additional substitutions .. |yrgt| mathmacro:: \forall y \in Y, r \in R, g \in G, t \in T diff --git a/doc/source/notation.rst b/doc/source/notation.rst index 242f6bd..68e66cf 100644 --- a/doc/source/notation.rst +++ b/doc/source/notation.rst @@ -21,12 +21,20 @@ Variables and parameters +--------------------------+--------------------------------+ | .. math:: \gi | Plant efficiency (input) | +--------------------------+--------------------------------+ +| .. math:: \gt | Overall plant efficiency | ++--------------------------+--------------------------------+ | .. math:: \gV | | +--------------------------+--------------------------------+ | .. math:: \gB | Back-pressure coefficient | +--------------------------+--------------------------------+ | .. math:: \gL | Energy loss | +--------------------------+--------------------------------+ +| .. math:: \vsv | Stored energy | ++--------------------------+--------------------------------+ +| .. math:: \vsl | | ++--------------------------+--------------------------------+ +| .. math:: \vsu | | ++--------------------------+--------------------------------+ Sets '''' From 731232ebc2200f508c8974351e861dcfe58f1de4 Mon Sep 17 00:00:00 2001 From: eosram <> Date: Mon, 25 May 2020 15:32:08 +0200 Subject: [PATCH 9/9] Add comment --- doc/source/frameworks/technologies.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/source/frameworks/technologies.rst b/doc/source/frameworks/technologies.rst index 73584e5..6fd12f7 100644 --- a/doc/source/frameworks/technologies.rst +++ b/doc/source/frameworks/technologies.rst @@ -1,5 +1,12 @@ .. include:: ../macros.rst +.. Besides math operations and set membership in formulas only placeholders + should be used to promote consistency. + To include a new placeholder update `../macros.rst` AND `../notation.rst`. + This is a global registry of symbol plus superscript combinations + representing a unique parameter or variable name. The definition of sets is + also part of `../notation.rst`. + Modelling of technologies ========================= Here the framework's representations of technologies are shown