From 2be8a968d5e92902765279828358c159cb60793b Mon Sep 17 00:00:00 2001 From: TomNicholas Date: Wed, 17 Jan 2024 10:54:34 -0700 Subject: [PATCH 1/6] release summary --- doc/whats-new.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 80ea29746f8..01129c4d963 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -14,12 +14,13 @@ What's New np.random.seed(123456) +.. _whats-new.2024.01.0: +v2024.01.0 (17 Jan, 2024) +------------------------- -.. _whats-new.2023.12.1: - -v2023.12.1 (unreleased) ------------------------ +This release brings support for weights in correlation and covariance functions, improvements to `xr.map_blocks`, +an update to our minimum dependencies, and various bugfixes. New Features ~~~~~~~~~~~~ @@ -54,9 +55,9 @@ Breaking changes zarr 2.12 2.13 ===================== ========= ======== - Deprecations ~~~~~~~~~~~~ + - The `squeeze` kwarg to GroupBy is now deprecated. (:issue:`2157`, :pull:`8507`) By `Deepak Cherian `_. @@ -72,12 +73,9 @@ Bug fixes - Add tests and fixes for empty :py:class:`CFTimeIndex`, including broken html repr (:issue:`7298`, :pull:`8600`). By `Mathias Hauser `_. -Documentation -~~~~~~~~~~~~~ - - Internal Changes ~~~~~~~~~~~~~~~~ + - The implementation of :py:func:`map_blocks` has changed to minimize graph size and duplication of data. This should be a strict improvement even though the graphs are not always embarassingly parallel any more. Please open an issue if you spot a regression. (:pull:`8412`, :issue:`8409`). From c771e49dd51336ba8dabebb75a81c9eb994b1fa7 Mon Sep 17 00:00:00 2001 From: TomNicholas Date: Wed, 17 Jan 2024 10:58:41 -0700 Subject: [PATCH 2/6] move misplaced entries to be under new release --- doc/whats-new.rst | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 01129c4d963..fb36268e314 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -29,8 +29,18 @@ New Features By `Llorenç Lledó `_. - Accept the compression arguments new in netCDF 1.6.0 in the netCDF4 backend. See `netCDF4 documentation `_ for details. - By `Markel García-Díez `_. (:issue:`6929`, :pull:`7551`) Note that some - new compression filters needs plugins to be installed which may not be available in all netCDF distributions. + Note that some new compression filters needs plugins to be installed which may not be available in all netCDF distributions. + By `Markel García-Díez `_. (:issue:`6929`, :pull:`7551`) +- Add :py:meth:`DataArray.cumulative` & :py:meth:`Dataset.cumulative` to compute + cumulative aggregations, such as ``sum``, along a dimension — for example + ``da.cumulative('time').sum()``. This is similar to pandas' ``.expanding``, + and mostly equivalent to ``.cumsum`` methods, or to + :py:meth:`DataArray.rolling` with a window length equal to the dimension size. + By `Maximilian Roos `_. (:pull:`8512`) +- Decode/Encode netCDF4 enums and store the enum definition in dataarrays' dtype metadata. + If multiple variables share the same enum in netCDF4, each dataarray will have its own + enum definition in their respective dtype metadata. + By `Abel Aoun _`(:issue:`8144`, :pull:`8147`) Breaking changes ~~~~~~~~~~~~~~~~ @@ -82,6 +92,10 @@ Internal Changes By `Deepak Cherian `_. - Remove null values before plotting. (:pull:`8535`). By `Jimmy Westling `_. +- Redirect cumulative reduction functions internally through the :py:class:`ChunkManagerEntryPoint`, + potentially allowing :py:meth:`~xarray.DataArray.ffill` and :py:meth:`~xarray.DataArray.bfill` to + use non-dask chunked array types. + (:pull:`8019`) By `Tom Nicholas `_. .. _whats-new.2023.12.0: @@ -109,13 +123,6 @@ New Features example a 1D array — it's about the same speed as bottleneck, and 2-5x faster than pandas' default functions. (:pull:`8493`). numbagg is an optional dependency, so requires installing separately. -- Add :py:meth:`DataArray.cumulative` & :py:meth:`Dataset.cumulative` to compute - cumulative aggregations, such as ``sum``, along a dimension — for example - ``da.cumulative('time').sum()``. This is similar to pandas' ``.expanding``, - and mostly equivalent to ``.cumsum`` methods, or to - :py:meth:`DataArray.rolling` with a window length equal to the dimension size. - (:pull:`8512`). - By `Maximilian Roos `_. - Use a concise format when plotting datetime arrays. (:pull:`8449`). By `Jimmy Westling `_. - Avoid overwriting unchanged existing coordinate variables when appending with :py:meth:`Dataset.to_zarr` by setting ``mode='a-'``. @@ -222,10 +229,6 @@ New Features - Use `opt_einsum `_ for :py:func:`xarray.dot` by default if installed. By `Deepak Cherian `_. (:issue:`7764`, :pull:`8373`). -- Decode/Encode netCDF4 enums and store the enum definition in dataarrays' dtype metadata. - If multiple variables share the same enum in netCDF4, each dataarray will have its own - enum definition in their respective dtype metadata. - By `Abel Aoun _`(:issue:`8144`, :pull:`8147`) - Add ``DataArray.dt.total_seconds()`` method to match the Pandas API. (:pull:`8435`). By `Ben Mares `_. - Allow passing ``region="auto"`` in :py:meth:`Dataset.to_zarr` to automatically infer the @@ -626,10 +629,6 @@ Internal Changes - :py:func:`as_variable` now consistently includes the variable name in any exceptions raised. (:pull:`7995`). By `Peter Hill `_ -- Redirect cumulative reduction functions internally through the :py:class:`ChunkManagerEntryPoint`, - potentially allowing :py:meth:`~xarray.DataArray.ffill` and :py:meth:`~xarray.DataArray.bfill` to - use non-dask chunked array types. - (:pull:`8019`) By `Tom Nicholas `_. - :py:func:`encode_dataset_coordinates` now sorts coordinates automatically assigned to `coordinates` attributes during serialization (:issue:`8026`, :pull:`8034`). `By Ian Carroll `_. From c60f76881f668f1b11c87804d76ac5274ae0b33d Mon Sep 17 00:00:00 2001 From: TomNicholas Date: Wed, 17 Jan 2024 10:59:43 -0700 Subject: [PATCH 3/6] highlight new cumulative aggregation in release summary --- doc/whats-new.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index fb36268e314..2d5f0b702c4 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -19,7 +19,8 @@ What's New v2024.01.0 (17 Jan, 2024) ------------------------- -This release brings support for weights in correlation and covariance functions, improvements to `xr.map_blocks`, +This release brings support for weights in correlation and covariance functions, +a new `DataArray.cumulative` aggregation, improvements to `xr.map_blocks`, an update to our minimum dependencies, and various bugfixes. New Features From 8909ff92a7f8aaf11671372012c405a406cbb169 Mon Sep 17 00:00:00 2001 From: TomNicholas Date: Wed, 17 Jan 2024 11:01:10 -0700 Subject: [PATCH 4/6] thank contributors --- doc/whats-new.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 2d5f0b702c4..ba2859771c6 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -23,6 +23,12 @@ This release brings support for weights in correlation and covariance functions, a new `DataArray.cumulative` aggregation, improvements to `xr.map_blocks`, an update to our minimum dependencies, and various bugfixes. +Thanks to our 17 contributors to this release: + +Abel Aoun, Deepak Cherian, Illviljan, Johan Mathe, Justus Magin, Kai Mühlbauer, +Llorenç Lledó, Mark Harfouche, Markel, Mathias Hauser, Maximilian Roos, Michael Niklas, +Niclas Rieger, Sébastien Celles, Tom Nicholas, Trinh Quoc Anh, and crusaderky. + New Features ~~~~~~~~~~~~ From b9780a64a060dd463e8f39998b50b79d3f0537b4 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 17 Jan 2024 18:03:00 +0000 Subject: [PATCH 5/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- doc/whats-new.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index ba2859771c6..cba13c1a262 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -19,14 +19,14 @@ What's New v2024.01.0 (17 Jan, 2024) ------------------------- -This release brings support for weights in correlation and covariance functions, -a new `DataArray.cumulative` aggregation, improvements to `xr.map_blocks`, -an update to our minimum dependencies, and various bugfixes. +This release brings support for weights in correlation and covariance functions, +a new `DataArray.cumulative` aggregation, improvements to `xr.map_blocks`, +an update to our minimum dependencies, and various bugfixes. Thanks to our 17 contributors to this release: -Abel Aoun, Deepak Cherian, Illviljan, Johan Mathe, Justus Magin, Kai Mühlbauer, -Llorenç Lledó, Mark Harfouche, Markel, Mathias Hauser, Maximilian Roos, Michael Niklas, +Abel Aoun, Deepak Cherian, Illviljan, Johan Mathe, Justus Magin, Kai Mühlbauer, +Llorenç Lledó, Mark Harfouche, Markel, Mathias Hauser, Maximilian Roos, Michael Niklas, Niclas Rieger, Sébastien Celles, Tom Nicholas, Trinh Quoc Anh, and crusaderky. New Features From 8a6a52727fd31ef3dfa1712ac68894ac86a18c89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kai=20M=C3=BChlbauer?= Date: Wed, 17 Jan 2024 20:00:36 +0100 Subject: [PATCH 6/6] Update doc/whats-new.rst --- doc/whats-new.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index cba13c1a262..10dc4626536 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -47,7 +47,7 @@ New Features - Decode/Encode netCDF4 enums and store the enum definition in dataarrays' dtype metadata. If multiple variables share the same enum in netCDF4, each dataarray will have its own enum definition in their respective dtype metadata. - By `Abel Aoun _`(:issue:`8144`, :pull:`8147`) + By `Abel Aoun `_. (:issue:`8144`, :pull:`8147`) Breaking changes ~~~~~~~~~~~~~~~~