Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Release notes for v2022.06.0 #6815

Merged
merged 7 commits into from
Jul 22, 2022
Merged

Release notes for v2022.06.0 #6815

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2a349a0
[skip-ci] Release notes for v2022.06.0
dcherian Jul 21, 2022
6f331a6
Small fixes
dcherian Jul 21, 2022
cdad7d5
[skip-ci]
dcherian Jul 21, 2022
d9bd9b9
[skip-ci] small fix
dcherian Jul 21, 2022
2804654
[skip-ci] Update doc/whats-new.rst
dcherian Jul 21, 2022
d683249
[skip-ci] fix
dcherian Jul 21, 2022
2a276f6
Apply suggestions from code review
dcherian Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
========
Expand Down Expand Up @@ -812,6 +824,7 @@ DataArray
:toctree: generated/

DataArrayRolling
DataArrayRolling.__iter__
DataArrayRolling.construct
DataArrayRolling.reduce
DataArrayRolling.argmax
Expand Down
68 changes: 35 additions & 33 deletions doc/whats-new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,45 @@ 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, the use of `flox`_ in ``groupby`` operations,
and experimental support for the new Python `Array API standard <https://data-apis.org/array-api/latest/>`_.
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.
dcherian marked this conversation as resolved.
Show resolved Hide resolved
We are aware of one `unfixed issue <https://github.com/pydata/xarray/issues/6607>`_.

Please also see the `whats-new.2022.06.0rc0`_ for a full list of changes.

Mmany thanks to our 18 contributors:
dcherian marked this conversation as resolved.
Show resolved Hide resolved
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,

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 <https://github.com/headtr1ck>`_.
- Initial typing support for :py:meth:`groupby`, :py:meth:`rolling`, :py:meth:`rolling_exp`,
:py:meth:`coarsen`, :py:meth:`weighted`, :py:meth:`resample`,
(:pull:`6702`)
By `Michael Niklas <https://github.com/headtr1ck>`_.
- 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 <https://data-apis.org/array-api/latest/>`_. (:pull:`6804`)
By `Tom White <https://github.com/tomwhite>`_.

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 <https://github.com/taobrienlbl>`_.
- Fix backend support of pydap versions <3.3.0 (:issue:`6648`, :pull:`6656`).
Expand All @@ -61,16 +73,12 @@ Bug fixes
(:issue:`6739`, :pull:`6744`)
By `Michael Niklas <https://github.com/headtr1ck>`_.

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:
Expand Down Expand Up @@ -123,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 <https://github.com/benbovy>`_.
- 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 <https://github.com/TomNicholas>`_.
- Add :py:meth:`core.groupby.DatasetGroupBy.cumsum` and :py:meth:`core.groupby.DataArrayGroupBy.cumsum`.
Expand All @@ -133,7 +141,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 <https://github.com/TomNicholas>`_.
- :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 <https://github.com/headtr1ck>`_.
- Improved overall typing.
Expand Down Expand Up @@ -166,7 +174,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 <https://github.com/benbovy>`_.
- Many arguments like ``keep_attrs``, ``axis``, and ``skipna`` are now keyword
Expand All @@ -179,11 +187,6 @@ Breaking changes
(:pull:`6548`)
By `Michael Niklas <https://github.com/headtr1ck>`_.


Deprecations
~~~~~~~~~~~~


Bug fixes
~~~~~~~~~

Expand Down Expand Up @@ -211,16 +214,16 @@ Bug fixes
By `Stan West <https://github.com/stanwest>`_.
- Fix bug in :py:func:`where` when passing non-xarray objects with ``keep_attrs=True``. (:issue:`6444`, :pull:`6461`)
By `Sam Levang <https://github.com/slevang>`_.
- 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 <https://github.com/delgadom>`_.
- 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`,
:pull:`6489`).
By `Spencer Clark <https://github.com/spencerkclark>`_.
- Dark themes are now properly detected in Furo-themed Sphinx documents (:issue:`6500`, :pull:`6501`).
By `Kevin Paul <https://github.com/kmpaul>`_.
- :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 <https://github.com/headtr1ck>`_.
- Fixed silent overflow issue when decoding times encoded with 32-bit and below
Expand All @@ -236,18 +239,17 @@ Documentation
sizes. In particular, correct the syntax and replace lists with tuples in the
examples. (:issue:`6333`, :pull:`6334`)
By `Stan West <https://github.com/stanwest>`_.
- Mention that ``xr.DataArray.rename`` can rename coordinates.
- Mention that :py:meth:`DataArray.rename` can rename coordinates.
(:issue:`5458`, :pull:`6665`)
By `Michael Niklas <https://github.com/headtr1ck>`_.

- Added examples to :py:meth:`Dataset.thin` and :py:meth:`DataArray.thin`
By `Emma Marshall <https://github.com/e-marshall>`_.

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 <https://github.com/dcherian>`_.
- Substantially improved GroupBy operations using `flox <https://flox.readthedocs.io/en/latest/>`_.
This is auto-enabled when ``flox`` is installed. Use ``xr.set_options(use_flox=False)`` to use
Expand Down Expand Up @@ -506,7 +508,7 @@ New Features
By `Tomas Chor <https://github.com/tomchor>`_.
- Add an option (``"use_bottleneck"``) to disable the use of ``bottleneck`` using :py:func:`set_options` (:pull:`5560`)
By `Justus Magin <https://github.com/keewis>`_.
- 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`).
dcherian marked this conversation as resolved.
Show resolved Hide resolved
dcherian marked this conversation as resolved.
Show resolved Hide resolved
By `Pushkar Kopparla <https://github.com/pkopparla>`_.
- Added ``storage_options`` argument to :py:meth:`to_zarr` (:issue:`5601`, :pull:`5615`).
By `Ray Bell <https://github.com/raybellwaves>`_, `Zachary Blackwood <https://github.com/blackary>`_ and
Expand Down