Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix for configuration file documentation images #134

Merged
merged 2 commits into from
Sep 10, 2024
Merged

fix for configuration file documentation images #134

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
673b009
fix for configuration file documentation images
TeaganKing Sep 10, 2024
7b1ec07
move images to docs/_static/images/config
TeaganKing Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

print("sys.path:", sys.path)

# Copy README and NCAR_tips into docs
# Copy README, NCAR_tips, and contributors into docs
# 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.
Expand All @@ -35,6 +35,16 @@
with open(file, "w") as f:
f.write(file1 + file_rest)

# Copy images into ${CUPID}/docs/_static/images/
for file in [
"config_1.png",
"config_2.png",
"config_3.png",
"config_4.png",
"config_5.png",
]:
os.system(f"cp ../images/{file} ../docs/_static/images/")

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking a little closer, docs/_static/images/ is under version control in this repository... can we just do a single

$ git mv images/* docs/_static/images/

Instead of having this copy in conf.py? Given the current structure of _static/ it might even make sense to move them to docs/_static/images/config/ and then update config.md to point to the new location.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea! I just made that change. Things still build as expected locally.

# -- Project information -----------------------------------------------------

project = "CUPiD"
Expand Down
10 changes: 5 additions & 5 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

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 />
<img src="_static/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 />
<img src="_static/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 />
<img src="_static/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`.
Expand All @@ -24,12 +24,12 @@ The above section of the configuration file describes 1) global parameters that

`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 />
<img src="_static/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 />
<img src="_static/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`.
Loading