Solved issues in configuration files

[schlunma]

Description

This fixes the issues raise in #1456 and also synchronizes the config-user.yml file with the corresponding section in the documentation.

Closes #1456

Link to documentation: https://esmvaltool--1457.org.readthedocs.build/projects/ESMValCore/en/1457/quickstart/configure.html#user-configuration-file

---

Before you get started

• ☝ Create an issue to discuss what you are going to do

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.

• 🧪 The new functionality is relevant and scientifically sound
• 🛠 This pull request has a descriptive title and labels
• 🛠 Code is written according to the code quality guidelines
• 🧪 and 🛠 Documentation is available
• 🛠 Unit tests have been added
• 🛠 Changes are backward compatible
• 🛠 Any changed dependencies have been added or removed correctly
• 🛠 The list of authors is up to date
• 🛠 All checks below this pull request were successful

---

To help with the number pull requests:

• 🙏 We kindly ask you to review two other open pull requests in this repository

[schlunma]

@bouweandela Please add your comments to #1453 here.

I also noticed that some of the options given in esmvalcore/_config/_config.py are not given in config-user.yml (extra_facets_dir, resume_from, and run_diagnostic). This is kind of related to #1433, and I'm not sure if we should list them or not.

[codecov]

Codecov Report

Merging #1457 (80cc986) into main (7d43072) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1457      +/-   ##
==========================================
- Coverage   89.67%   89.66%   -0.01%     
==========================================
  Files         196      196              
  Lines       10339    10339              
==========================================
- Hits         9271     9270       -1     
- Misses       1068     1069       +1     

Impacted Files	Coverage Δ
esmvalcore/_config/_config.py	95.48% <ø> (-0.76%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7d43072...80cc986. Read the comment docs.

[bouweandela]

I also noticed that some of the options given in esmvalcore/_config/_config.py are not given in config-user.yml (extra_facets_dir, resume_from, and run_diagnostic). This is kind of related to #1433, and I'm not sure if we should list them or not.

I think it's fine to keep it as is. For extra_facets_dir we thought this option was too advanced for the example file, resume_from cannot have a meaningful default value as far as I know. Maybe run_diagnostic could?

In the longer term, the plan is to replace esmvalcore/_config/_config.py with esmvalcore/experimental/config which uses the defaults from config-user.yml instead of maintaining it's own copy:

ESMValCore/esmvalcore/experimental/config/_config_object.py

Lines 72 to 75 in 7d43072

	mapping = _read_config_file(filename)
	# Add defaults that are not available in esmvalcore/config-user.yml
	mapping['extra_facets_dir'] = tuple()
	mapping['resume_from'] = []

[bouweandela]

Thanks for making the changes @schlunma, the documentation look much more neat now.

[bouweandela]

Thanks!