From acab6472a76c806726701692a16c7760e10d0888 Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Tue, 30 Jul 2024 10:26:03 +0200 Subject: [PATCH] release notes for 2024.07.0 (#9287) * release number * add a shortcut for discussions * formatting * use the discussion shortcut * more formatting * release summary * Update whats-new.rst * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * contributors * release date * reword the release summary --------- Co-authored-by: Deepak Cherian Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- doc/conf.py | 1 + doc/whats-new.rst | 51 ++++++++++++++++++++++++++--------------------- 2 files changed, 29 insertions(+), 23 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 7bf8f4ceb87..4f1fc6751d2 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -94,6 +94,7 @@ extlinks = { "issue": ("https://github.com/pydata/xarray/issues/%s", "GH%s"), "pull": ("https://github.com/pydata/xarray/pull/%s", "PR%s"), + "discussion": ("https://github.com/pydata/xarray/discussions/%s", "D%s"), } # sphinx-copybutton configurations diff --git a/doc/whats-new.rst b/doc/whats-new.rst index bb27df7f4f7..714a657d343 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -15,19 +15,24 @@ What's New np.random.seed(123456) -.. _whats-new.2024.06.1: +.. _whats-new.2024.07.0: -v2024.06.1 (unreleased) ------------------------ +v2024.07.0 (Jul 30, 2024) +------------------------- +This release extends the API for groupby operations with various `grouper objects `, and includes improvements to the documentation and numerous bugfixes. + +Thanks to the 22 contributors to this release: +Alfonso Ladino, ChrisCleaner, David Hoese, Deepak Cherian, Dieter Werthmüller, Illviljan, Jessica Scheick, Joel Jaeschke, Justus Magin, K. Arthur Endsley, Kai Mühlbauer, Mark Harfouche, Martin Raspaud, Mathijs Verhaegh, Maximilian Roos, Michael Niklas, Michał Górny, Moritz Schreiber, Pontus Lurcock, Spencer Clark, Stephan Hoyer and Tom Nicholas New Features ~~~~~~~~~~~~ - Use fastpath when grouping both montonically increasing and decreasing variable - in :py:class:`GroupBy` (:issue:`6220`, :pull:`7427`). By `Joel Jaeschke `_. + in :py:class:`GroupBy` (:issue:`6220`, :pull:`7427`). + By `Joel Jaeschke `_. - Introduce new :py:class:`groupers.UniqueGrouper`, :py:class:`groupers.BinGrouper`, and :py:class:`groupers.TimeResampler` objects as a step towards supporting grouping by - multiple variables. See the `docs ` and the - `grouper design doc `_ for more. + multiple variables. See the `docs ` and the `grouper design doc + `_ for more. (:issue:`6610`, :pull:`8840`). By `Deepak Cherian `_. - Allow rechunking to a frequency using ``Dataset.chunk(time=TimeResampler("YE"))`` syntax. (:issue:`7559`, :pull:`9109`) @@ -47,15 +52,17 @@ New Features Breaking changes ~~~~~~~~~~~~~~~~ -- The ``base`` and ``loffset`` parameters to :py:meth:`Dataset.resample` and :py:meth:`DataArray.resample` - is now removed. These parameters has been deprecated since v2023.03.0. Using the - ``origin`` or ``offset`` parameters is recommended as a replacement for using - the ``base`` parameter and using time offset arithmetic is recommended as a - replacement for using the ``loffset`` parameter. -- The ``squeeze`` kwarg to ``groupby`` is completely deprecated. This has been the source of some quite confusing - behaviour and has been deprecated since v2024.01.0. `groupby`` behavior is now always consistent - with the existing ``.groupby(..., squeeze=False)`` behavior. - By `Deepak Cherian `_. (:pull:`9280`) +- The ``base`` and ``loffset`` parameters to :py:meth:`Dataset.resample` and + :py:meth:`DataArray.resample` are now removed. These parameters have been deprecated since + v2023.03.0. Using the ``origin`` or ``offset`` parameters is recommended as a replacement for + using the ``base`` parameter and using time offset arithmetic is recommended as a replacement for + using the ``loffset`` parameter. (:pull:`9233`) + By `Deepak Cherian `_. +- The ``squeeze`` kwarg to ``groupby`` is now ignored. This has been the source of some + quite confusing behaviour and has been deprecated since v2024.01.0. `groupby`` behavior is now + always consistent with the existing ``.groupby(..., squeeze=False)`` behavior. No errors will + be raised if `squeeze=False`. (:pull:`9280`) + By `Deepak Cherian `_. Bug fixes @@ -74,24 +81,22 @@ Bug fixes By `Justus Magin `_. - Address regression introduced in :pull:`9002` that prevented objects returned by py:meth:`DataArray.convert_calendar` to be indexed by a time index in - certain circumstances (:issue:`9138`, :pull:`9192`). By `Mark Harfouche - `_ and `Spencer Clark - `. - -- Fiy static typing of tolerance arguments by allowing `str` type (:issue:`8892`, :pull:`9194`). + certain circumstances (:issue:`9138`, :pull:`9192`). + By `Mark Harfouche `_ and `Spencer Clark `_. +- Fix static typing of tolerance arguments by allowing `str` type (:issue:`8892`, :pull:`9194`). By `Michael Niklas `_. - Dark themes are now properly detected for ``html[data-theme=dark]``-tags (:pull:`9200`). By `Dieter Werthmüller `_. - Reductions no longer fail for ``np.complex_`` dtype arrays when numbagg is - installed. - By `Maximilian Roos `_ + installed. (:pull:`9210`) + By `Maximilian Roos `_. Documentation ~~~~~~~~~~~~~ - Adds intro to backend section of docs, including a flow-chart to navigate types of backends (:pull:`9175`). By `Jessica Scheick `_. -- Adds a flow-chart diagram to help users navigate help resources (`Discussion #8990 `_, :pull:`9147`). +- Adds a flow-chart diagram to help users navigate help resources (:discussion:`8990`, :pull:`9147`). By `Jessica Scheick `_. - Improvements to Zarr & chunking docs (:pull:`9139`, :pull:`9140`, :pull:`9132`) By `Maximilian Roos `_.