Updates after review for merge request (issue#49)

Update of example.toml, CONFIG_TEMPLATE in read_config.py and tests/read_config_test.py Update of openairclim.rst for automatic generation of API doc for module calc_cont.py
dlr-pa · Nov 25, 2024 · 470878c · 470878c
1 parent a6b2564
commit 470878c
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 3 deletions.
diff --git a/docs/source/openairclim.rst b/docs/source/openairclim.rst
@@ -20,6 +20,14 @@ openairclim.calc\_co2 module
    :undoc-members:
    :show-inheritance:
 
+openairclim.calc\_cont module
+----------------------------
+
+.. automodule:: openairclim.calc_cont
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 openairclim.calc\_dt module
 ---------------------------
 

diff --git a/example/example.toml b/example/example.toml
@@ -77,7 +77,8 @@ N2O.scenario = "SSP2-4.5"
 dir = "../repository/"
 CO2.response_grid = "0D"
 CO2.conc.method = "Sausen&Schumann"
-#CO2.rf.method = "Etminan_2016"      # Etminan et al. 2016
+# RF method based on Etminan et al. 2016 is used by default.
+#CO2.rf.method = "Etminan_2016"
 
 H2O.response_grid = "2D"
 H2O.rf.file = "resp_RF.nc"

diff --git a/openairclim/read_config.py b/openairclim/read_config.py
@@ -17,7 +17,7 @@
 # Template of config dictionary with types of MANDATORY input settings
 CONFIG_TEMPLATE = {
     "species": {"inv": Iterable, "out": Iterable},
-    "inventories": {"dir": str, "files": Iterable},
+    "inventories": {"dir": str, "files": Iterable, "rel_to_base": bool},
     "output": {
         "full_run": bool,
         "dir": str,

diff --git a/tests/read_config_test.py b/tests/read_config_test.py
@@ -47,7 +47,7 @@ def fixture_setup_arguments():
     """
     config_template = {
         "species": {"inv": Iterable, "out": Iterable},
-        "inventories": {"dir": str, "files": Iterable},
+        "inventories": {"dir": str, "files": Iterable, "rel_to_base": bool},
         "output": {
             "full_run": bool,
             "dir": str,