Update episode "Configuration" for v2.14.0#408
Conversation
schlunma
left a comment
schlunma
left a comment
There was a problem hiding this comment.
Thanks for these updates Lisa! I have a couple of comments. I think we should really make clear that there is not a single configuration file anymore but rather a configuration directory that can be filled with as many YAML files as the user likes.
In addtion, it would be great to briefly mention in a dedicated section that the configuration options can also be specified vie the command line. For this, it would be good to link https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/configure.html#command-line-arguments and mention that those options will overwrite any setting given by the YAML files.
P.S. Unfortunately, I was not able to build the website locally (see #419), so I just looked at the source files here.
| >> - Are you working on your local machine and have downloaded data using ESMValTool? | ||
| >> You need to add the root path of the folder where the data has been downloaded to as | ||
| >> specified in the `esgf-cache`. | ||
| >> | ||
| >> ```yaml | ||
| >> projects: | ||
| >> ... | ||
| >> CMIP6: | ||
| >> data: | ||
| >> local: | ||
| >> type: esmvalcore.io.local.LocalDataSource | ||
| >> rootpath: <your_climate_data_dir> | ||
| >> dirname_template: "{project}/{activity}/{institute}/{dataset}/{exp}/{ensemble}/{mip}/{short_name}/{grid}/{version}" | ||
| >> filename_template: "{short_name}_{mip}_{dataset}_{exp}_{ensemble}_{grid}*.nc" | ||
| >> esgf-cache: | ||
| >> type: esmvalcore.io.local.LocalDataSource | ||
| >> rootpath: <your_download_dir> | ||
| >> dirname_template: "{project}/{activity}/{institute}/{dataset}/{exp}/{ensemble}/{mip}/{short_name}/{grid}/{version}" | ||
| >> filename_template: "{short_name}_{mip}_{dataset}_{exp}_{ensemble}_{grid}*.nc" | ||
| >> CMIP5: | ||
| >> data: | ||
| >> local: | ||
| >> type: esmvalcore.io.local.LocalDataSource | ||
| >> rootpath: <your_climate_data_dir> | ||
| >> dirname_template: "{project.lower}/{product}/{institute}/{dataset}/{exp}/{frequency}/{modeling_realm}/{mip}/{ensemble}/{version}/{short_name}" | ||
| >> filename_template: "{short_name}_{mip}_{dataset}_{exp}_{ensemble}*.nc" | ||
| >> esgf-cache: | ||
| >> type: esmvalcore.io.local.LocalDataSource | ||
| >> rootpath: <your_download_dir> | ||
| >> dirname_template: "{project.lower}/{product}/{institute}/{dataset}/{exp}/{frequency}/{modeling_realm}/{mip}/{ensemble}/{version}" | ||
| >> filename_template: "{short_name}_{mip}_{dataset}_{exp}_{ensemble}*.nc" | ||
| >>``` |
There was a problem hiding this comment.
I am not sure if this is needed. The intake configuration you show above will also look in this path.
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
…_Tutorial into update_epsiode_03
hb326
left a comment
hb326
left a comment
There was a problem hiding this comment.
Looks ok to me, and seems described clearly enough (it was clear enough for me).
We might have to do some beta testing for the episode when we have it publicly available to see if we have to polish the description a little more. But for now I would say this is fine.
3 participants
Pull Request checklist
Before you start
Tasks
Lesson developmentsection in CONTRIBUTING.md and does not contain any spelling or grammatical errors.Lesson organizationandLesson formattingsections in CONTRIBUTING.md and does not contain any spelling or grammatical errors.make serve, alternativelymake docker-serve. Please see thePreviewing your changes locallysection in CONTRIBUTING.md for installation instructions.If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.
Closes #402