From 2a349a092f39b4115f04650b16b925f7da2d4317 Mon Sep 17 00:00:00 2001 From: dcherian Date: Thu, 21 Jul 2022 15:50:43 -0600 Subject: [PATCH 1/7] [skip-ci] Release notes for v2022.06.0 --- doc/api.rst | 16 ++++++++- doc/whats-new.rst | 84 +++++++++++++++++++++++++++++++---------------- 2 files changed, 71 insertions(+), 29 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index 840fa32bf43..893c9670e24 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -648,11 +648,23 @@ DataArray methods Coordinates objects =================== +Dataset +------- + .. autosummary:: :toctree: generated/ - core.coordinates.DataArrayCoordinates core.coordinates.DatasetCoordinates + core.coordinates.DatasetCoordinates.dtypes + +DataArray +------- + +.. autosummary:: + :toctree: generated/ + + core.coordinates.DataArrayCoordinates + core.coordinates.DataArrayCoordinates.dtypes Plotting ======== @@ -791,6 +803,7 @@ Dataset :toctree: generated/ DatasetRolling + DatasetRolling.__iter__ DatasetRolling.construct DatasetRolling.reduce DatasetRolling.argmax @@ -812,6 +825,7 @@ DataArray :toctree: generated/ DataArrayRolling + DataArrayRolling.__iter__ DataArrayRolling.construct DataArrayRolling.reduce DataArrayRolling.argmax diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 9e6a4a3ceac..53176cd1294 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -16,13 +16,50 @@ What's New .. _whats-new.2022.06.0: -v2022.06.0 (unreleased) ------------------------ +v2022.06.0 (July 21, 2022) +-------------------------- + +This release brings a number of bug fixes and improvements, most notably a major internal +refactor of the indexing functionality and the use of `flox`_ in ``groupby`` operations. +It also stops testing support for the abandoned PyNIO. + +Much effort has been made to preserve backwards compatibility as part of the indexing refactor. +However some regressions may have slipped through. Please open an issue if you run in to something. +We are aware of one `unfixed issue `_. + +Please also see the `whats-new.2022.06.0rc0`_ for a full list of changes. + +Mmany thanks to our 18 contributors: +Bane Sullivan, Deepak Cherian, Dimitri Papadopoulos Orfanos, Emma Marshall, Hauke Schulz, Illviljan, +Julia Signell, Justus Magin, Keewis, Mathias Hauser, Michael Delgado, Mick, Pierre Manchon, Ray Bell, +Spencer Clark, Stefaan Lippens, Tom White, Travis A. O'Brien, + +* @okhoma made their first contribution in https://github.com/pydata/xarray/pull/6368 +* @guelate made their first contribution in https://github.com/pydata/xarray/pull/6441 +* @tovogt made their first contribution in https://github.com/pydata/xarray/pull/6366 +* @axnsantana made their first contribution in https://github.com/pydata/xarray/pull/6451 +* @kmpaul made their first contribution in https://github.com/pydata/xarray/pull/6501 +* @headtr1ck made their first contribution in https://github.com/pydata/xarray/pull/6548 +* @phil-blain made their first contribution in https://github.com/pydata/xarray/pull/6583 +* @brynjarmorka made their first contribution in https://github.com/pydata/xarray/pull/6587 +* @mikefarmer01 made their first contribution in https://github.com/pydata/xarray/pull/6590 +* @cisaacstern made their first contribution in https://github.com/pydata/xarray/pull/6476 +* @gregbehm made their first contribution in https://github.com/pydata/xarray/pull/6558 +* @PLSeuJ made their first contribution in https://github.com/pydata/xarray/pull/6621 +* @ngam made their first contribution in https://github.com/pydata/xarray/pull/6653 +* @DoktorScience made their first contribution in https://github.com/pydata/xarray/pull/6639 +* @abelsiqueira made their first contribution in https://github.com/pydata/xarray/pull/6658 +* @e-marshall made their first contribution in https://github.com/pydata/xarray/pull/6663 +* @soxofaan made their first contribution in https://github.com/pydata/xarray/pull/6685 +* @taobrienlbl made their first contribution in https://github.com/pydata/xarray/pull/6686 +* @pierre-manchon made their first contribution in https://github.com/pydata/xarray/pull/6735 +* @banesullivan made their first contribution in https://github.com/pydata/xarray/pull/6745 +* @DimitriPapadopoulos made their first contribution in https://github.com/pydata/xarray/pull/6794 New Features ~~~~~~~~~~~~ -- Add :py:meth:`Dataset.dtypes`, :py:meth:`DatasetCoordinates.dtypes`, +- Add :py:property:`Dataset.dtypes`, :py:property:`DatasetCoordinates.dtypes`, :py:meth:`DataArrayCoordinates.dtypes` properties: Mapping from variable names to dtypes. (:pull:`6706`) By `Michael Niklas `_. @@ -30,19 +67,15 @@ New Features :py:meth:`coarsen`, :py:meth:`weighted`, :py:meth:`resample`, (:pull:`6702`) By `Michael Niklas `_. -- Experimental support for wrapping any array type that conforms to the python array api standard. - (:pull:`6804`) +- Experimental support for wrapping any array type that conforms to the python + `array api standard `_. (:pull:`6804`) By `Tom White `_. -Deprecations -~~~~~~~~~~~~ - - Bug fixes ~~~~~~~~~ -- :py:meth:`xarray.save_mfdataset` now passes ``**kwargs`` on to ``to_netcdf``, - allowing the ``encoding`` and ``unlimited_dims`` options with ``save_mfdataset``. +- :py:meth:`save_mfdataset` now passes ``**kwargs`` on to :py:meth:`Dataset.to_netcdf`, + allowing the ``encoding`` and ``unlimited_dims`` options with :py:meth:`save_mfdataset`. (:issue:`6684`) By `Travis A. O'Brien `_. - Fix backend support of pydap versions <3.3.0 (:issue:`6648`, :pull:`6656`). @@ -61,16 +94,12 @@ Bug fixes (:issue:`6739`, :pull:`6744`) By `Michael Niklas `_. -Documentation -~~~~~~~~~~~~~ - - Internal Changes ~~~~~~~~~~~~~~~~ -- :py:meth:`xarray.core.groupby`, :py:meth:`xarray.core.rolling`, - :py:meth:`xarray.core.rolling_exp`, :py:meth:`xarray.core.weighted` - and :py:meth:`xarray.core.resample` modules are no longer imported by default. +- ``xarray.core.groupby``, ``xarray.core.rolling``, + ``xarray.core.rolling_exp``, ``xarray.core.weighted`` + and ``xarray.core.resample`` modules are no longer imported by default. (:pull:`6702`) .. _whats-new.2022.06.0rc0: @@ -123,7 +152,7 @@ New Features elements which trigger summarization rather than full repr in (numpy) array detailed views of the html repr (:pull:`6400`). By `Benoît Bovy `_. -- Allow passing chunks in ``**kwargs`` form to :py:meth:`Dataset.chunk`, :py:meth:`DataArray.chunk`, and +- Allow passing chunks in ``````kwargs`` form to :py:meth:`Dataset.chunk`, :py:meth:`DataArray.chunk`, and :py:meth:`Variable.chunk`. (:pull:`6471`) By `Tom Nicholas `_. - Add :py:meth:`core.groupby.DatasetGroupBy.cumsum` and :py:meth:`core.groupby.DataArrayGroupBy.cumsum`. @@ -133,7 +162,7 @@ New Features - Expose the ``inline_array`` kwarg from :py:func:`dask.array.from_array` in :py:func:`open_dataset`, :py:meth:`Dataset.chunk`, :py:meth:`DataArray.chunk`, and :py:meth:`Variable.chunk`. (:pull:`6471`) By `Tom Nicholas `_. -- :py:meth:`xr.polyval` now supports :py:class:`Dataset` and :py:class:`DataArray` args of any shape, +- :py:func:`polyval` now supports :py:class:`Dataset` and :py:class:`DataArray` args of any shape, is faster and requires less memory. (:pull:`6548`) By `Michael Niklas `_. - Improved overall typing. @@ -166,7 +195,7 @@ Breaking changes zarr 2.5 2.8 =============== ===== ==== -- The Dataset and DataArray ``rename*`` methods do not implicitly add or drop +- The Dataset and DataArray ``rename```` methods do not implicitly add or drop indexes. (:pull:`5692`). By `Benoît Bovy `_. - Many arguments like ``keep_attrs``, ``axis``, and ``skipna`` are now keyword @@ -211,8 +240,8 @@ Bug fixes By `Stan West `_. - Fix bug in :py:func:`where` when passing non-xarray objects with ``keep_attrs=True``. (:issue:`6444`, :pull:`6461`) By `Sam Levang `_. -- Allow passing both ``other`` and ``drop=True`` arguments to ``xr.DataArray.where`` - and ``xr.Dataset.where`` (:pull:`6466`, :pull:`6467`). +- Allow passing both ``other`` and ``drop=True`` arguments to :py:meth:`DataArray.where` + and :py:meth:`Dataset.where` (:pull:`6466`, :pull:`6467`). By `Michael Delgado `_. - Ensure dtype encoding attributes are not added or modified on variables that contain datetime-like values prior to being passed to :py:func:`xarray.conventions.decode_cf_variable` (:issue:`6453`, @@ -220,7 +249,7 @@ Bug fixes By `Spencer Clark `_. - Dark themes are now properly detected in Furo-themed Sphinx documents (:issue:`6500`, :pull:`6501`). By `Kevin Paul `_. -- :py:meth:`isel` with `drop=True` works as intended with scalar :py:class:`DataArray` indexers. +- :py:meth:`Dataset.isel`, :py:meth:`DataArray.isel` with `drop=True` works as intended with scalar :py:class:`DataArray` indexers. (:issue:`6554`, :pull:`6579`) By `Michael Niklas `_. - Fixed silent overflow issue when decoding times encoded with 32-bit and below @@ -236,10 +265,9 @@ Documentation sizes. In particular, correct the syntax and replace lists with tuples in the examples. (:issue:`6333`, :pull:`6334`) By `Stan West `_. -- Mention that ``xr.DataArray.rename`` can rename coordinates. +- Mention that :py:meth:`DataArray.rename` can rename coordinates. (:issue:`5458`, :pull:`6665`) By `Michael Niklas `_. - - Added examples to :py:meth:`Dataset.thin` and :py:meth:`DataArray.thin` By `Emma Marshall `_. @@ -247,7 +275,7 @@ Performance ~~~~~~~~~~~ - GroupBy binary operations are now vectorized. - Previously this involved looping over all groups. (:issue:`5804`,:pull:`6160`) + Previously this involved looping over all groups. (:issue:`5804`, :pull:`6160`) By `Deepak Cherian `_. - Substantially improved GroupBy operations using `flox `_. This is auto-enabled when ``flox`` is installed. Use ``xr.set_options(use_flox=False)`` to use @@ -506,7 +534,7 @@ New Features By `Tomas Chor `_. - Add an option (``"use_bottleneck"``) to disable the use of ``bottleneck`` using :py:func:`set_options` (:pull:`5560`) By `Justus Magin `_. -- Added ``**kwargs`` argument to :py:meth:`open_rasterio` to access overviews (:issue:`3269`). +- Added ``````kwargs`` argument to :py:meth:`open_rasterio` to access overviews (:issue:`3269`). By `Pushkar Kopparla `_. - Added ``storage_options`` argument to :py:meth:`to_zarr` (:issue:`5601`, :pull:`5615`). By `Ray Bell `_, `Zachary Blackwood `_ and From 6f331a6e2143fa07b69ebe2eccd39b9713e326cf Mon Sep 17 00:00:00 2001 From: dcherian Date: Thu, 21 Jul 2022 16:07:19 -0600 Subject: [PATCH 2/7] Small fixes --- doc/api.rst | 1 - doc/whats-new.rst | 32 +++----------------------------- 2 files changed, 3 insertions(+), 30 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index 893c9670e24..d49607e3881 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -803,7 +803,6 @@ Dataset :toctree: generated/ DatasetRolling - DatasetRolling.__iter__ DatasetRolling.construct DatasetRolling.reduce DatasetRolling.argmax diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 53176cd1294..25501bf2455 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -20,7 +20,8 @@ v2022.06.0 (July 21, 2022) -------------------------- This release brings a number of bug fixes and improvements, most notably a major internal -refactor of the indexing functionality and the use of `flox`_ in ``groupby`` operations. +refactor of the indexing functionality, the use of `flox`_ in ``groupby`` operations, +and experimental support for the new Python `Array API standard `_. It also stops testing support for the abandoned PyNIO. Much effort has been made to preserve backwards compatibility as part of the indexing refactor. @@ -34,28 +35,6 @@ Bane Sullivan, Deepak Cherian, Dimitri Papadopoulos Orfanos, Emma Marshall, Hauk Julia Signell, Justus Magin, Keewis, Mathias Hauser, Michael Delgado, Mick, Pierre Manchon, Ray Bell, Spencer Clark, Stefaan Lippens, Tom White, Travis A. O'Brien, -* @okhoma made their first contribution in https://github.com/pydata/xarray/pull/6368 -* @guelate made their first contribution in https://github.com/pydata/xarray/pull/6441 -* @tovogt made their first contribution in https://github.com/pydata/xarray/pull/6366 -* @axnsantana made their first contribution in https://github.com/pydata/xarray/pull/6451 -* @kmpaul made their first contribution in https://github.com/pydata/xarray/pull/6501 -* @headtr1ck made their first contribution in https://github.com/pydata/xarray/pull/6548 -* @phil-blain made their first contribution in https://github.com/pydata/xarray/pull/6583 -* @brynjarmorka made their first contribution in https://github.com/pydata/xarray/pull/6587 -* @mikefarmer01 made their first contribution in https://github.com/pydata/xarray/pull/6590 -* @cisaacstern made their first contribution in https://github.com/pydata/xarray/pull/6476 -* @gregbehm made their first contribution in https://github.com/pydata/xarray/pull/6558 -* @PLSeuJ made their first contribution in https://github.com/pydata/xarray/pull/6621 -* @ngam made their first contribution in https://github.com/pydata/xarray/pull/6653 -* @DoktorScience made their first contribution in https://github.com/pydata/xarray/pull/6639 -* @abelsiqueira made their first contribution in https://github.com/pydata/xarray/pull/6658 -* @e-marshall made their first contribution in https://github.com/pydata/xarray/pull/6663 -* @soxofaan made their first contribution in https://github.com/pydata/xarray/pull/6685 -* @taobrienlbl made their first contribution in https://github.com/pydata/xarray/pull/6686 -* @pierre-manchon made their first contribution in https://github.com/pydata/xarray/pull/6735 -* @banesullivan made their first contribution in https://github.com/pydata/xarray/pull/6745 -* @DimitriPapadopoulos made their first contribution in https://github.com/pydata/xarray/pull/6794 - New Features ~~~~~~~~~~~~ @@ -152,7 +131,7 @@ New Features elements which trigger summarization rather than full repr in (numpy) array detailed views of the html repr (:pull:`6400`). By `Benoît Bovy `_. -- Allow passing chunks in ``````kwargs`` form to :py:meth:`Dataset.chunk`, :py:meth:`DataArray.chunk`, and +- Allow passing chunks in ``kwargs`` form to :py:meth:`Dataset.chunk`, :py:meth:`DataArray.chunk`, and :py:meth:`Variable.chunk`. (:pull:`6471`) By `Tom Nicholas `_. - Add :py:meth:`core.groupby.DatasetGroupBy.cumsum` and :py:meth:`core.groupby.DataArrayGroupBy.cumsum`. @@ -208,11 +187,6 @@ Breaking changes (:pull:`6548`) By `Michael Niklas `_. - -Deprecations -~~~~~~~~~~~~ - - Bug fixes ~~~~~~~~~ From cdad7d5955225cf703c7090fb5731f16b1999c9f Mon Sep 17 00:00:00 2001 From: dcherian Date: Thu, 21 Jul 2022 16:08:46 -0600 Subject: [PATCH 3/7] [skip-ci] From d9bd9b9b2542ce274b332a2ec3f5cd13879e8607 Mon Sep 17 00:00:00 2001 From: dcherian Date: Thu, 21 Jul 2022 16:09:45 -0600 Subject: [PATCH 4/7] [skip-ci] small fix --- doc/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api.rst b/doc/api.rst index d49607e3881..f9770090e5e 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -658,7 +658,7 @@ Dataset core.coordinates.DatasetCoordinates.dtypes DataArray -------- +--------- .. autosummary:: :toctree: generated/ From 2804654db944ce894390468402cc09d59bde2843 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Thu, 21 Jul 2022 16:11:18 -0600 Subject: [PATCH 5/7] [skip-ci] 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 25501bf2455..8cd6f2477b7 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -508,7 +508,7 @@ New Features By `Tomas Chor `_. - Add an option (``"use_bottleneck"``) to disable the use of ``bottleneck`` using :py:func:`set_options` (:pull:`5560`) By `Justus Magin `_. -- Added ``````kwargs`` argument to :py:meth:`open_rasterio` to access overviews (:issue:`3269`). +- Added ``**kwargs`` argument to :py:meth:`open_rasterio` to access overviews (:issue:`3269`). By `Pushkar Kopparla `_. - Added ``storage_options`` argument to :py:meth:`to_zarr` (:issue:`5601`, :pull:`5615`). By `Ray Bell `_, `Zachary Blackwood `_ and From d6832498e8d94be78413697f289cbec4ea986c45 Mon Sep 17 00:00:00 2001 From: dcherian Date: Thu, 21 Jul 2022 16:18:37 -0600 Subject: [PATCH 6/7] [skip-ci] fix --- doc/whats-new.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 8cd6f2477b7..dc45e176ddc 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -38,8 +38,8 @@ Spencer Clark, Stefaan Lippens, Tom White, Travis A. O'Brien, New Features ~~~~~~~~~~~~ -- Add :py:property:`Dataset.dtypes`, :py:property:`DatasetCoordinates.dtypes`, - :py:meth:`DataArrayCoordinates.dtypes` properties: Mapping from variable names to dtypes. +- Add :py:attr:`Dataset.dtypes`, :py:attr:`core.coordinates.DatasetCoordinates.dtypes`, + :py:attr:`core.coordinates.DataArrayCoordinates.dtypes` properties: Mapping from variable names to dtypes. (:pull:`6706`) By `Michael Niklas `_. - Initial typing support for :py:meth:`groupby`, :py:meth:`rolling`, :py:meth:`rolling_exp`, From 2a276f69eec87cd87c66d4b52cdf452fead3e084 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Thu, 21 Jul 2022 20:05:07 -0600 Subject: [PATCH 7/7] Apply suggestions from code review --- doc/whats-new.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index dc45e176ddc..c7a2a50a73f 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -25,12 +25,11 @@ and experimental support for the new Python `Array API standard `_. Please also see the `whats-new.2022.06.0rc0`_ for a full list of changes. -Mmany thanks to our 18 contributors: +Many thanks to our 18 contributors: Bane Sullivan, Deepak Cherian, Dimitri Papadopoulos Orfanos, Emma Marshall, Hauke Schulz, Illviljan, Julia Signell, Justus Magin, Keewis, Mathias Hauser, Michael Delgado, Mick, Pierre Manchon, Ray Bell, Spencer Clark, Stefaan Lippens, Tom White, Travis A. O'Brien,