UW-667 Jupyter notebook: Config Tool Part I - Githubissues

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

UW-667 Jupyter notebook: Config Tool Part I #607

Closed Byrnetp closed 1 month ago

Byrnetp commented 1 month ago

Synopsis

Introduces a notebook for the config tool that covers the realize, realize_to_dict, and the get_format_config family of functions. (e.g. get_yaml_config)
Adds unit tests for the notebook
Adds Binder link on the user guide main page and a button on the user_guide/api/config page of Read the Docs.

Type

[ ] Bug fix (corrects a known issue)
[ ] Code maintenance (refactoring, etc. without behavior change)
[x] Documentation
[x] Enhancement (adds new functionality)
[ ] Tooling (CI, code-quality, packaging, revision-control, etc.)

Impact

[ ] This is a breaking change (changes existing functionality)
[x] This is a non-breaking change (existing functionality continues to work as expected)

Checklist

[x] I have added myself and any co-authors to the PR's Assignees list.
[x] I have reviewed the documentation and have made any updates necessitated by this change.