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

Make CMORizer documentation available on readthedocs #1219

Closed
bouweandela opened this issue Jul 18, 2019 · 4 comments
Closed

Make CMORizer documentation available on readthedocs #1219

bouweandela opened this issue Jul 18, 2019 · 4 comments

Comments

@bouweandela
Copy link
Member

Currently the documentation of the CMORization scripts is burried inside the code, for example:

; #############################################################################
; ESMValTool CMORizer for AURA-TES data
; #############################################################################
;
; Tier
; Tier 3: restricted dataset.
;
; Source
; https://search.earthdata.nasa.gov/search?q=TL3O3M
;
; Last access
; 20181208
;
; Download and processing instructions
; Select the V004 and V005 projects.
; Download the script file for both projects.
; To download the data use: wget -i <scriptfile>.
; From the downloaded data, pick only the *.he5 files and put them in
; input_dir_path.
; Data is freely available, but a registration is required.
;
; Modification history
; 20190108-A_righ_ma: adapted to v2.
; 20140129-A_righ_ma: written.
;

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.

@mattiarighi
Copy link
Contributor

@bouweandela
Copy link
Member Author

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.

@bouweandela
Copy link
Member Author

@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.

@remi-kazeroni
Copy link
Contributor

#1657 has added the possibility to display the documentation of a CMORizer in the command-line with esmvaltool data info DATASET. That is also described in our docs at https://docs.esmvaltool.org/en/latest/input.html#using-a-cmorizer-script. I think this issue can now be closed. Feel free to reopen if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants