diff --git a/doc/changelog.rst b/doc/changelog.rst index 39522238e8..f5cbe8b0df 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -16,16 +16,40 @@ This release includes Backwards incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -TODO: add examples of how to deal with these changes +- Remove the deprecated option ``use_legacy_supplementaries`` (`#2202 `__) `Bouwe Andela `__ + + - The recommended upgrade procedure is to remove ``use_legacy_supplementaries`` from config-user.yml + (if it was there) and remove any mention of fx_variables from the recipe. If automatically defining + the required supplementary variables does not work, define them in the variable or + (``additional_``) ``datasets`` section as described in :ref:`supplementary_variables`. - Use smarter (units-aware) weights (`#2139 `__) `Manuel Schlund `__ -- Remove deprecated way of calling ``esmvalcore.cmor.table.read_cmor_tables`` (`#2201 `__) `Bouwe Andela `__ -- Remove deprecated callback argument from preprocessor ``load`` function (`#2207 `__) `Bouwe Andela `__ -- Remove the deprecated option ``use_legacy_supplementaries`` (`#2202 `__) `Bouwe Andela `__ -- Remove deprecated preprocessor function `cleanup` (`#2215 `__) `Bouwe Andela `__ + + - Some preprocessors handle units better. For details, see the issue. + - Removed deprecated configuration option `offline` (`#2213 `__) `Manuel Schlund `__ + + - In :ref:`changelog-v2-8-0`, we replaced the old `offline` configuration option. From this version on, it stops working. + Please refer to :ref:`changelog-v2-8-0` for upgrade instructions. + - Fix issue with CORDEX datasets requiring different dataset tags for downloads and fixes (`#2066 `__) `Joakim Löw `__ + + - Due to the different facets for CORDEX datasets, there was an inconsistency in the fixing mechanism. + This change requires changes to existing recipes that use CORDEX datasets. Please refer to the pull request for detailed update instructions. + - Added new operators for statistics preprocesor (e.g., `percentile`) and allowed arbitrary kwargs (`#2191 `__) `Manuel Schlund `__ + + - This harmonizes the operators for all statistics preprocessors. From this version, the new names can be used; the old arguments will stop working from + version 2.12.0. Please refer to :ref:`stat_preprocs` for a detailed description. + +- For the following changes, no user change is necessary + + - Remove deprecated way of calling :func:`~esmvalcore.cmor.table.read_cmor_tables` (`#2201 `__) `Bouwe Andela `__ + + - Remove deprecated callback argument from preprocessor ``load`` function (`#2207 `__) `Bouwe Andela `__ + + - Remove deprecated preprocessor function `cleanup` (`#2215 `__) `Bouwe Andela `__ + Deprecations ~~~~~~~~~~~~ @@ -36,12 +60,12 @@ Bug fixes ~~~~~~~~~ - [Github Actions] Fix Monitor Tests Github Action (`#2135 `__) `Valeriu Predoi `__ -- Re-add correctly region-extracted cell measures and ancillary variables after `extract_region` (for Changelog v2.10: authors: @valeriupredoi and @schlunma) (`#2166 `__) `Valeriu Predoi `__ -- Fix sorting of ensemble members in `esmvalcore.dataset.datasets_to_recipe` (`#2095 `__) `Bouwe Andela `__ +- Re-add correctly region-extracted cell measures and ancillary variables after :ref:`extract_region` (`#2166 `__) `Valeriu Predoi `__, `Manuel Schlund `__ +- Fix sorting of ensemble members in :func:`~esmvalcore.dataset.datasets_to_recipe` (`#2095 `__) `Bouwe Andela `__ - Avoid a crash if dataset has supplementary variables (`#2198 `__) `Bouwe Andela `__ - Restored usage of numpy in `_mask_with_shp` (`#2209 `__) `Jörg Benke `__ - Fix a problem with sorting datasets that have a mix of facet types (`#2238 `__) `Bouwe Andela `__ -- Fix `concatenate` preprocessor function (`#2240 `__) `Bouwe Andela `__ +- Fix ``concatenate`` preprocessor function (`#2240 `__) `Bouwe Andela `__ - Fix time overlap handling in concatenation (`#2247 `__) `Klaus Zimmermann `__ Notebook API (experimental) @@ -52,16 +76,16 @@ Notebook API (experimental) CMOR standard ~~~~~~~~~~~~~ -- ERA5 on-the-fly CMORizer: changed sign of `evspsbl` and `evspsblpot` (`#2115 `__) `katjaweigel `__ -- Add ch4 surface custom cmor table entry (`#2168 `__) `Birgit Hassler `__ +- ERA5 on-the-fly CMORizer: changed sign of variables ``evspsbl`` and ``evspsblpot`` (`#2115 `__) `katjaweigel `__ +- Add ``ch4`` surface custom cmor table entry (`#2168 `__) `Birgit Hassler `__ - Add CMIP3 institutes names used at NCI (`#2152 `__) `Romain Beucher `__ -- Call coord.core_bounds() instead of coord.bounds in `check.py` (`#2146 `__) `sloosvel `__ -- Added `get_time_bounds` and `get_next_month` to public API (`#2214 `__) `Manuel Schlund `__ +- Call coord.core_bounds() instead of coord.bounds in ``check.py`` (`#2146 `__) `sloosvel `__ +- Added :func:`~esmvalcore.cmor.fixes.get_time_bounds` and :func:`~esmvalcore.cmor.fixes.get_next_month` to public API (`#2214 `__) `Manuel Schlund `__ Computational performance improvements ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Make preprocessors mask_above/below_threshold, mask_inside/outside_range lazy (`#2169 `__) `Jörg Benke `__ +- Make :ref:`threshold_masking` preprocessors lazy (`#2169 `__) `Jörg Benke `__ - Rechunk between preprocessor steps (`#2205 `__) `Bouwe Andela `__ - Reduce the size of the dask graph created by the ``anomalies`` preprocessor function (`#2200 `__) `Bouwe Andela `__ @@ -79,7 +103,7 @@ Documentation - Ensure compatible zstandard and zstd versions for .conda support (`#2204 `__) `Klaus Zimmermann `__ - Remove outdated documentation (`#2210 `__) `Bouwe Andela `__ - Correct usage help text of version command (`#2232 `__) `James Frost `__ -- Add `navigation_with_keys: False` to `html_theme_options` in Readthedocs `conf.py` (`#2245 `__) `Valeriu Predoi `__ +- Add ``navigation_with_keys: False`` to ``html_theme_options`` in Readthedocs ``conf.py`` (`#2245 `__) `Valeriu Predoi `__ - Replace squarey badge with roundy shield for Anaconda sticker in README (`#2233 `__) `Valeriu Predoi `__ Fixes for datasets @@ -97,7 +121,7 @@ Installation Preprocessor ~~~~~~~~~~~~ -- Relax concatenation checks for `--check_level=relax` and `--check_level=ignore` (`#2144 `__) `sloosvel `__ +- Relax concatenation checks for ``--check_level=relax`` and ``--check_level=ignore`` (`#2144 `__) `sloosvel `__ - Improve preprocessor output sorting code (`#2111 `__) `Bouwe Andela `__ - Preprocess datasets in the same order as they are listed in the recipe (`#2103 `__) `Bouwe Andela `__ diff --git a/doc/recipe/preprocessor.rst b/doc/recipe/preprocessor.rst index 590a0eff1e..5c4b14e351 100644 --- a/doc/recipe/preprocessor.rst +++ b/doc/recipe/preprocessor.rst @@ -744,6 +744,8 @@ After ``mask_multimodel``, all involved datasets have an identical mask. See also :func:`esmvalcore.preprocessor.mask_multimodel`. +.. _threshold_masking: + Minimum, maximum and interval masking ------------------------------------- @@ -1696,6 +1698,7 @@ Examples: See also :func:`esmvalcore.preprocessor.extract_coordinate_points`. +.. _extract_region: ``extract_region`` ------------------