From 258696999530a8e72d2ce697ec801c4908821cb2 Mon Sep 17 00:00:00 2001
From: Fabian Neumann <fabian.neumann@outlook.de>
Date: Thu, 16 Mar 2023 12:05:36 +0100
Subject: [PATCH] docs: add missing configuration options

---
 doc/configtables/conventional.csv |  3 +++
 doc/configtables/run.csv          |  5 +++++
 doc/configtables/toplevel.csv     |  5 -----
 doc/configuration.rst             | 15 ++++++++++++++-
 doc/requirements.txt              |  6 ++++--
 doc/tutorial.rst                  |  1 +
 6 files changed, 27 insertions(+), 8 deletions(-)
 create mode 100644 doc/configtables/conventional.csv
 create mode 100644 doc/configtables/run.csv

diff --git a/doc/configtables/conventional.csv b/doc/configtables/conventional.csv
new file mode 100644
index 00000000..fb031197
--- /dev/null
+++ b/doc/configtables/conventional.csv
@@ -0,0 +1,3 @@
+,Unit,Values,Description
+{name},--,"string","For any carrier/technology overwrite attributes as listed below."
+-- {attribute},--,"string or float","For any attribute, can specify a float or reference to a file path to a CSV file giving floats for each country (2-letter code)."
diff --git a/doc/configtables/run.csv b/doc/configtables/run.csv
new file mode 100644
index 00000000..012b94c6
--- /dev/null
+++ b/doc/configtables/run.csv
@@ -0,0 +1,5 @@
+,Unit,Values,Description
+name,--,"any string","Specify a name for your run. Results will be stored under this name."
+disable_progrssbar,bool,"{true, false}","Switch to select whether progressbar should be disabled."
+shared_resources,bool,"{true, false}","Switch to select whether resources should be shared across runs."
+shared_cutouts,bool,"{true, false}","Switch to select whether cutouts should be shared across runs."
\ No newline at end of file
diff --git a/doc/configtables/toplevel.csv b/doc/configtables/toplevel.csv
index a587cfb3..8a4b443c 100644
--- a/doc/configtables/toplevel.csv
+++ b/doc/configtables/toplevel.csv
@@ -4,11 +4,6 @@ tutorial,bool,"{true, false}","Switch to retrieve the tutorial data set instead
 logging,,,
 -- level,--,"Any of {'INFO', 'WARNING', 'ERROR'}","Restrict console outputs to all infos, warning or errors only"
 -- format,--,"","Custom format for log messages. See `LogRecord <https://docs.python.org/3/library/logging.html#logging.LogRecord>`_ attributes."
-run,,,
--- name,--,"any string","Specify a name for your run. Results will be stored under this name."
--- disable_progrssbar,bool,"{true, false}","Switch to select whether progressbar should be disabled."
--- shared_resources,bool,"{true, false}","Switch to select whether resources should be shared across runs."
--- shared_cutouts,bool,"{true, false}","Switch to select whether cutouts should be shared across runs."
 foresight,string,"{overnight, myopic, perfect}","Defaults to overnight scenarios."
 countries,--,"Subset of {'AL', 'AT', 'BA', 'BE', 'BG', 'CH', 'CZ', 'DE', 'DK', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IE', 'IT', 'LT', 'LU', 'LV', 'ME', 'MK', 'NL', 'NO', 'PL', 'PT', 'RO', 'RS', 'SE', 'SI', 'SK'}","European countries defined by their `Two-letter country codes (ISO 3166-1) <https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>`_ which should be included in the energy system model."
 focus_weights,--,"Keys should be two-digit country codes (e.g. DE) and values should range between 0 and 1","Ratio of total clusters for particular countries. the remaining weight is distributed according to mean load. An example: ``focus_weights: 'DE': 0.6 'FR': 0.2``."
diff --git a/doc/configuration.rst b/doc/configuration.rst
index ac223885..001205bc 100644
--- a/doc/configuration.rst
+++ b/doc/configuration.rst
@@ -42,6 +42,10 @@ The ``run`` section is used for running and storing scenarios with different con
    :start-at: run:
    :end-before: foresight:
 
+.. csv-table::
+   :header-rows: 1
+   :widths: 25,7,22,30
+   :file: configtables/run.csv
 
 ``scenario``
 ============
@@ -111,6 +115,11 @@ Switches for some rules and optional features.
    :start-at: enable:
    :end-before: co2_budget:
 
+.. csv-table::
+   :header-rows: 1
+   :widths: 25,7,22,30
+   :file: configtables/enable.csv
+
 .. _electricity_cf:
 
 ``electricity``
@@ -230,6 +239,10 @@ overwrite the existing values.
    :start-at:   conventional:
    :end-before: lines:
 
+.. csv-table::
+   :header-rows: 1
+   :widths: 25,7,22,30
+   :file: configtables/conventional.csv
 
 ``lines``
 =============
@@ -436,7 +449,7 @@ overwrite the existing values.
 .. csv-table::
    :header-rows: 1
    :widths: 25,7,22,30
-   :file: configtables/solving-solver.csv
+   :file: configtables/solving.csv
 
 .. _plotting_cf:
 
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 9aaaa05d..94f8cc26 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -9,9 +9,11 @@ pypsa
 vresutils>=0.3.1
 powerplantmatching>=0.5.5
 atlite>=0.2.9
-dask
+dask[distributed]
+matplotlib
+tabula-py
 
-# cartopy
+cartopy
 scikit-learn
 pycountry
 pyyaml
diff --git a/doc/tutorial.rst b/doc/tutorial.rst
index f443ac19..72649619 100644
--- a/doc/tutorial.rst
+++ b/doc/tutorial.rst
@@ -305,6 +305,7 @@ configuration file.
     commit to a run:
 
     .. code:: bash
+        
         snakemake -call solve_elec_networks -n
 
 How to analyse results?