Fixed the documentation and updated headers (#28)

* Fixed the documentation and updated headers * Renaming
balmorelcommunity · Jan 21, 2025 · d9c654b · d9c654b
1 parent 7af371f
commit d9c654b
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 30 deletions.
diff --git a/docs/examples.md b/docs/examples.md
diff --git a/docs/examples/execution.md → docs/execution.md b/docs/examples/execution.md → docs/execution.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,11 @@
 # pybalmorel
 Convenient python framework for pre-, post-processing or executing the GAMS framework [Balmorel](https://balmorelcommunity.github.io/Balmorel).
 
-Get started [here](get_started.md).
+Get started [here](get_started.md), or check out our GitHub repository for jupyter notebooks examples:
+- [Pre-Processing](https://github.com/Mathias157/pybalmorel/blob/master/examples/PreProcessing.ipynb)
+- [Execution](https://github.com/Mathias157/pybalmorel/blob/master/examples/Execution.ipynb)
+- [Post-Processing](https://github.com/Mathias157/pybalmorel/blob/master/examples/PostProcessing.ipynb)
+- [Map Plotting](https://github.com/Mathias157/pybalmorel/blob/master/examples/MapPlotting.ipynb)
 
 
 ```{toctree}
@@ -10,7 +14,9 @@ Get started [here](get_started.md).
 :hidden:
 
 get_started
-examples
+preprocessing
+execution
+postprocessing
 ```
 
 ```{toctree}

diff --git a/docs/postprocessing.md b/docs/postprocessing.md
@@ -0,0 +1,10 @@
+# Post Processing
+
+The package includes many plotting tools. Go to the next page to get an overview and the [map plotting page](postprocessing/map_plotting.md) for details on the map plotting tool.
+
+```{toctree}
+:maxdepth: 1
+
+postprocessing/overview.md
+postprocessing/map_plotting.md
+```
diff --git a/docs/examples/postprocessing_map.md → docs/postprocessing/map_plotting.md b/docs/examples/postprocessing_map.md → docs/postprocessing/map_plotting.md
@@ -1,4 +1,4 @@
-# Pybalmorel for map plotting
+# Pybalmorel for Map Plotting
 
 This notebook provide examples on how to use the pybalmorel post processing map plotting tool. 
 

diff --git a/docs/examples/postprocessing.md → docs/postprocessing/overview.md b/docs/examples/postprocessing.md → docs/postprocessing/overview.md
@@ -1,4 +1,4 @@
-# Post-Processing
+# Overview
 
 There are several functions to plot energy balances, transmission capacity maps and a ipywidget to interactively plot bar charts, check out [this notebook](https://github.com/Mathias157/pybalmorel/blob/master/examples/PostProcessing.ipynb).
 
@@ -30,14 +30,8 @@ model.results.plot_map(model.results.sc[0], 'electricity', 2050)
 model.results.plot_profile('heat', 2050, model.results.sc[1])
 ```
 
-For more information about the map plotting please look here :
+There are many more features, read more about the map plotting tool here [here](map_plotting.md).
 
-```{toctree}
-:maxdepth: 1
-:hidden:
-
-postprocessing_map.md
-```
 
 ## Getting Specific Results
 The `model.results` is actually a `MainResults` class. The example below illustrates how to get specific results using that class.

diff --git a/docs/examples/preprocessing.md → docs/preprocessing.md b/docs/examples/preprocessing.md → docs/preprocessing.md
@@ -55,7 +55,7 @@ GUI.geofilemaker()
 ```  
 
 The video below illustrates how it works.
-:::{figure} ../img/geoset_generator_example.gif 
+:::{figure} /img/geoset_generator_example.gif 
 :name: geofilemaker
 :alt: How to use the 'geofilemaker' GUI.
 :width: 100% 

diff --git a/examples/PostProcessing_map.ipynb → examples/MapPlotting.ipynb b/examples/PostProcessing_map.ipynb → examples/MapPlotting.ipynb