From c8c06bdd48415fa0c76b3ec0b02d9b21d16252f1 Mon Sep 17 00:00:00 2001 From: Bouwe Andela Date: Tue, 19 Dec 2023 16:42:35 +0100 Subject: [PATCH] Add v2.10 release notes (#3485) Co-authored-by: Manuel Schlund <32543114+schlunma@users.noreply.github.com> --- CITATION.cff | 4 +- doc/sphinx/source/changelog.rst | 110 ++++++++++++++++++ .../source/recipes/broken_recipe_list.rst | 10 +- 3 files changed, 121 insertions(+), 3 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 147e3acd17..cca827c46d 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -388,11 +388,11 @@ authors: orcid: "https://orcid.org/0000-0003-3780-0784" cff-version: 1.2.0 -date-released: 2023-07-06 +date-released: 2023-12-19 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.9.0" +version: "v2.10.0" ... diff --git a/doc/sphinx/source/changelog.rst b/doc/sphinx/source/changelog.rst index 52c3aa3086..e06be38aa0 100644 --- a/doc/sphinx/source/changelog.rst +++ b/doc/sphinx/source/changelog.rst @@ -3,6 +3,116 @@ Changelog ========= +v2.10.0 +------- +Highlights + +- Add a realistic IPCC example recipe that reproduces figure 9.3 from AR6. It + computes the mean sea-surface temperature anomaly between 1850-2100 over all + available CMIP6 models. See the :ref:`recipe documentation ` + or read the `blog post `__ + for more information. + +- Added more plot types to monitoring diagnostic: Hovmoeller Z vs. time, + Hovmoeller time vs latlon, variable vs. latitude are now available. See the + :ref:`recipe documentation ` for more information. + +- Add support for 4 new datasets: + + - NOAA-CIRES-20CR v3 reanalysis + - NASA MERRA reanalysis + - NOAA marine boundary layer data for CH4 + - MOBO-DIC2004-2019 + + See :ref:`supported_datasets` and :ref:`inputdata_observations` for more + information. + +- Many recipes now have up-to-date obs4MIPs dataset names so required data can + automatically be downloaded from ESGF. + +This release includes + +Bug fixes +~~~~~~~~~ + +- Update recipe shapeselect to work with shapely v2 (`#3283 `__) `Lukas `__ +- Correctly handle ``~`` when reading ``plot_folder`` option of monitoring diagnostic (`#3449 `__) `Manuel Schlund `__ +- Fixed provenance tracking for NCL multipanel PNGs (`#3332 `__) `Manuel Schlund `__ +- Fixed plot paths in NCL provenance tracking (`#3422 `__) `Manuel Schlund `__ +- Fix erroneous file_type handling in certain NCL diagnostics (`#3474 `__) `Klaus Zimmermann `__ +- Fix NCL provenance tracking (`#3477 `__) `Manuel Schlund `__ +- Fix plots and provenance in Russell diagnostics (`#3479 `__) `Manuel Schlund `__ + +Documentation +~~~~~~~~~~~~~ + +- Add merge instructions to release instructions (`#3292 `__) `Rémi Kazeroni `__ +- Update release schedule after release of v2.9.0 (`#3289 `__) `Rémi Kazeroni `__ +- Add list of failing recipes for v2.9.0 release (`#3294 `__) `Rémi Kazeroni `__ +- Update ``mamba`` version in readthedocs configuration docs builds (`#3310 `__) `Valeriu Predoi `__ +- Add Romain Beucher to citation file as contributor (`#3318 `__) `Valeriu Predoi `__ +- Removed recipe_carvalhais14nat from list of broken recipes (`#3319 `__) `Rémi Kazeroni `__ +- Add `OBS-maintainers `__ team to documentation on OBS data maintenance and CMORizer reviews (`#3335 `__) `Rémi Kazeroni `__ +- Add Pauline Bonnet to citation file (`#3347 `__) `Paulinebonnet111 `__ +- Ensure compatible zstandard and zstd in readthedocs builds (`#3362 `__) `Klaus Zimmermann `__ +- Fix documentation build (`#3397 `__) `Bouwe Andela `__ +- Minor updates to release tools (`#3216 `__) `Bouwe Andela `__ +- Enhance provenance documentation (`#3305 `__) `Alistair Sellar `__ +- Re-add communities and grants in zenodo file (`#3416 `__) `Valeriu Predoi `__ +- Update Anconda badge in README (`#3375 `__, `#3453 `__) `Valeriu Predoi `__ + +Diagnostics +~~~~~~~~~~~ + +- Slight refactoring of diagnostic script ``galytska23/select_variables_for_tigramite.py`` for generality and portability (`#3298 `__) `Valeriu Predoi `__ and `Evgenia Galytska `__ +- Allow custom variable grouping in diagnostic script ``monitor/multi_datasets.py`` (`#3343 `__) `Manuel Schlund `__ +- Extended monitor diagnostic with plot type variable vs. latitude (`#3340 `__) `ellensarauer `__ +- Add Hovmoeller Z vs. time plot to monitoring diagnostic (`#3345 `__) `cubeme `__ and `helgehr `__ +- Adding Hovmoeller time vs latlon plots to monitoring recipes (`#3341 `__) `Lukas `__ and `jeremykraftdlr `__ +- Implied heat transport new diagnostic (`#3177 `__) `Alejandro Bodas `__ +- Recipe changes for new statistics preprocessors (percentiles) (`#3351 `__) `Manuel Schlund `__ +- Add a realistic example recipe (`#3356 `__) `Peter9192 `__ and `Bouwe Andela `__ +- Support ``CenteredNorm`` in diagnostic monitor/multidatasets.py (`#3415 `__) `Manuel Schlund `__ +- Use new preprocessor statistics calling convention for recipe_easy_ipcc.yml (`#3418 `__) `Bouwe Andela `__ +- Adapt to changed style scheme name in matplotlib (`#3475 `__) `Klaus Zimmermann `__ +- Add version to dataset in python example recipe to avoid "Unknown file format" issue on JASMIN (`#3322 `__) `Emma Hogan `__ +- Add the dataset version in the heatwaves_coldwaves recipe to avoid the "Unknown file format" issue on JASMIN (`#3373 `__) `Emma Hogan `__ + +Observational and re-analysis dataset support +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Cmorizer for NOAA-CIRES-20CR v3 reanalysis (clt, clwvi, hus, prw, rlut, rlutcs, rsut, rsutcs) (`#3137 `__) `Lisa Bock `__ +- CMORizer for NASA MERRA reanalysis (`#3039 `__) `Axel Lauer `__ +- Download and formatting of NOAA marine boundary layer data for CH4 (NOAA-MBL-CH4) (`#3301 `__) `FranziskaWinterstein `__ +- Added CMORizer for MOBO-DIC2004-2019 (`#3297 `__) `Manuel Schlund `__ +- Update obs4MIPs dataset names in quantilebias recipe (`#3330 `__) `Romain Beucher `__ +- Update obs4MIPs dataset names in Schlund20esd recipe (`#3329 `__) `Romain Beucher `__ +- Update obs4MIPs dataset names in flatoipcc recipes (`#3328 `__) `Romain Beucher `__ +- Update obs4mips dataset names in clouds recipes (`#3326 `__) `Romain Beucher `__ +- Update Obs4MIPs dataset names in ECS recipes (`#3327 `__) `Romain Beucher `__ +- Update obs4mips dataset names in Bock et al recipes (`#3324 `__, `#3389 `__ and `#3473 `__) `Romain Beucher `__ and `Bouwe Andela `__ +- Update obs4mips dataset names in radiation budget recipe (`#3323 `__) `Romain Beucher `__ +- Update Obs4MIPs dataset names in perfmetrics CMIP5 recipe (`#3325 `__) `Romain Beucher `__ + +Automatic testing +~~~~~~~~~~~~~~~~~ + +- Made sklearn test backwards-compatible with sklearn < 1.3 (`#3285 `__) `Manuel Schlund `__ +- Update conda lock creation Github Action workflow and ship updated conda-lock file (`#3307 `__, `#3407 `__) `Valeriu Predoi `__ +- Compress all bash shell setters into one default option per GitHub Action workflow (`#3315 `__) `Valeriu Predoi `__ +- Remove deprecated option ``offline`` from CI configuration (`#3367 `__) `Manuel Schlund `__ + +Installation +~~~~~~~~~~~~ + +- Use ESMValCore v2.10.0 release candidates (`#3404 `__) `Klaus Zimmermann `__ + +Improvements +~~~~~~~~~~~~ + +- Merge v2.9.x into main (`#3286 `__) `Manuel Schlund `__ +- Allow NCL unit conversion `kg s-1` -> `GtC y-1` (`#3300 `__) `Manuel Schlund `__ + .. _changelog-v2-9-0: v2.9.0 diff --git a/doc/sphinx/source/recipes/broken_recipe_list.rst b/doc/sphinx/source/recipes/broken_recipe_list.rst index 18471b2382..e2c5b874d8 100644 --- a/doc/sphinx/source/recipes/broken_recipe_list.rst +++ b/doc/sphinx/source/recipes/broken_recipe_list.rst @@ -20,7 +20,15 @@ More details can be found in the :ref:`broken recipe policy - `ERA5_native6` - Derivation of custom variables `rlus` and `rsus` - `#1388 `_ + * - :ref:`recipe_julia.yml ` + - `example` + - fill values are not interpreted, resulting in an unusable plot + - `#2595 `_ * - :ref:`recipe_seaice_drift.yml ` - `sea_ice_drift_SCICEX` - - ``shapely`` issue + - ``shapely 2`` issue - `#3243 `_ + * - :ref:`recipe_pysplot.yml ` + - `plot_map` + - ``shapely 2`` issue + - `#3483 `_