From 2110465050acfedabe49e6e93e7eb5b809cc2023 Mon Sep 17 00:00:00 2001 From: Birgit Hassler <33543691+hb326@users.noreply.github.com> Date: Tue, 3 Jun 2025 10:05:32 +0200 Subject: [PATCH 1/3] Update 03-configuration.md Making the episode compatible with the latest released Version, v2.12.0. Also fixing some text and some broken links. --- _episodes/03-configuration.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/_episodes/03-configuration.md b/_episodes/03-configuration.md index 8c307a0f..894c68e1 100644 --- a/_episodes/03-configuration.md +++ b/_episodes/03-configuration.md @@ -2,7 +2,7 @@ title: "Configuration" teaching: 10 exercises: 10 -compatibility: ESMValTool v2.10.0 +compatibility: ESMValTool v2.12.0 questions: - What is the user configuration file and how should I use it? @@ -45,7 +45,7 @@ The default configuration file will be downloaded to the default location: path to your home directory. Note that files and directories starting with a period are "hidden", to see the `.config` directory in the terminal use `ls -la ~`. -With the optional ``--path=`` you could specifiy the directory +With the optional ``--path=`` you can specifiy the directory in which the configuration file can be saved. For instance, you can provide the path to your working directory as the `target_dir`. Note, if a configuration file by that name already exists in the default @@ -62,7 +62,7 @@ and then modify it if needed: nano ~/.config/esmvaltool/config-user.yml ~~~ -Any other editor can be used, e.g.vim. +If ``nano`` does not work on your system, any other editor can be used, e.g. ``vim``. This file contains the information for: @@ -230,8 +230,7 @@ uncommenting the machine specific lines should be sufficient to access input dat >>``` >> >> - For more information about setting the rootpath, see also the ESMValTool ->> [documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/ -quickstart/find_data.html). +>> [documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html). > {: .solution} {: .challenge} @@ -243,8 +242,7 @@ The ``drs`` setting describes the file structure for several projects (e.g. CMIP6, CMIP5, obs4mips, OBS6, OBS) on several key machines (e.g. BADC, CP4CDS, DKRZ, ETHZ, SMHI, BSC). For more information about ``drs``, you can visit the ESMValTool documentation on -[Data Reference Syntax (DRS)](https://docs.esmvaltool.org/projects/ESMValCore/ -en/latest/quickstart/find_data.html#explaining-drs-cmip5-or-drs-cmip6). +[Data Reference Syntax (DRS)](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/find_data.html#explaining-drs-cmip5-or-drs-cmip6). > ## Set the correct drs > @@ -320,8 +318,7 @@ if you want to feed some additional data (e.g. shape files) to your recipe. > auxiliary_data_dir: ~/auxiliary_data > ``` > See more information in ESMValTool -[documentation](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/ -quickstart/configure.html?highlight=auxiliary_data#top-level-configuration-options). +[documentation](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/configure.html?highlight=auxiliary_data#top-level-configuration-options). {: .callout} > ## Number of parallel tasks @@ -354,8 +351,7 @@ amount of memory available in your system. > for example: config-user_formalised_runs.yml, config-user_debugging.yml. > In this case, ESMValTool searches for all YAML files within each of the > configuration directories and merges them together. How this is done is -> exlained [here](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/ -> quickstart/configure.html#yaml-files). +> exlained [here](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/configure.html#yaml-files). {: .callout} {% include links.md %} From fffe3b4b61ec5eca48ea10b36547623273ada081 Mon Sep 17 00:00:00 2001 From: Birgit Hassler <33543691+hb326@users.noreply.github.com> Date: Tue, 3 Jun 2025 10:22:35 +0200 Subject: [PATCH 2/3] Update 03-configuration.md Undoing the link fixes since the tests fail with them. Also, the links seem to be fine in the final episode display. --- _episodes/03-configuration.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/_episodes/03-configuration.md b/_episodes/03-configuration.md index 894c68e1..93ae9fc0 100644 --- a/_episodes/03-configuration.md +++ b/_episodes/03-configuration.md @@ -62,7 +62,7 @@ and then modify it if needed: nano ~/.config/esmvaltool/config-user.yml ~~~ -If ``nano`` does not work on your system, any other editor can be used, e.g. ``vim``. +If ``nano`` does not work on your system, or if you prefer a different editor, any other editor can be used, e.g. ``vim``. This file contains the information for: @@ -230,7 +230,8 @@ uncommenting the machine specific lines should be sufficient to access input dat >>``` >> >> - For more information about setting the rootpath, see also the ESMValTool ->> [documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html). +>> [documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/ +latest/quickstart/find_data.html). > {: .solution} {: .challenge} @@ -242,7 +243,8 @@ The ``drs`` setting describes the file structure for several projects (e.g. CMIP6, CMIP5, obs4mips, OBS6, OBS) on several key machines (e.g. BADC, CP4CDS, DKRZ, ETHZ, SMHI, BSC). For more information about ``drs``, you can visit the ESMValTool documentation on -[Data Reference Syntax (DRS)](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/find_data.html#explaining-drs-cmip5-or-drs-cmip6). +[Data Reference Syntax (DRS)](https://docs.esmvaltool.org/projects/ESMValCore/ +en/latest/quickstart/find_data.html#explaining-drs-cmip5-or-drs-cmip6). > ## Set the correct drs > @@ -318,7 +320,8 @@ if you want to feed some additional data (e.g. shape files) to your recipe. > auxiliary_data_dir: ~/auxiliary_data > ``` > See more information in ESMValTool -[documentation](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/configure.html?highlight=auxiliary_data#top-level-configuration-options). +[documentation](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/ +> quickstart/configure.html?highlight=auxiliary_data#top-level-configuration-options). {: .callout} > ## Number of parallel tasks @@ -351,7 +354,8 @@ amount of memory available in your system. > for example: config-user_formalised_runs.yml, config-user_debugging.yml. > In this case, ESMValTool searches for all YAML files within each of the > configuration directories and merges them together. How this is done is -> exlained [here](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/configure.html#yaml-files). +> explained [here](https://docs.esmvaltool.org/projects/ESMValCore/en/ +> latest/quickstart/configure.html#yaml-files). {: .callout} {% include links.md %} From 4b5a55cddc6c1166b557a5be178d6f83ce6ee9e4 Mon Sep 17 00:00:00 2001 From: Birgit Hassler <33543691+hb326@users.noreply.github.com> Date: Tue, 3 Jun 2025 10:25:19 +0200 Subject: [PATCH 3/3] Update 03-configuration.md Fixing the line length of one updated sentence. --- _episodes/03-configuration.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_episodes/03-configuration.md b/_episodes/03-configuration.md index 93ae9fc0..babd02f3 100644 --- a/_episodes/03-configuration.md +++ b/_episodes/03-configuration.md @@ -62,7 +62,8 @@ and then modify it if needed: nano ~/.config/esmvaltool/config-user.yml ~~~ -If ``nano`` does not work on your system, or if you prefer a different editor, any other editor can be used, e.g. ``vim``. +If ``nano`` does not work on your system, or if you prefer a different editor, +any other editor can be used, e.g. ``vim``. This file contains the information for: