Merge pull request #128 from TeaganKing/documentation

Config file documentation
NCAR · Sep 10, 2024 · 82b20d7 · 82b20d7
2 parents 2bb78a5 + 4f595a4
commit 82b20d7
Show file tree

Hide file tree

Showing 9 changed files with 38 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,3 +18,4 @@ externals/
 /docs/_build/
 /docs/README.md
 /docs/NCAR_tips.md
+/docs/contributors.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -22,6 +22,7 @@
 # This block allows us to remove the header image from any md files
 # without affecting the original version, but still pull the source
 # into the docs build fresh each time.
+
 for file in ["README.md", "NCAR_tips.md", "contributors.md"]:
     os.system(f"cp ../{file} ./")
 

diff --git a/docs/config.md b/docs/config.md
@@ -0,0 +1,35 @@
+# CUPiD Configuration File
+
+This page describes the fields in the configuration file that might commonly be edited.
+
+<img src="../../../images/config_1.png" alt="CUPiD Config 1" width=1000 />
+The data sources section of the configuration file describes general data sources and expected directory structure for running CUPiD.
+
+`sname`: nickname for this configuration as a string. This will be used as the name of the folder your computed notebooks are put in
+
+<img src="../../../images/config_2.png" alt="CUPiD Config 2" width=1000 />
+The computation config section of the configuration file supplies the default kernel for running CUPiD. This should usually be `cupid-analysis`. If a contributor wants to include additional packages, please create an issue describing the packages you'd like to add to this conda environment.
+
+
+<img src="../../../images/config_3.png" alt="CUPiD Config 3" width=1000 />
+The above section of the configuration file describes 1) global parameters that are applicable to all notebooks and 2) timeseries-related parameters specific to each component.
+
+`case_name`: name of CESM case; this should also be a subdirectory of `CESM_output_dir`.
+
+`base_case_name`: name of CESM case to compare the specified case to.
+
+`CESM_output_dir`: directory where output from CESM is located.
+
+`start_date` and `end_date`: describe the time period over which we want to analyze output.
+
+`vars` for various components: variables which CUPiD will expect to find for various components and then make timeseries for.
+
+<img src="../../../images/config_4.png" alt="CUPiD Config 4" width=1000 />
+The compute notebooks section of the configuration file describes the notebooks that will be computed as well as any parameters specific to those notebooks.
+
+`nmse_PSL`: This is the name of a notebook which is added to the atmospheric component diagnostics.
+
+`regridded_output`, `base_regridded_output`, `validation_path`, etc: These are parameters specific to the `nmse_PSL` notebook. If a contributor wants to include additional parameters specific to a notebook, we recommend following a similar format and changing variables names to represent the relevant quantities.
+
+<img src="../../../images/config_5.png" alt="CUPiD Config 5" width=1000 />
+The Jupyter Book Table of Contents section of the configuration file describes the Juptyter Book configuration to display the output of the CUPiD diagnostics. Please include your notebook name within the files under `chapters`.
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,7 @@ CUPiD Documentation
    :hidden:
 
     Adding Notebooks <addingnotebookstocollection.md>
+    Configuration File <config.md>
     Tips and Tricks for NCAR Machines <NCARtips.rst>
     Contributors <contributors.rst>
 

diff --git a/images/config_1.png b/images/config_1.png
diff --git a/images/config_2.png b/images/config_2.png
diff --git a/images/config_3.png b/images/config_3.png
diff --git a/images/config_4.png b/images/config_4.png
diff --git a/images/config_5.png b/images/config_5.png