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.

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

YAML notebook #191

Merged
merged 18 commits into from Apr 26, 2023
Merged

YAML notebook #191

merged 18 commits into from Apr 26, 2023

Conversation

RondeauG
Copy link
Contributor

@RondeauG RondeauG commented Apr 25, 2023

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
  • (If applicable) Documentation has been added / updated (for bug fixes / features)
  • This PR does not seem to break the templates.
  • HISTORY.rst has been updated (with summary of main changes)
    • 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:

Copy link
Collaborator

@aulemahal aulemahal left a comment

Choose a reason for hiding this comment

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

Few comments.

I think hardcoding a list of functions like that is prone to error, I will push a dynamic option in a few seconds.

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.

HISTORY.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
@RondeauG
Copy link
Contributor Author

RondeauG commented Apr 25, 2023

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.

Copy link
Contributor

@juliettelavoie juliettelavoie left a comment

Choose a reason for hiding this comment

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

looks good!
Not sure I get the point of the last cell of the notebook though...

xscen/spatial.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@aulemahal aulemahal left a comment

Choose a reason for hiding this comment

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

I approve my additions! ;)

@RondeauG RondeauG merged commit 3ba4168 into main Apr 26, 2023
6 checks passed
@RondeauG RondeauG deleted the yaml_notebook branch April 26, 2023 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make the YAML-centric notebook
3 participants