diff --git a/CITATION.cff b/CITATION.cff index 562e044ecb..c226e7a27c 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -210,11 +210,11 @@ authors: given-names: Diego cff-version: 1.2.0 -date-released: 2024-05-08 +date-released: 2024-06-20 doi: "10.5281/zenodo.3387139" license: "Apache-2.0" message: "If you use this software, please cite it using these metadata." repository-code: "https://github.com/ESMValGroup/ESMValCore/" title: ESMValCore -version: "v2.11.0rc1" +version: "v2.11.0rc2" ... diff --git a/doc/changelog.rst b/doc/changelog.rst index e3e4b518d9..ad104a7b7d 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -9,21 +9,66 @@ v2.11.0 ------- Highlights -TODO: add highlights +- Performance improvements have been made to many preprocessors: + + - Preprocessors :func:`esmvalcore.preprocessor.mask_landsea`, + :func:`esmvalcore.preprocessor.mask_landseaice`, + :func:`esmvalcore.preprocessor.mask_glaciated`, + :func:`esmvalcore.preprocessor.extract_levels` are now lazy + +- Several new preprocessors have been added: + + - :func:`esmvalcore.preprocessor.local_solar_time` + - :func:`esmvalcore.preprocessor.distance_metrics` + - :func:`esmvalcore.preprocessor.histogram` + +- NEW TREND: First time release manager shout-outs! + + - This is the first ESMValTool release managed by the Met Office! We want to + shout this out - and for all future first time release managers to + shout-out - to celebrate the growing, thriving ESMValTool community. This release includes Backwards incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -TODO: add examples of how to deal with these changes - - Allow contiguous representation of extracted regions (:pull:`2230`) by :user:`rebeccaherman1` + - The preprocessor function :func:`esmvalcore.preprocessor.extract_region` + no longer automatically maps the extracted :class:`iris.cube.Cube` to the + 0-360 degrees longitude domain. If you need this behaviour, use + ``cube.intersection(longitude=(0., 360.))`` in your Python code after + extracting the region. There is no possibility to restore the previous + behaviour from a recipe. + +- Use ``iris.FUTURE.save_split_attrs = True`` to remove iris warning (:pull:`2398`) by :user:`schlunma` + + - Since `v3.8.0`_, Iris explicitly distinguishes between local and global + netCDF attributes. ESMValCore adopted this behavior with v2.11.0. With + this change, attributes are written as local attributes by default, unless + they already existed as global attributes or belong to a special list of + global attributes (in which case attributes are written as global + attributes). See :class:`iris.cube.CubeAttrsDict` for details. + +.. _v3.8.0: https://scitools-iris.readthedocs.io/en/stable/whatsnew/3.8.html#v3-8-29-feb-2024 + Deprecations ~~~~~~~~~~~~ - Refactor regridding (:pull:`2231`) by :user:`schlunma` + + - This PR deprecated two regridding schemes, which will be removed with + ESMValCore v2.13.0: + + - ``unstructured_nearest``: Please use the scheme ``nearest`` instead. + This is an exact replacement for data on unstructured grids. ESMValCore + is now able to determine the most suitable regridding scheme based on + the input data. + - ``linear_extrapolate``: Please use a generic scheme with + ``reference: iris.analysis:Linear`` and + ``extrapolation_mode: extrapolate`` instead. + - Allow deprecated regridding scheme ``linear_extrapolate`` in recipe checks (:pull:`2324`) by :user:`schlunma` - Allow deprecated regridding scheme ``unstructured_nearest`` in recipe checks (:pull:`2336`) by :user:`schlunma` @@ -33,6 +78,9 @@ Bug fixes - Do not overwrite facets from recipe with CMOR table facets for derived variables (:pull:`2255`) by :user:`bouweandela` - Fix error message in variable definition check (:pull:`2313`) by :user:`enekomartinmartinez` - Unify dtype handling of preprocessors (:pull:`2393`) by :user:`schlunma` +- Fix bug in ``_rechunk_aux_factory_dependencies`` (:pull:`2428`) by :user:`ehogan` +- Avoid loading entire files into memory when downloading from ESGF (:pull:`2434`) by :user:`bouweandela` +- Preserve cube attribute global vs local when concatenating (:pull:`2449`) by :user:`bouweandela` CMOR standard ~~~~~~~~~~~~~ @@ -55,6 +103,7 @@ Computational performance improvements - Cache regridding weights if possible (:pull:`2344`) by :user:`schlunma` - Implement lazy area weights (:pull:`2354`) by :user:`schlunma` - Avoid large chunks in :func:`esmvalcore.preprocessor.climate_statistics` preprocessor function with `period='full'` (:pull:`2404`) by :user:`bouweandela` +- Load data only once for ESMPy regridders (:pull:`2418`) by :user:`bouweandela` Documentation ~~~~~~~~~~~~~ @@ -84,10 +133,11 @@ Fixes for datasets Installation ~~~~~~~~~~~~ -- Updated iris pin to ``iris>=3.6.1`` (:pull:`2286`) by :user:`schlunma` - Pin pandas yet again avoid new ``2.2.1`` as well (:pull:`2353`) by :user:`valeriupredoi` - Update Iris pin to avoid using versions with memory issues (:pull:`2408`) by :user:`chrisbillowsMO` - Pin esmpy <8.6.0 (:pull:`2402`) by :user:`valeriupredoi` +- Pin numpy<2.0.0 to avoid pulling 2.0.0rcX (:pull:`2415`) by :user:`valeriupredoi` +- Add support for Python=3.12 (:pull:`2228`) by :user:`valeriupredoi` Preprocessor ~~~~~~~~~~~~ @@ -132,12 +182,11 @@ Improvements - Handle warnings about invalid units for iris>=3.8 (:pull:`2378`) by :user:`schlunma` - Added note on how to access ``index.html`` on remote server (:pull:`2276`) by :user:`schlunma` - Remove custom fix for concatenation of aux factories now that bug in iris is solved (:pull:`2392`) by :user:`schlunma` -- Use ``iris.FUTURE.save_split_attrs = True`` to remove iris warning (:pull:`2398`) by :user:`schlunma` - Ignored iris warnings about global attributes (:pull:`2400`) by :user:`schlunma` +- Add native6, OBS6 and RAWOBS rootpaths to metoffice config-user.yml template, and remove temporary dir (:pull:`2432`) by :user:`alistairsellar` .. _changelog-v2-10-0: - v2.10.0 ------- Highlights