Remove support for ~/.esmvaltool/config-user.yml and ~/.esmvaltool/dask.yml

[bouweandela]

Description

Remove support for ~/.esmvaltool/config-user.yml and ~/.esmvaltool/dask.yml. These options have been deprecated since v2.12.0 of the tool and will no longer be available starting in v2.14.0.

Related to #2371

Link to documentation: https://esmvaltool--2878.org.readthedocs.build/projects/ESMValCore/en/2878/quickstart/configure.html#yaml-files (note the deleted box describing the ~/.esmvaltool/config-user.yml feature).

Upgrade instructions

Move the file ~/.esmvaltool/config-user.yml to ~/.config/esmvaltool/config-user.yml and replace ~/.esmvaltool/dask.yml by new way of configuring Dask.

---

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
• 🛠 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

[codecov]

Codecov Report

❌ Patch coverage is 92.30769% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 95.44%. Comparing base (19d4725) to head (016727c).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
esmvalcore/_main.py	88.88%	1 Missing ⚠️

❌ Your patch status has failed because the patch coverage (92.30%) is below the target coverage (100.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2878      +/-   ##
==========================================
- Coverage   95.49%   95.44%   -0.05%     
==========================================
  Files         261      261              
  Lines       15557    15415     -142     
==========================================
- Hits        14856    14713     -143     
- Misses        701      702       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[valeriupredoi]

excellent! But I reckon we need a troubleshooting example - I asked for one in #2765 - so maybe pop one in there 🍺

[bouweandela]

Thanks for reviewing! Can you explain in a bit more detail what you expect from "a troubleshooting example"?

[valeriupredoi]

Thanks for reviewing! Can you explain in a bit more detail what you expect from "a troubleshooting example"?

ah sorry, stuff like unsetting ESMVALTOOL_CONFIG_DIR variable, and removing an existing .esmvaltool/config-user.yml - the bits you told me to do so I can stop having issues with the config settings

[bouweandela]

After this is merged, ~/.esmvaltool/config-user.yml will be ignored. I could log a warning if it exists to let users know that we're ignoring it?

ESMVALTOOL_CONFIG_DIR is useful if you want a different location than the default, e.g. useful to provide HPC module users with decent defaults for their HPC system.

[valeriupredoi]

After this is merged, ~/.esmvaltool/config-user.yml will be ignored. I could log a warning if it exists to let users know that we're ignoring it?

that would be most welcome, good sir 🍺

ESMVALTOOL_CONFIG_DIR is useful if you want a different location than the default, e.g. useful to provide HPC module users with decent defaults for their HPC system.

yes indeed! I never thought of it that way, mostly because I barely run the tool at all these days 😁