44Configuration
55*************
66
7+ .. _config_overview :
8+
79Overview
810========
911
@@ -17,11 +19,12 @@ nested dictionary for its configuration.
1719 Its main aim is to simplify the configuration by moving from many different
1820 configuration files for individual components to one configuration object
1921 that consists of a single nested dictionary (similar to `Dask's configuration
20- <https://docs.dask.org/en/stable/configuration.html> `__). This change will
21- not be implemented in one large pull request but rather in a step-by-step
22- procedure. Thus, the configuration might appear inconsistent until this
23- redesign is finished. A detailed plan for this new configuration is outlined
24- in :issue: `2371 `.
22+ <https://docs.dask.org/en/stable/configuration.html> `__).
23+ This change will not be implemented in one large pull request but rather in a
24+ step-by-step procedure.
25+ Thus, the configuration might appear inconsistent until this redesign is
26+ finished.
27+ A detailed plan for this new configuration is outlined in :issue: `2371 `.
2528
2629
2730.. _config_for_cli :
@@ -33,6 +36,8 @@ When running recipes via the :ref:`command line <running>`, configuration
3336options can be specified via YAML files and command line arguments.
3437
3538
39+ .. _config_yaml_files :
40+
3641YAML files
3742----------
3843
@@ -597,9 +602,6 @@ out by CMOR and DRS. For a detailed description of these standards and their
597602adoption in ESMValCore, we refer the user to :ref: `CMOR-DRS ` section where we
598603relate these standards to the data retrieval mechanism of the ESMValCore.
599604
600- By default, esmvaltool looks for it in the home directory,
601- inside the '.esmvaltool' folder.
602-
603605Users can get a copy of this file with default values by running
604606
605607.. code-block :: bash
@@ -614,6 +616,14 @@ If the option ``--path`` is omitted, the file will be created in
614616 Remember to change the configuration option ``config_developer_file `` if you
615617 want to use a custom config developer file.
616618
619+ .. warning ::
620+
621+ For now, make sure that the custom ``config-developer.yml `` is **not ** saved
622+ in the ESMValTool/Core configuration directories (see
623+ :ref: `config_yaml_files ` for details).
624+ This will change in the future due to the :ref: `redesign of ESMValTool/Core's
625+ configuration <config_overview>`.
626+
617627Example of the CMIP6 project configuration:
618628
619629.. code-block :: yaml
0 commit comments