diff --git a/CITATION.cff b/CITATION.cff index 1f5a31582f..70cf872768 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -201,11 +201,11 @@ authors: given-names: Joerg cff-version: 1.2.0 -date-released: 2023-07-04 +date-released: 2023-11-01 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.9.0" +version: "v2.10.0rc1" ... diff --git a/doc/changelog.rst b/doc/changelog.rst index b8718686c7..daa5dae664 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -3,6 +3,144 @@ Changelog ========= +.. _changelog-v2-10-0: + +v2.10.0 +------- +Highlights + +TODO: add highlights + +This release includes + +Backwards incompatible 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 `__ + + - Some preprocessors handle units better. For details, see the pull request. + +- 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 preprocessor (e.g., ``'percentile'``) and allowed passing additional arguments (`#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 +~~~~~~~~~~~~ + +- Clearly separate fixes and CMOR checks (`#2157 `__) `Manuel Schlund `__ + +Bug fixes +~~~~~~~~~ + +- Re-add correctly region-extracted cell measures and ancillary variables after :ref:`extract_region` (`#2166 `__) `Valeriu Predoi `__, `Manuel Schlund `__ +- Fix sorting of datasets + + - Fix sorting of ensemble members in :func:`~esmvalcore.dataset.datasets_to_recipe` (`#2095 `__) `Bouwe Andela `__ + - Fix a problem with sorting datasets that have a mix of facet types (`#2238 `__) `Bouwe Andela `__ + - Avoid a crash if dataset has supplementary variables (`#2198 `__) `Bouwe Andela `__ + +CMOR standard +~~~~~~~~~~~~~ + +- 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 `__ +- Added :func:`~esmvalcore.cmor.fixes.get_time_bounds` and :func:`~esmvalcore.cmor.fixes.get_next_month` to public API (`#2214 `__) `Manuel Schlund `__ +- Improve concatenation checks + + - Relax concatenation checks for ``--check_level=relax`` and ``--check_level=ignore`` (`#2144 `__) `sloosvel `__ + - Fix ``concatenate`` preprocessor function (`#2240 `__) `Bouwe Andela `__ + - Fix time overlap handling in concatenation (`#2247 `__) `Klaus Zimmermann `__ + +Computational performance improvements +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Make :ref:`threshold_masking` preprocessors lazy (`#2169 `__) `Jörg Benke `__ + + - Restored usage of numpy in `_mask_with_shp` (`#2209 `__) `Jörg Benke `__ +- Call coord.core_bounds() instead of coord.bounds in ``check.py`` (`#2146 `__) `sloosvel `__ +- Rechunk between preprocessor steps (`#2205 `__) `Bouwe Andela `__ +- Reduce the size of the dask graph created by the ``anomalies`` preprocessor function (`#2200 `__) `Bouwe Andela `__ + +Documentation +~~~~~~~~~~~~~ + +- Add reference to release v2.9.0 in the changelog (`#2130 `__) `Rémi Kazeroni `__ +- Add merge instructions to release instructions (`#2131 `__) `Klaus Zimmermann `__ +- Update `mamba` before building environment during Readthedocs build (`#2149 `__) `Valeriu Predoi `__ +- Ensure compatible zstandard and zstd versions for .conda support (`#2204 `__) `Klaus Zimmermann `__ +- Remove outdated documentation (`#2210 `__) `Bouwe Andela `__ +- Remove meercode badge from README because their API is broken (`#2224 `__) `Valeriu Predoi `__ +- 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 `__ +- Replace squarey badge with roundy shield for Anaconda sticker in README (`#2233 `__) `Valeriu Predoi `__ + +Fixes for datasets +~~~~~~~~~~~~~~~~~~ + +- Updated doc about fixes and added type hints to fix functions (`#2160 `__) `Manuel Schlund `__ + +Installation +~~~~~~~~~~~~ + +- Clean-up how pins are written in conda environment file (`#2125 `__) `Valeriu Predoi `__ +- Use importlib.metadata instead of deprecated pkg_resources (`#2096 `__) `Bouwe Andela `__ +- Pin shapely to >=2.0 (`#2075 `__) `Valeriu Predoi `__ + +Preprocessor +~~~~~~~~~~~~ + +- Improve preprocessor output sorting code (`#2111 `__) `Bouwe Andela `__ +- Preprocess datasets in the same order as they are listed in the recipe (`#2103 `__) `Bouwe Andela `__ + +Automatic testing +~~~~~~~~~~~~~~~~~ + +- [Github Actions] Compress all bash shell setters into one default option per workflow (`#2126 `__) `Valeriu Predoi `__ +- [Github Actions] Fix Monitor Tests Github Action (`#2135 `__) `Valeriu Predoi `__ +- [condalock] update conda lock file (`#2141 `__) `Valeriu Predoi `__ +- [Condalock] make sure mamba/conda are at latest version by forcing a pinned mamba install (`#2136 `__) `Valeriu Predoi `__ +- Update code coverage orbs (`#2206 `__) `Bouwe Andela `__ +- Revisit the comment-triggered Github Actions test (`#2243 `__) `Valeriu Predoi `__ +- Remove workflow that runs Github Actions tests from PR comment (`#2244 `__) `Valeriu Predoi `__ + +Improvements +~~~~~~~~~~~~ + +- Merge v2.9.x into main (`#2128 `__) `Manuel Schlund `__ +- Fix typo in citation file (`#2182 `__) `Bouwe Andela `__ +- Cleaned and extended function that extracts datetimes from paths (`#2181 `__) `Manuel Schlund `__ +- Add file encoding (and some read modes) at open file step (`#2219 `__) `Valeriu Predoi `__ +- Check type of argument passed to :func:`~esmvalcore.cmor.table.read_cmor_tables` (`#2217 `__) `Valeriu Predoi `__ +- Dynamic HTML output for monitoring (`#2062 `__) `Brei Soliño `__ + .. _changelog-v2-9-0: 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`` ------------------