Merge pull request #902 from ie3-institute/sp/#901-convert-eval-rst

Converting all instances of `eval-rst` to the equivalent myst syntax
ie3-institute · Aug 15, 2024 · 4973d89 · 4973d89
2 parents 5df170c + 47a7599
commit 4973d89
Show file tree

Hide file tree

Showing 7 changed files with 84 additions and 105 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -70,6 +70,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated dependabot reviewers [#888](https://github.com/ie3-institute/simona/issues/888)
 - Merged `HpModelTestData` with `HpTestData` to `HpInputTestData` [#872](https://github.com/ie3-institute/simona/issues/872)
 - Harmonised both methods that check the inner temperature of thermal house against the boundaries [#880](https://github.com/ie3-institute/simona/issues/880)
+- Convert all `eval-rst` instances in rtd to myst syntax [#901](https://github.com/ie3-institute/simona/issues/901)
 
 ### Fixed
 - Removed a repeated line in the documentation of vn_simona config [#658](https://github.com/ie3-institute/simona/issues/658)

diff --git a/docs/readthedocs/index.md b/docs/readthedocs/index.md
@@ -1,10 +1,9 @@
 # Welcome to simona docs
 
-```{eval-rst}
-.. figure:: ../logo/logo_tightcrop_transparent.png
-  :figwidth: 25%
-  :align: right
-  :alt: logo of simona
+```{image} ../logo/logo_tightcrop_transparent.png
+:width: 25%
+:align: right
+:alt: logo of simona
 ```
 
 Welcome to the documentation of simona - an agent-based discrete-event power system simulation model developed at the

diff --git a/docs/readthedocs/models/cts_model.md b/docs/readthedocs/models/cts_model.md
@@ -39,9 +39,9 @@ $$
 $$
 
 Reference:
-```{eval-rst} 
-* :cite:ts:`Quaschning.2013`
-```
+
+* {cite:cts}`Quaschning.2013`
+
 
 That is the mathematical description of loading and unloading processes concerning the buffer storage. Whenever heat is stored within the storage or removed from the storage this equation is used. This includes the case that the whole heat demand is satisfied by the storage.
 

diff --git a/docs/readthedocs/models/pv_model.md b/docs/readthedocs/models/pv_model.md
@@ -53,10 +53,9 @@ $$
 
 **References:**
 
-```{eval-rst}
-* :cite:cts:`Maleki.2017` 
-* :cite:ts:`Spencer.1971`
-```
+* {cite:cts}`Maleki.2017`
+* {cite:cts}`Spencer.1971`
+
 
 ### Hour Angle
 
@@ -104,11 +103,10 @@ $$
 
 **References:**
 
-```{eval-rst}
-* :cite:cts:`Watter.2013` 
-* :cite:ts:`Maleki.2017`
-* :cite:ts:`Wang.2019`
-```
+* {cite:cts}`Watter.2013`
+* {cite:cts}`Maleki.2017`
+* {cite:cts}`Wang.2019`
+
 
 ### Sunrise Angle
 
@@ -127,10 +125,10 @@ $$
 **$\phi$** = observer's latitude
 
 **References:**
-```{eval-rst}
-* :cite:cts:`Maleki.2017` 
-* :cite:ts:`Itaca_Sun`
-```
+
+* {cite:cts}`Maleki.2017`
+* {cite:cts}`Itaca_Sun`
+
 
 ### Solar Altitude Angle
 
@@ -147,10 +145,9 @@ $$
 
 **References:**
 
-```{eval-rst} 
-* :cite:ts:`Maleki.2017` p. 5
-* :cite:ts:`Itaca_Sun`
-```
+* {cite:cts}`Maleki.2017` p. 5
+* {cite:cts}`Itaca_Sun`
+
 
 ### Zenith Angle
 
@@ -192,10 +189,9 @@ $$
 
 **References:**
 
-```{eval-rst} 
-* :cite:ts:`Quaschning.2013`
-* :cite:ts:`Maleki.2017` p. 18
-```
+* {cite:cts}`Quaschning.2013`
+* {cite:cts}`Maleki.2017` p. 18
+
 
 ### Air Mass
 
@@ -211,10 +207,9 @@ $$
 
 **References:**
 
-```{eval-rst} 
-* :cite:ts:`Schoenberg.1929`
-* :cite:ts:`WikiAirMass`
-```
+* {cite:cts}`Schoenberg.1929`
+* {cite:cts}`WikiAirMass`
+
 
 ### Extraterrestrial Radiation
 
@@ -237,10 +232,9 @@ $$
 
 **References:**
 
-```{eval-rst} 
-* :cite:ts:`Zheng.2017` p. 53, formula 2.3b
-* :cite:ts:`Iqbal.1983`
-```
+* {cite:cts}`Zheng.2017` p. 53, formula 2.3b
+* {cite:cts}`Iqbal.1983`
+
 
 ### Beam Radiation on Sloped Surface
 
@@ -296,9 +290,8 @@ $$
 
 **Reference:**
 
-```{eval-rst} 
-* :cite:ts:`Duffie.2013` p. 88
-```
+* {cite:cts}`Duffie.2013` p. 88
+
 
 ### Diffuse Radiation on Sloped Surface
 
@@ -408,11 +401,10 @@ $$
 
 **References:**
 
-```{eval-rst} 
-* :cite:ts:`Perez.1987`
-* :cite:ts:`Perez.1990`
-* :cite:ts:`Myers.2017` p. 96f
-```
+* {cite:cts}`Perez.1987`
+* {cite:cts}`Perez.1990`
+* {cite:cts}`Myers.2017` p. 96f
+
 
 ### Reflected Radiation on Sloped Surface
 
@@ -427,9 +419,8 @@ $$
 **$\rho$** = albedo
 
 **Reference:**
-```{eval-rst} 
-* :cite:ts:`Maleki.2017` p. 19
-```
+
+* {cite:cts}`Maleki.2017` p. 19
 
 
 ### Output

diff --git a/docs/readthedocs/models/reference_system.md b/docs/readthedocs/models/reference_system.md
@@ -6,44 +6,41 @@ The reference system is built up by specifying the included voltage levels. The
 
 ## Default reference system
 
-```{eval-rst}
-.. list-table::
-    :widths: 33 33 33
-    :header-rows: 0
-    
-    
-    * - Voltage level (id)
-      - Nominal voltage (vNom)
-      - Apparent power (sNom)
-    
-    * - LV
-      - 0.4 kV
-      - 100 kVA
-    
-    * - MV
-      - 10 kV
-      - 40 MVA
-      
-    * - MV
-      - 20 kV
-      - 60 MVA
-      
-    * - MV
-      - 30 kV
-      - 150 MVA
-      
-    * - HV
-      - 110 kV
-      - 600 MVA
-      
-    * - EHV
-      - 220 kV
-      - 800 MVA
-      
-    * - EHV
-      - 380 kV
-      - 1000 MVA      
-
+```{list-table}
+:widths: auto
+:header-rows: 1
+
+* - Voltage level (id)
+  - Nominal voltage (vNom)
+  - Apparent power (sNom)
+
+* - LV
+  - 0.4 kV
+  - 100 kVA
+
+* - MV
+  - 10 kV
+  - 40 MVA
+  
+* - MV
+  - 20 kV
+  - 60 MVA
+  
+* - MV
+  - 30 kV
+  - 150 MVA
+  
+* - HV
+  - 110 kV
+  - 600 MVA
+  
+* - EHV
+  - 220 kV
+  - 800 MVA
+  
+* - EHV
+  - 380 kV
+  - 1000 MVA
 ```
 
 

diff --git a/docs/readthedocs/models/three_winding_transformer_model.md b/docs/readthedocs/models/three_winding_transformer_model.md
@@ -41,6 +41,4 @@ More details on the physical model transformation can be found in the Ph.D. thes
 
 **References:**
 
-```{eval-rst}
-:cite:cts:`Kittl_2022`
-```
+- {cite:cts}`Kittl_2022`
diff --git a/docs/readthedocs/references.md b/docs/readthedocs/references.md
@@ -1,26 +1,19 @@
 # Publications and References
 
-## Publications
+## SIMONA publications
 
 The following publications discuss SIMONA and implementation details as well as outcomes where SIMONA have been used:
 
-```{eval-rst}
-The following publications discuss SIMONA and implementation details as well as outcomes where SIMONA have been used:
-
-.. rubric:: SIMONA Publications
-
-.. bibliography:: _static/bibliography/bibAboutSimona.bib
-   :style: unsrt
-   :all:
-
+```{bibliography} _static/bibliography/bibAboutSimona.bib
+:style: unsrt
+:all:
+```
 
-References
-===============
+## References
 
 References of publications SIMONA referred on:
 
-.. rubric:: References
-.. bibliography:: _static/bibliography/bibtexAll.bib
-   :style: custom
-   :all:
+```{bibliography} _static/bibliography/bibtexAll.bib
+:style: custom
+:all:
 ```