-
Notifications
You must be signed in to change notification settings - Fork 128
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
Improve the Python example diagnostic and documentation #1827
Conversation
Do we need documentation for the example recipes? |
I think that would be nice. I for one have looked for it a few times. |
I'd like to use this recipe in the tutorial. Therefore, it would be nice to be able to point to some basic documentation as well. |
@bouweandela some of the changes in this PR seem to be unrelated to the objective. Is this intended? |
@Peter9192 Yes, I think so, the objective of the pull request is to improve the documentation on how to make your first recipe and diagnostic. |
@schlunma I already implemented the changes needed to deprecate output_file_type etc in ESMValGroup/ESMValCore#808, but that didn't make it into the ESMValCore v2.1 release, so hopefully it will make it in v2.2. To try out the new default without an |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job @bouweandela, works as expected (tested with output_file_type: png
and output_file_type: null
). I have some comments regarding the new helper functions.
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am happy now, nice work! 🎉
Make the example recipe and python diagnostic a bit nicer
output_file_type
/write_plots
/write_netcdf
from config-user.yml to those recipes that need it in Deprecate defining write_plots and write_netcdf in config-user file ESMValCore#808This will allow using the example Python diagnostic to create the timeseries in the tutorial too.
Tasks
yamllint
to check that your YAML files do not contain mistakesModified recipe/diagnostic
doc/sphinx/source/recipes
folderRelated to ESMValGroup/ESMValTool_Tutorial#141