@@ -83,7 +83,7 @@ This file contains the information for:
8383
8484## Destination directory
8585
86- The configuration file starts with setting the destination directory , which is
86+ The example configuration file contains the option `` output_dir `` , which is
8787the rootpath where ESMValTool will store its output folders containing
8888e.g. figures, data, logs, etc. With every run, ESMValTool automatically
8989generates a new output folder determined by recipe name, and date and time
@@ -111,8 +111,7 @@ using the format: YYYYMMDD_HHMMSS.
111111
112112Additionally you can configure the output settings that
113113inform ESMValTool about your preference for output.
114- You can turn on or off the setting by ``true`` or ``false``
115- values. Most of these settings are fairly self-explanatory.
114+ Most of these settings are fairly self-explanatory.
116115
117116
118117> # # Saving preprocessed data
@@ -121,7 +120,7 @@ values. Most of these settings are fairly self-explanatory.
121120> `preproc` folder.
122121> This folder contains preprocessed data and is removed by default when
123122> ESMValTool is run.
124- > In the configuration file , which settings can be modified to prevent
123+ > In the configuration, which settings can be modified to prevent
125124> this from happening?
126125>
127126>> # # Solution
@@ -175,26 +174,32 @@ amount of memory available in your system.
175174{: .callout}
176175
177176
178- # # Make your own configuration file
177+ # # Customizing your configuration
179178
180- Configuration files could live in the user configuration directory, which is
181- by default ``~/.config/esmvaltool``. The directory could be also specified
182- via the command line argument ``--config_dir`` or can be changed with the
183- ESMVALTOOL_CONFIG_DIR environment variable .
179+ By default, configuration files are read from the directory ``~/.config/esmvaltool``.
180+ This can be changed via the ``ESMVALTOOL_CONFIG_DIR`` environment variable.
181+ In addition another custom configuration directory can be specified via the
182+ ` ` --config_dir`` command line argument .
184183We will learn how to do this in the
185184[next lesson]({{ page.root }}{% link _episodes/04-recipe.md %}).
186185
187186It is possible to have several configuration files with different purposes,
188- for example : config-user_formalised_runs .yml, config-user_debugging .yml.
187+ for example : ` ` dask_options .yml``, ``data_sources .yml`` .
189188In this case, ESMValTool searches for all YAML files within each of the
190189configuration directories and merges them together. How this is done is
191190explained [here](https://docs.esmvaltool.org/projects/ESMValCore/en/
192191latest/quickstart/configure.html#yaml-files).
193192
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+
194199
195200# # Rootpath to input data
196201
197- 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)
198203for input data based on their source (e.g.
199204CMIP6, CMIP5, obs4mips, OBS6, OBS). For example, CMIP is used for a dataset from
200205the Climate Model Intercomparison Project whereas OBS may be
@@ -212,41 +217,40 @@ be obtained by running the command
212217 esmvaltool config copy data-local-esmvaltool.yml
213218~~~
214219
215- After the default file " data-local-esmvaltool.yml" is copied in your configuration
216- 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
217222` dirname_template` to match your file locations. The ``rootpath`` specifies the
218223directories where ESMValTool will look for input data of the specific project. The
219224` dirname_template` setting describes the file structure for each project.
220225
221- If you are working on a HPC system there are also several example configurations
222- 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
223228files, run the command :
224229
225230~~~bash
226231 esmvaltool config list data-hpc
227232~~~
228233
229- 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 :
230235~~~bash
231236 esmvaltool config copy data-hpc-dkrz.yml
232237~~~
233238
234239It is also possible to ask ESMValTool to download climate model data as needed. When
235- running ` ESMValTool` you can automatically download the files required to run a recipe
236- from ESGF for the projects CMIP3, CMIP5, CMIP6, CORDEX, and obs4MIPs. Therefore
237- 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
238243
239244~~~bash
240245 esmvaltool config copy data-intake-esgf.yml
241246~~~
242247
243- Additionally we need to configure [intake-esgf]
248+ Additionally, it is necessary to configure [intake-esgf]
244249(https://intake-esgf.readthedocs.io/en/stable/configure.html).
245- This can be done by specifying a download directory in the intake-esgf configure file,
246- which is by default `~/.esgf`. Therefor copy the conf.yaml file in the
247- ` ~/.config/intake-esgf` folder and replace the default under `local_cache:` and add
248- this download folder also under `esg_dataroot:`. The uodated file should
249- 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 :
250254> # # conf.yml
251255>
252256> ```yaml
@@ -303,8 +307,8 @@ look like this:
303307>> # # Solution
304308>>
305309>> - Are you working on your own local machine?
306- >> You need to copy the `data-local-esmvaltool.yml` into your config directory
307- >> 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:
308312>>
309313>>```yaml
310314>> projects:
@@ -362,7 +366,7 @@ look like this:
362366>> Site-specific path to the data for JASMIN/DKRZ/ETH/IPSL
363367>> are already available in specific configuration files. You
364368>> need to copy this file in your configuration directory.
365- >> For example, on DKRZ:
369+ >> For example, on DKRZ, run :
366370>>
367371>>```bash
368372>> esmvaltool config copy data-hpc-dkrz.yml
0 commit comments