Skip to content

Commit 072f44c

Browse files
TomNicholaspre-commit-ci[bot]kmuehlbauer
authored
Release summary for release v2024.01.0 (#8617)
* release summary * move misplaced entries to be under new release * highlight new cumulative aggregation in release summary * thank contributors * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update doc/whats-new.rst --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Kai Mühlbauer <kmuehlbauer@wradlib.org>
1 parent d20ba0d commit 072f44c

File tree

1 file changed

+29
-25
lines changed

1 file changed

+29
-25
lines changed

doc/whats-new.rst

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,20 @@ What's New
1414
1515
np.random.seed(123456)
1616
17+
.. _whats-new.2024.01.0:
1718

19+
v2024.01.0 (17 Jan, 2024)
20+
-------------------------
1821

19-
.. _whats-new.2023.12.1:
22+
This release brings support for weights in correlation and covariance functions,
23+
a new `DataArray.cumulative` aggregation, improvements to `xr.map_blocks`,
24+
an update to our minimum dependencies, and various bugfixes.
2025

21-
v2023.12.1 (unreleased)
22-
-----------------------
26+
Thanks to our 17 contributors to this release:
27+
28+
Abel Aoun, Deepak Cherian, Illviljan, Johan Mathe, Justus Magin, Kai Mühlbauer,
29+
Llorenç Lledó, Mark Harfouche, Markel, Mathias Hauser, Maximilian Roos, Michael Niklas,
30+
Niclas Rieger, Sébastien Celles, Tom Nicholas, Trinh Quoc Anh, and crusaderky.
2331

2432
New Features
2533
~~~~~~~~~~~~
@@ -28,8 +36,18 @@ New Features
2836
By `Llorenç Lledó <https://github.com/lluritu>`_.
2937
- Accept the compression arguments new in netCDF 1.6.0 in the netCDF4 backend.
3038
See `netCDF4 documentation <https://unidata.github.io/netcdf4-python/#efficient-compression-of-netcdf-variables>`_ for details.
31-
By `Markel García-Díez <https://github.com/markelg>`_. (:issue:`6929`, :pull:`7551`) Note that some
32-
new compression filters needs plugins to be installed which may not be available in all netCDF distributions.
39+
Note that some new compression filters needs plugins to be installed which may not be available in all netCDF distributions.
40+
By `Markel García-Díez <https://github.com/markelg>`_. (:issue:`6929`, :pull:`7551`)
41+
- Add :py:meth:`DataArray.cumulative` & :py:meth:`Dataset.cumulative` to compute
42+
cumulative aggregations, such as ``sum``, along a dimension — for example
43+
``da.cumulative('time').sum()``. This is similar to pandas' ``.expanding``,
44+
and mostly equivalent to ``.cumsum`` methods, or to
45+
:py:meth:`DataArray.rolling` with a window length equal to the dimension size.
46+
By `Maximilian Roos <https://github.com/max-sixty>`_. (:pull:`8512`)
47+
- Decode/Encode netCDF4 enums and store the enum definition in dataarrays' dtype metadata.
48+
If multiple variables share the same enum in netCDF4, each dataarray will have its own
49+
enum definition in their respective dtype metadata.
50+
By `Abel Aoun <https://github.com/bzah>`_. (:issue:`8144`, :pull:`8147`)
3351

3452
Breaking changes
3553
~~~~~~~~~~~~~~~~
@@ -54,9 +72,9 @@ Breaking changes
5472
zarr 2.12 2.13
5573
===================== ========= ========
5674

57-
5875
Deprecations
5976
~~~~~~~~~~~~
77+
6078
- The `squeeze` kwarg to GroupBy is now deprecated. (:issue:`2157`, :pull:`8507`)
6179
By `Deepak Cherian <https://github.com/dcherian>`_.
6280

@@ -72,18 +90,19 @@ Bug fixes
7290
- Add tests and fixes for empty :py:class:`CFTimeIndex`, including broken html repr (:issue:`7298`, :pull:`8600`).
7391
By `Mathias Hauser <https://github.com/mathause>`_.
7492

75-
Documentation
76-
~~~~~~~~~~~~~
77-
78-
7993
Internal Changes
8094
~~~~~~~~~~~~~~~~
95+
8196
- The implementation of :py:func:`map_blocks` has changed to minimize graph size and duplication of data.
8297
This should be a strict improvement even though the graphs are not always embarassingly parallel any more.
8398
Please open an issue if you spot a regression. (:pull:`8412`, :issue:`8409`).
8499
By `Deepak Cherian <https://github.com/dcherian>`_.
85100
- Remove null values before plotting. (:pull:`8535`).
86101
By `Jimmy Westling <https://github.com/illviljan>`_.
102+
- Redirect cumulative reduction functions internally through the :py:class:`ChunkManagerEntryPoint`,
103+
potentially allowing :py:meth:`~xarray.DataArray.ffill` and :py:meth:`~xarray.DataArray.bfill` to
104+
use non-dask chunked array types.
105+
(:pull:`8019`) By `Tom Nicholas <https://github.com/TomNicholas>`_.
87106

88107
.. _whats-new.2023.12.0:
89108

@@ -111,13 +130,6 @@ New Features
111130
example a 1D array — it's about the same speed as bottleneck, and 2-5x faster
112131
than pandas' default functions. (:pull:`8493`). numbagg is an optional
113132
dependency, so requires installing separately.
114-
- Add :py:meth:`DataArray.cumulative` & :py:meth:`Dataset.cumulative` to compute
115-
cumulative aggregations, such as ``sum``, along a dimension — for example
116-
``da.cumulative('time').sum()``. This is similar to pandas' ``.expanding``,
117-
and mostly equivalent to ``.cumsum`` methods, or to
118-
:py:meth:`DataArray.rolling` with a window length equal to the dimension size.
119-
(:pull:`8512`).
120-
By `Maximilian Roos <https://github.com/max-sixty>`_.
121133
- Use a concise format when plotting datetime arrays. (:pull:`8449`).
122134
By `Jimmy Westling <https://github.com/illviljan>`_.
123135
- Avoid overwriting unchanged existing coordinate variables when appending with :py:meth:`Dataset.to_zarr` by setting ``mode='a-'``.
@@ -224,10 +236,6 @@ New Features
224236

225237
- Use `opt_einsum <https://optimized-einsum.readthedocs.io/en/stable/>`_ for :py:func:`xarray.dot` by default if installed.
226238
By `Deepak Cherian <https://github.com/dcherian>`_. (:issue:`7764`, :pull:`8373`).
227-
- Decode/Encode netCDF4 enums and store the enum definition in dataarrays' dtype metadata.
228-
If multiple variables share the same enum in netCDF4, each dataarray will have its own
229-
enum definition in their respective dtype metadata.
230-
By `Abel Aoun <https://github.com/bzah>_`(:issue:`8144`, :pull:`8147`)
231239
- Add ``DataArray.dt.total_seconds()`` method to match the Pandas API. (:pull:`8435`).
232240
By `Ben Mares <https://github.com/maresb>`_.
233241
- Allow passing ``region="auto"`` in :py:meth:`Dataset.to_zarr` to automatically infer the
@@ -628,10 +636,6 @@ Internal Changes
628636

629637
- :py:func:`as_variable` now consistently includes the variable name in any exceptions
630638
raised. (:pull:`7995`). By `Peter Hill <https://github.com/ZedThree>`_
631-
- Redirect cumulative reduction functions internally through the :py:class:`ChunkManagerEntryPoint`,
632-
potentially allowing :py:meth:`~xarray.DataArray.ffill` and :py:meth:`~xarray.DataArray.bfill` to
633-
use non-dask chunked array types.
634-
(:pull:`8019`) By `Tom Nicholas <https://github.com/TomNicholas>`_.
635639
- :py:func:`encode_dataset_coordinates` now sorts coordinates automatically assigned to
636640
`coordinates` attributes during serialization (:issue:`8026`, :pull:`8034`).
637641
`By Ian Carroll <https://github.com/itcarroll>`_.

0 commit comments

Comments
 (0)