YAML notebook - Githubissues

Ouranosinc / xscen

A climate change scenario-building analysis framework.

https://xscen.readthedocs.io/

Apache License 2.0

15 stars 2 forks source link

YAML notebook #191

Closed RondeauG closed 1 year ago

RondeauG commented 1 year ago

Pull Request Checklist:

[x] This PR addresses an already opened issue (for bug fixes / features)
- This PR fixes #8
[x] (If applicable) Documentation has been added / updated (for bug fixes / features)
[x] This PR does not seem to break the templates.
[x] HISTORY.rst has been updated (with summary of main changes)
- [x] Link to issue (:issue:number) and pull request (:pull:number) has been added

What kind of change does this PR introduce?

Added a YAML-centered notebook
Added @parse_config to a few functions that were missing the wrapper.
Fixed the formatting of alert boxes in the documentation.

Does this PR introduce a breaking change?

No

Other information:

RondeauG commented 1 year ago

I think we also could show an example of CONFIG.set, to set values in the workflow itself. And have a word about the "special" auto-configuring sections ? ('logging', 'xclim', 'xarray', 'warning').

Also, here would be a good place for an example using argparse and passing args to load_config. I could contribute that part.

Would you be able to contribute those? I'm not really familiar with those methods.