ufs-community / uwtools

Workflow tools for use with applications with UFS and beyond

GNU Lesser General Public License v2.1

12 stars 24 forks source link

Create a Cookbook Notebook #631

Closed christinaholtNOAA closed 2 weeks ago

christinaholtNOAA commented 1 month ago

AC

[x] Create a Cookbook style Jupyter notebook
[x] Write unit tests for the notebook
[x] Create a link to the notebook on RtD -- perhaps on top-level index of the docs.

Description

Create a cookbook entry based on the EMC/NCO Demo.

Show each config file (defaults, ICs, physics, user-specifics) and explain its significance
- Shorten the base config by using a base_file; dereference some paths to make things easier to render.
Show a function that combines the configs and renders Jinja expressions
Show the resulting combined config
Show how further updates can be added from another user-specific config