-
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
Extend information about native6 support on RTD #1652
Conversation
I can't figure out how to link to a different part of the documentation using a relative link with the rst syntax. Some help would be appreciated. I guess it should be something like :ref:`obtaining input data<observations>` but that doesn't work. I want to link here The link in the note here is also broken. I'd like to fix that one as well. But then, I'd need a cross-reference from Core to Tool docs, no? How to do that? |
Try adding
above the section that you want to link to. You can then create the link with:
|
Thanks Bouwe! It worked once I put an underscore before |
Sorry for the typo |
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.
@Peter9192 thank you. I made some minor comments on the changed files. However, the text benefits from a re-structuring and more clarifications.
First, it is useful if there are two separate sections for "CMORization" and ‘‘CMORization on the fly”. The latter explains what the purpose is, what are the instructions like the path and drs in the user-config-example
file, and introducing datasets in the recipe. We can use introducing ERA5 here as an example. Please note that the native era5 contains both hourly and monthly datasets.
Second, we need a separate section (e.g. subsection under ‘cmorization as a fix’) to use the recipe_era5.yml. Again this section should explain what the purpose is, what are the instructions like the path and drs in the user-config-example file, and introducing datasets in the recipe, and also the command line to run it.
Co-authored-by: SarahAlidoost <55081872+SarahAlidoost@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.
Hey @SarahAldt ,
Thanks for the review. I addressed your comments. I don't understand what you mean with the general comment about restructuring, though. There are 2 subsections, right? 1 for cmorization with a script, 1 for cmorization as a fix.
@SarahAlidoost I implemented what we discussed. Is it better like this? |
@Peter9192 thanks for the improvements. @mattiarighi could you please have a look and merge? thanks. |
This PR addresses the lack of documentation for the support of data in their native format as discussed here. So far, two notes were available in the contributing pages here and here, but anyone looking for information on cmorizing datasets will probably look at the input data page here. Therefore, I add a description there, and some links to find it from the other notes as well.
Tasks
Create an issue to discuss what you are going to do, if you haven't done so already (and add the link at the bottom)(see this threadMake sure your code is composed of functions of no more than 50 lines and uses meaningful names for variablesPlease useyamllint
to check that your YAML files do not contain mistakes