diff --git a/CITATION.cff b/CITATION.cff index f069250a3d..31404e4c7e 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -351,11 +351,11 @@ authors: orcid: "https://orcid.org/0000-0002-2406-4936" cff-version: 1.2.0 -date-released: 2023-03-28 +date-released: 2023-07-06 doi: "10.5281/zenodo.3401363" license: "Apache-2.0" message: "If you use this software, please cite it using these metadata." repository-code: "https://github.com/ESMValGroup/ESMValTool/" title: ESMValTool -version: "v2.8.0" +version: "v2.9.0" ... diff --git a/doc/sphinx/source/changelog.rst b/doc/sphinx/source/changelog.rst index e26ec7d26b..52c3aa3086 100644 --- a/doc/sphinx/source/changelog.rst +++ b/doc/sphinx/source/changelog.rst @@ -3,6 +3,113 @@ Changelog ========= +.. _changelog-v2-9-0: + +v2.9.0 +------ + +Highlights +~~~~~~~~~~ + +- A new :ref:`diagnostic ` has been + added to provide a high-level interface to + `seaborn `__, + a Python data visualization library based on + `matplotlib `__. + See the :ref:`recipe documentation ` for more + information. + +- We have included a new recipe and diagnostic that represent the major + physical processes that describe Arctic-midlatitude teleconnections and + provide the basis for the CMIP6 model evaluation for the further application + of causal discovery. + The results are discussed in the article + `"Causal model evaluation of Arctic-midlatitude teleconnections in CMIP6" `__ + by Galytska et al. (in review in Journal of Geophysical Research: Atmospheres). + +- It is now possible to use the + `Dask distributed scheduler `__, + which can + `significantly reduce the run-time of recipes `__. + Configuration examples and advice are available in the + :ref:`ESMValCore documentation `. + If configured, the Dask distributed scheduler will also be used by diagnostic + scripts written in Python, so make sure to use + `lazy data `__ + wherever it is possible in your (new) diagnostics. + More work on improving the computational performance is planned, so please + share your experiences, good and bad, with this new feature in + `ESMValGroup/ESMValCore#1763 `__. + +This release includes + +Bug fixes +~~~~~~~~~ + +- Fixed usage of ``work_dir`` in some CMORizer scripts (`#3192 `__) `Rémi Kazeroni `__ +- Realize data for scalar cube in `recipe_carvalhais14nat` to avert issue from dask latest (2023.6.0) (`#3265 `__) `Valeriu Predoi `__ +- Fix failing ``mlr`` diagnostic test by adding new scikit-learn default tag (`#3273 `__) `Rémi Kazeroni `__ +- Fix ordering of models in perfmetrics diagnostic script (`#3275 `__) `Lisa Bock `__ + +Documentation +~~~~~~~~~~~~~ + +- Update release schedule after v2.8.0 (`#3138 `__) `Rémi Kazeroni `__ +- Added reference entry for Winterstein (`#3154 `__) `FranziskaWinterstein `__ +- Show logo on PyPI (`#3185 `__) `Valeriu Predoi `__ +- Add Release Managers for v2.9.0 and v2.10.0 (`#3184 `__) `Rémi Kazeroni `__ +- Fix readthedocs build with esmpy>=8.4.0 and missing ESMFMKFILE variable (`#3205 `__) `Valeriu Predoi `__ +- Add ESMValCore release v2.8.1 into the documentation (`#3235 `__) `Rémi Kazeroni `__ +- Modified links to the tutorial (`#3236 `__) `Rémi Kazeroni `__ +- Fix gitter badge in README (`#3258 `__) `Rémi Kazeroni `__ +- Add release notes for v2.9.0 (`#3266 `__) `Bouwe Andela `__ + +Diagnostics +~~~~~~~~~~~ + +- New plot_type 1d_profile in monitor (`#3178 `__) `FranziskaWinterstein `__ +- Add Seaborn diagnostic (`#3155 `__) `Manuel Schlund `__ +- New recipe and diagnostic for Arctic-midlatitude research (`#3021 `__) `Evgenia Galytska `__ +- Generate climatology on the fly for AutoAssess soil moisture (`#3197 `__) `Alistair Sellar `__ +- Remove "fx_variables" from recipe_tebaldi21esd.yml (`#3211 `__) `Birgit Hassler `__ +- Remove "fx_variables" from ipccwg1ar5ch9 recipes (`#3215 `__) `katjaweigel `__ +- Remove "fx_variables" from recipe_wenzel14jgr.yml (`#3212 `__) `Birgit Hassler `__ +- Update obs4MIPs dataset to the current naming scheme in recipe_smpi.yml (`#2991 `__) `Bouwe Andela `__ +- Fixed pandas diagnostics for pandas>=2.0.0 (`#3209 `__) `Manuel Schlund `__ +- Update recipe_impact.yml to work with newer versions of `pandas` (`#3220 `__) `Bouwe Andela `__ +- Add variable long names to provenance record in monitoring diagnostics (`#3222 `__) `Brei Soliño `__ + +Observational and re-analysis dataset support +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Add CMORizer for GPCP-SG (pr) (`#3150 `__) `FranziskaWinterstein `__ +- Extension of NASA MERRA2 CMORizer (cl, cli, clivi, clw, clwvi) (`#3167 `__) `Axel Lauer `__ + +Automatic testing +~~~~~~~~~~~~~~~~~ + +- Add a CircleCI-testing-specific ``recipe_python_for_CI.yml`` to avoid calling geolocator/Nominatim over CI (`#3159 `__) `Valeriu Predoi `__ +- Check if Python minor version changed after Julia install in development installation test (`#3213 `__) `Valeriu Predoi `__ +- Fix tests using deprecated ``esmvalcore._config`` module that has been removed in ESMValCore v2.9 (`#3204 `__) `Valeriu Predoi `__ + +Installation +~~~~~~~~~~~~ + +- Add support for Python=3.11 (`#3173 `__) `Valeriu Predoi `__ +- Drop python=3.8 support (`#3193 `__) `Valeriu Predoi `__ +- Repair generation of conda lock files (`#3148 `__) `Valeriu Predoi `__ +- Modernize lock creation script and repair lock generation (`#3174 `__) `Valeriu Predoi `__ +- Pin numpy !=1.24.3 due to severe masking bug (`#3182 `__) `Valeriu Predoi `__ +- Update xesmf to versions >= 0.4.0 (`#2728 `__) `Klaus Zimmermann `__ +- Update esmpy import for ESMF version 8.4.0 or larger (`#3188 `__) `Valeriu Predoi `__ +- Relax the pin on iris to allow the use of older versions for performance reasons (`#3270 `__) `Bouwe Andela `__ +- Use ESMValCore v2.9.0 (`#3274 `__) `Bouwe Andela `__ + +Improvements +~~~~~~~~~~~~ + +- Update pre-commit hooks (`#3189 `__) `Bouwe Andela `__ +- Add support for using a dask distributed scheduler (`#3151 `__) `Bouwe Andela `__ .. _changelog-v2-8-0: @@ -19,7 +126,7 @@ Highlights climatologies from CMIP models as used in `Lauer et al. (2023), J. Climate `__. See :ref:`recipe documentation ` about added recipes. -- Addition of a set of recipes for extreme events, regional and impact +- Addition of a set of recipes for extreme events, regional and impact evaluation as used in `Weigel et al. (2021), J. Climate `__ and in IPCC AR5. See :ref:`recipe documentation ` about added recipes. @@ -265,7 +372,7 @@ Documentation - Update documentation for the Landschuetzer 2016 recipe. (`#2801 `__) `Tomas Torsvik `__ - Fixed anaconda badge in README (`#2866 `__) `Valeriu Predoi `__ - Update release strategy notes (`#2734 `__) `sloosvel `__ -- Add documention on how to handle CMORizers for multiple dataset versions (`#2730 `__) `Rémi Kazeroni `__ +- Add documentation on how to handle CMORizers for multiple dataset versions (`#2730 `__) `Rémi Kazeroni `__ - Extending documentation: recipe maintainer + broken recipe policy (`#2719 `__) `Axel Lauer `__ Diagnostics @@ -310,8 +417,8 @@ Highlights ~~~~~~~~~~ - A new monitoring diagnostic has been added to allow the comparison of model runs against reference datasets. For details, see :ref:`Monitoring diagnostic to show multiple datasets in one plot (incl. biases) `. -- A tool has been developed to compare the output of recipe runs against previous runs, in order to detect in an automatized way breaking changes between releases. Find more information in :ref:`Comparing recipe runs `. -- The recipe :ref:`Climate Change Hotspot ` allows to compute hotspots in any rectangular region. +- A tool has been developed to compare the output of recipe runs against previous runs, in order to detect in an automated way breaking changes between releases. Find more information in :ref:`Comparing recipe runs `. +- The recipe :ref:`Climate Change Hotspot ` allows to compute hotspots in any rectangular region. Please also note the highlights from the corresponding ESMValCore release :ref:`here`. Thanks to that ESMValTool has gained the following features: @@ -418,7 +525,7 @@ Thanks to that ESMValTool has gained the following features: - The new preprocessor ``extract_location`` can extract arbitrary locations on the Earth. - Time ranges can now be extracted using the `ISO 8601 format `_. -- The new preprocessor ``ensemble_statistics`` can calculate arbitrary statitics over all ensemble members of a simulation. +- The new preprocessor ``ensemble_statistics`` can calculate arbitrary statistics over all ensemble members of a simulation. This release includes