-
Notifications
You must be signed in to change notification settings - Fork 131
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
Make CMORizer documentation available on readthedocs #1219
Comments
Is https://esmvaltool.readthedocs.io/en/latest/esmvaldiag/observations.html addressing this issue? |
No, that's describing how to write your own CMORizers. I think we need a chapter in the documentation, called e.g. 'Obtaining observational data' that explains how to run the cmorizers (we already have the text for that here: https://esmvaltool.readthedocs.io/en/latest/getting_started/inputdata.html#observations) and explains how to download the required input for the CMORizers, i.e. what is now in the CMORizer script code instead of on readthedocs. |
@JaroCamphuijsen also suggested that we take this information out of the 'Getting started' guide, because CMORizing observational data is probably not the first thing you want to do if you just want to try running ESMValTool to see if it's something you could use. |
#1657 has added the possibility to display the documentation of a CMORizer in the command-line with |
Currently the documentation of the CMORization scripts is burried inside the code, for example:
ESMValTool/esmvaltool/cmorizers/obs/cmorize_obs_aura_tes.ncl
Lines 1 to 25 in 582d3bb
I think this should be made available on readthedocs, probably somewhere here: https://esmvaltool.readthedocs.io/en/latest/getting_started/inputdata.html#observations
but I guess it would be nicer to make it a separate chapter.
The text was updated successfully, but these errors were encountered: