Add highlights to the v2.10 changelog (#2282)

Co-authored-by: Manuel Schlund <[email protected]>

CITATION.cff

@@ -201,11 +201,11 @@ authors:
     given-names: Joerg
 
 cff-version: 1.2.0
-date-released: 2023-11-01
+date-released: 2023-12-19
 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.10.0rc1"
+version: "v2.10.0"
 ...

doc/changelog.rst

@@ -9,7 +9,24 @@ v2.10.0
 -------
 Highlights
 
-TODO: add highlights
+-  All statistics preprocessors support the same operators and have a common
+   :ref:`documentation <stat_preprocs>`. In addition, arbitrary keyword arguments
+   for the statistical operation can be directly given to the preprocessor.
+
+-  The output webpage generated by the tool now looks better and provides
+   methods to select and filter the output.
+
+-  Improved computational efficiency:
+
+   -  Automatic rechunking between preprocessor steps to keep the
+      `graph size smaller <https://docs.dask.org/en/latest/best-practices.html#avoid-very-large-graphs>`_
+      and the `chunk size optimal <https://blog.dask.org/2021/11/02/choosing-dask-chunk-sizes>`__.
+   -  Reduce the size of the dask graph created by :func:`esmvalcore.preprocessor.anomalies`.
+   -  Preprocessors :func:`esmvalcore.preprocessor.mask_above_threshold`,
+      :func:`esmvalcore.preprocessor.mask_below_threshold`,
+      :func:`esmvalcore.preprocessor.mask_inside_range`,
+      :func:`esmvalcore.preprocessor.mask_outside_range` are now lazy.
+   -  Lazy coordinates bounds are no longer loaded into memory by the CMOR checks and fixes.
 
 This release includes
 
@@ -24,7 +41,7 @@ Backwards incompatible changes
      (``additional_``) ``datasets`` section as described in :ref:`supplementary_variables`.
 
 -  Use smarter (units-aware) weights (`#2139 <https://github.com/ESMValGroup/ESMValCore/pull/2139>`__) `Manuel Schlund <https://github.com/schlunma>`__
-   
+
    - Some preprocessors handle units better. For details, see the pull request.
 
 -  Removed deprecated configuration option ``offline`` (`#2213 <https://github.com/ESMValGroup/ESMValCore/pull/2213>`__) `Manuel Schlund <https://github.com/schlunma>`__
@@ -33,28 +50,26 @@ Backwards incompatible changes
      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 <https://github.com/ESMValGroup/ESMValCore/pull/2066>`__) `Joakim Löw <https://github.com/ljoakim>`__
-   
+
    - 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 <https://github.com/ESMValGroup/ESMValCore/pull/2191>`__) `Manuel Schlund <https://github.com/schlunma>`__
-
-   - 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 <https://github.com/ESMValGroup/ESMValCore/pull/2201>`__) `Bouwe Andela <https://github.com/bouweandela>`__
 
    -  Remove deprecated callback argument from preprocessor ``load`` function (`#2207 <https://github.com/ESMValGroup/ESMValCore/pull/2207>`__) `Bouwe Andela <https://github.com/bouweandela>`__
 
    -  Remove deprecated preprocessor function `cleanup` (`#2215 <https://github.com/ESMValGroup/ESMValCore/pull/2215>`__) `Bouwe Andela <https://github.com/bouweandela>`__
 
-
 Deprecations
 ~~~~~~~~~~~~
 
 -  Clearly separate fixes and CMOR checks (`#2157 <https://github.com/ESMValGroup/ESMValCore/pull/2157>`__) `Manuel Schlund <https://github.com/schlunma>`__
+-  Added new operators for statistics preprocessor (e.g., ``'percentile'``) and allowed passing additional arguments (`#2191 <https://github.com/ESMValGroup/ESMValCore/pull/2191>`__) `Manuel Schlund <https://github.com/schlunma>`__
+
+   - 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.
 
 Bug fixes
 ~~~~~~~~~
@@ -85,7 +100,7 @@ Computational performance improvements
 -  Make :ref:`threshold_masking` preprocessors lazy  (`#2169 <https://github.com/ESMValGroup/ESMValCore/pull/2169>`__) `Jörg Benke <https://github.com/joergbenke>`__
 
    -  Restored usage of numpy in `_mask_with_shp` (`#2209 <https://github.com/ESMValGroup/ESMValCore/pull/2209>`__) `Jörg Benke <https://github.com/joergbenke>`__
--  Call coord.core_bounds() instead of coord.bounds in ``check.py`` (`#2146 <https://github.com/ESMValGroup/ESMValCore/pull/2146>`__) `sloosvel <https://github.com/sloosvel>`__
+-  Do not realize lazy coordinate bounds in CMOR check (`#2146 <https://github.com/ESMValGroup/ESMValCore/pull/2146>`__) `sloosvel <https://github.com/sloosvel>`__
 -  Rechunk between preprocessor steps (`#2205 <https://github.com/ESMValGroup/ESMValCore/pull/2205>`__) `Bouwe Andela <https://github.com/bouweandela>`__
 -  Reduce the size of the dask graph created by the ``anomalies`` preprocessor function (`#2200 <https://github.com/ESMValGroup/ESMValCore/pull/2200>`__) `Bouwe Andela <https://github.com/bouweandela>`__
 
@@ -100,7 +115,7 @@ Documentation
 -  Remove meercode badge from README because their API is broken (`#2224 <https://github.com/ESMValGroup/ESMValCore/pull/2224>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
 -  Correct usage help text of version command (`#2232 <https://github.com/ESMValGroup/ESMValCore/pull/2232>`__) `James Frost <https://github.com/jfrost-mo>`__
 -  Add ``navigation_with_keys: False`` to ``html_theme_options`` in Readthedocs ``conf.py`` (`#2245 <https://github.com/ESMValGroup/ESMValCore/pull/2245>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
--  Replace squarey badge with roundy shield for Anaconda sticker in README (`#2233 <https://github.com/ESMValGroup/ESMValCore/pull/2233>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
+-  Replace squarey badge with roundy shield for Anaconda sticker in README (`#2233 <https://github.com/ESMValGroup/ESMValCore/pull/2233>`__, `#2260 <https://github.com/ESMValGroup/ESMValCore/pull/2260>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
 
 Fixes for datasets
 ~~~~~~~~~~~~~~~~~~
@@ -113,6 +128,7 @@ Installation
 -  Clean-up how pins are written in conda environment file (`#2125 <https://github.com/ESMValGroup/ESMValCore/pull/2125>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
 -  Use importlib.metadata instead of deprecated pkg_resources (`#2096 <https://github.com/ESMValGroup/ESMValCore/pull/2096>`__) `Bouwe Andela <https://github.com/bouweandela>`__
 -  Pin shapely to >=2.0 (`#2075 <https://github.com/ESMValGroup/ESMValCore/pull/2075>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
+-  Pin Python to <3.12 in conda environment (`#2272 <https://github.com/ESMValGroup/ESMValCore/pull/2272>`__) `Bouwe Andela <https://github.com/bouweandela>`__
 
 Preprocessor
 ~~~~~~~~~~~~
@@ -140,7 +156,7 @@ Improvements
 -  Add file encoding (and some read modes) at open file step (`#2219 <https://github.com/ESMValGroup/ESMValCore/pull/2219>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
 -  Check type of argument passed to :func:`~esmvalcore.cmor.table.read_cmor_tables` (`#2217 <https://github.com/ESMValGroup/ESMValCore/pull/2217>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
 -  Dynamic HTML output for monitoring (`#2062 <https://github.com/ESMValGroup/ESMValCore/pull/2062>`__) `Brei Soliño <https://github.com/bsolino>`__
-
+-  Use PyPI's trusted publishers authentication (`#2269 <https://github.com/ESMValGroup/ESMValCore/pull/2269>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
 
 .. _changelog-v2-9-0: