Skip to content

Commit c585bf3

Browse files
LisaBockschlunma
andauthored
Apply suggestions from code review
Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com>
1 parent 3f6e9ec commit c585bf3

1 file changed

Lines changed: 24 additions & 19 deletions

File tree

_episodes/03-configuration.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -184,16 +184,22 @@ We will learn how to do this in the
184184
[next lesson]({{ page.root }}{% link _episodes/04-recipe.md %}).
185185
186186
It is possible to have several configuration files with different purposes,
187-
for example: config-user_formalised_runs.yml, config-user_debugging.yml.
187+
for example: ``dask_options.yml``, ``data_sources.yml``.
188188
In this case, ESMValTool searches for all YAML files within each of the
189189
configuration directories and merges them together. How this is done is
190190
explained [here](https://docs.esmvaltool.org/projects/ESMValCore/en/
191191
latest/quickstart/configure.html#yaml-files).
192192
193+
To show the final configuration that is actually used when running ESMValTool, you can use
194+
195+
~~~bash
196+
esmvaltool config show
197+
~~~
198+
193199
194200
## Rootpath to input data
195201
196-
ESMValTool uses several categories (in ESMValTool, this is referred to as projects)
202+
ESMValTool uses several categories (in ESMValTool, these are referred to as projects)
197203
for input data based on their source (e.g.
198204
CMIP6, CMIP5, obs4mips, OBS6, OBS). For example, CMIP is used for a dataset from
199205
the Climate Model Intercomparison Project whereas OBS may be
@@ -211,41 +217,40 @@ be obtained by running the command
211217
esmvaltool config copy data-local-esmvaltool.yml
212218
~~~
213219
214-
After the default file "data-local-esmvaltool.yml" is copied in your configuration
215-
folder `~/.config/esmvaltool/config-user.yml` you can update the `rootpath` and the
220+
After the file ``data-local-esmvaltool.yml`` has been copied to your configuration
221+
directory `~/.config/esmvaltool/`, you can update the `rootpath` and the
216222
`dirname_template` to match your file locations. The ``rootpath`` specifies the
217223
directories where ESMValTool will look for input data of the specific project. The
218224
`dirname_template` setting describes the file structure for each project.
219225
220-
If you are working on a HPC system there are also several example configurations
221-
for popular HPC systems, .e.g. JASMIN/DKRZ/ETH/IPSL. To list the available example
226+
If you are working on a HPC system, there are also several configurations
227+
for popular HPC systems, e. g. JASMIN, DKRZ, ETH, and IPSL. To list the available example
222228
files, run the command:
223229
224230
~~~bash
225231
esmvaltool config list data-hpc
226232
~~~
227233
228-
To load the suitable configuration file for the HPC system at DKRZ you can type:
234+
To load the configuration suitable for the HPC system at DKRZ, run:
229235
~~~bash
230236
esmvaltool config copy data-hpc-dkrz.yml
231237
~~~
232238
233239
It is also possible to ask ESMValTool to download climate model data as needed. When
234-
running `ESMValTool` you can automatically download the files required to run a recipe
235-
from ESGF for the projects CMIP3, CMIP5, CMIP6, CORDEX, and obs4MIPs. Therefore
236-
we need to copy the appropriate configuration file in the default configuration folder:
240+
running ESMValTool you can automatically download the files required to run a recipe
241+
from ESGF for the projects CMIP3, CMIP5, CMIP6, CORDEX, and obs4MIPs. For this,
242+
copy the appropriate configuration file by running
237243
238244
~~~bash
239245
esmvaltool config copy data-intake-esgf.yml
240246
~~~
241247
242-
Additionally we need to configure [intake-esgf]
248+
Additionally, it is necessary to configure [intake-esgf]
243249
(https://intake-esgf.readthedocs.io/en/stable/configure.html).
244-
This can be done by specifying a download directory in the intake-esgf configure file,
245-
which is by default `~/.esgf`. Therefor copy the conf.yaml file in the
246-
`~/.config/intake-esgf` folder and replace the default under `local_cache:` and add
247-
this download folder also under `esg_dataroot:`. The uodated file should
248-
look like this:
250+
This can be done by updating the `local_cache` and `esg_dataroot`
251+
with your desired download directory in your
252+
intake-esgf configuration file located at `~/.config/intake-esgf/conf.yaml`.
253+
The updated file should look like this:
249254
> ## conf.yml
250255
>
251256
> ```yaml
@@ -302,8 +307,8 @@ look like this:
302307
>> ## Solution
303308
>>
304309
>> - Are you working on your own local machine?
305-
>> You need to copy teh `data-local-esmvaltool.yml` into your config directory
306-
>> and add the root path of the folder where the data is available (e.g., ``<your_climate_data_dir>``) as:
310+
>> You need to copy `data-local-esmvaltool.yml` into your configuration directory
311+
>> and specify the root path of the folder where the data is available (e.g., ``<your_climate_data_dir>``) as:
307312
>>
308313
>>```yaml
309314
>> projects:
@@ -361,7 +366,7 @@ look like this:
361366
>> Site-specific path to the data for JASMIN/DKRZ/ETH/IPSL
362367
>> are already available in specific configuration files. You
363368
>> need to copy this file in your configuration directory.
364-
>> For example, on DKRZ:
369+
>> For example, on DKRZ, run:
365370
>>
366371
>>```bash
367372
>> esmvaltool config copy data-hpc-dkrz.yml

0 commit comments

Comments
 (0)