Skip to content

Update episode "Configuration" for v2.14.0#408

Open
LisaBock wants to merge 20 commits intomainfrom
update_epsiode_03
Open

Update episode "Configuration" for v2.14.0#408
LisaBock wants to merge 20 commits intomainfrom
update_epsiode_03

Conversation

@LisaBock
Copy link
Copy Markdown
Member

@LisaBock LisaBock commented Apr 2, 2026

Pull Request checklist


Before you start

  • Read CONTRIBUTING.md.
  • Create an issue to discuss your idea. This allows your contributions to be incorporated into the tutorial.

Tasks

  • Give this pull request a descriptive title.
  • If you are contributing to existing lesson materials, please make sure the content conforms to the Lesson development section in CONTRIBUTING.md and does not contain any spelling or grammatical errors.
  • If you are making a new episode, please make sure the content conforms to the Lesson organization and Lesson formatting sections in CONTRIBUTING.md and does not contain any spelling or grammatical errors.
  • Preferably Codacy checks pass. Status can be seen below your pull request. If there is an error, click the link to find out why.
  • Preview changes on your machine before pushing them to GitHub by running make serve, alternatively make docker-serve. Please see the Previewing your changes locally section in CONTRIBUTING.md for installation instructions.
  • All code instructions have been tested.

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

@LisaBock LisaBock marked this pull request as ready for review April 2, 2026 10:37
@LisaBock LisaBock requested review from rswamina and schlunma April 2, 2026 10:37
Copy link
Copy Markdown

@schlunma schlunma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +320 to +351
>> - 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"
>>```
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if this is needed. The intake configuration you show above will also look in this path.

LisaBock and others added 14 commits April 10, 2026 15:04
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update "Configuration" episode for compatibility with ESMValTool v2.14.0

2 participants