diff --git a/doc/conf.py b/doc/conf.py index 4bbceddba3d..73b68f7f772 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -327,9 +327,10 @@ "cftime": ("https://unidata.github.io/cftime", None), "sparse": ("https://sparse.pydata.org/en/latest/", None), "hypothesis": ("https://hypothesis.readthedocs.io/en/latest/", None), - "cubed": ("https://tom-e-white.com/cubed/", None), + "cubed": ("https://cubed-dev.github.io/cubed/", None), "datatree": ("https://xarray-datatree.readthedocs.io/en/latest/", None), "xarray-tutorial": ("https://tutorial.xarray.dev/", None), + "flox": ("https://flox.readthedocs.io/en/latest/", None), # "opt_einsum": ("https://dgasmith.github.io/opt_einsum/", None), } diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 75416756aa9..d302393b7d5 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -20,90 +20,100 @@ What's New v2024.02.0 (unreleased) ----------------------- +This release brings size information to the text ``repr``, changes to the accepted frequency +strings, and various bug fixes. + +Thanks to our 12 contributors: + +Anderson Banihirwe, Deepak Cherian, Eivind Jahren, Etienne Schalk, Justus Magin, Marco Wolsza, +Mathias Hauser, Matt Savoie, Maximilian Roos, Rambaud Pierrick, Tom Nicholas + New Features ~~~~~~~~~~~~ -- Added a simple `nbytes` representation in DataArrays and Dataset `repr`. +- Added a simple ``nbytes`` representation in DataArrays and Dataset ``repr``. (:issue:`8690`, :pull:`8702`). By `Etienne Schalk `_. -- Allow negative frequency strings (e.g. ``"-1YE"``). These strings are for example used - in :py:func:`date_range`, and :py:func:`cftime_range` (:pull:`8651`). +- Allow negative frequency strings (e.g. ``"-1YE"``). These strings are for example used in + :py:func:`date_range`, and :py:func:`cftime_range` (:pull:`8651`). By `Mathias Hauser `_. -- Add :py:meth:`NamedArray.expand_dims`, :py:meth:`NamedArray.permute_dims` and :py:meth:`NamedArray.broadcast_to` - (:pull:`8380`) By `Anderson Banihirwe `_. -- Xarray now defers to flox's `heuristics `_ - to set default `method` for groupby problems. This only applies to ``flox>=0.9``. +- Add :py:meth:`NamedArray.expand_dims`, :py:meth:`NamedArray.permute_dims` and + :py:meth:`NamedArray.broadcast_to` (:pull:`8380`) + By `Anderson Banihirwe `_. +- Xarray now defers to `flox's heuristics `_ + to set the default `method` for groupby problems. This only applies to ``flox>=0.9``. By `Deepak Cherian `_. - All `quantile` methods (e.g. :py:meth:`DataArray.quantile`) now use `numbagg` for the calculation of nanquantiles (i.e., `skipna=True`) if it is installed. This is currently limited to the linear interpolation method (`method='linear'`). - (:issue:`7377`, :pull:`8684`) By `Marco Wolsza `_. + (:issue:`7377`, :pull:`8684`) + By `Marco Wolsza `_. Breaking changes ~~~~~~~~~~~~~~~~ - :py:func:`infer_freq` always returns the frequency strings as defined in pandas 2.2 - (:issue:`8612`, :pull:`8627`). By `Mathias Hauser `_. + (:issue:`8612`, :pull:`8627`). + By `Mathias Hauser `_. Deprecations ~~~~~~~~~~~~ -- The `dt.weekday_name` parameter wasn't functional on modern pandas versions and has been removed. (:issue:`8610`, :pull:`8664`) +- The `dt.weekday_name` parameter wasn't functional on modern pandas versions and has been + removed. (:issue:`8610`, :pull:`8664`) By `Sam Coleman `_. Bug fixes ~~~~~~~~~ -- Fixed a regression that prevented multi-index level coordinates being - serialized after resetting or dropping the multi-index (:issue:`8628`, :pull:`8672`). +- Fixed a regression that prevented multi-index level coordinates being serialized after resetting + or dropping the multi-index (:issue:`8628`, :pull:`8672`). By `Benoit Bovy `_. - Fix bug with broadcasting when wrapping array API-compliant classes. (:issue:`8665`, :pull:`8669`) By `Tom Nicholas `_. -- Ensure :py:meth:`DataArray.unstack` works when wrapping array API-compliant classes. (:issue:`8666`, :pull:`8668`) +- Ensure :py:meth:`DataArray.unstack` works when wrapping array API-compliant + classes. (:issue:`8666`, :pull:`8668`) By `Tom Nicholas `_. - Fix negative slicing of Zarr arrays without dask installed. (:issue:`8252`) By `Deepak Cherian `_. -- Preserve chunks when writing time-like variables to zarr by enabling lazy CF - encoding of time-like variables (:issue:`7132`, :issue:`8230`, :issue:`8432`, - :pull:`8575`). By `Spencer Clark `_ and - `Mattia Almansi `_. -- Preserve chunks when writing time-like variables to zarr by enabling their - lazy encoding (:issue:`7132`, :issue:`8230`, :issue:`8432`, :pull:`8253`, - :pull:`8575`; see also discussion in :pull:`8253`). By `Spencer Clark - `_ and `Mattia Almansi - `_. -- Raise an informative error if dtype encoding of time-like variables would - lead to integer overflow or unsafe conversion from floating point to integer - values (:issue:`8542`, :pull:`8575`). By `Spencer Clark - `_. -- Raise an error when unstacking a MultiIndex that has duplicates as this would lead - to silent data loss (:issue:`7104`, :pull:`8737`). By `Mathias Hauser `_. +- Preserve chunks when writing time-like variables to zarr by enabling lazy CF encoding of time-like + variables (:issue:`7132`, :issue:`8230`, :issue:`8432`, :pull:`8575`). + By `Spencer Clark `_ and `Mattia Almansi `_. +- Preserve chunks when writing time-like variables to zarr by enabling their lazy encoding + (:issue:`7132`, :issue:`8230`, :issue:`8432`, :pull:`8253`, :pull:`8575`; see also discussion in + :pull:`8253`). + By `Spencer Clark `_ and `Mattia Almansi `_. +- Raise an informative error if dtype encoding of time-like variables would lead to integer overflow + or unsafe conversion from floating point to integer values (:issue:`8542`, :pull:`8575`). + By `Spencer Clark `_. +- Raise an error when unstacking a MultiIndex that has duplicates as this would lead to silent data + loss (:issue:`7104`, :pull:`8737`). + By `Mathias Hauser `_. Documentation ~~~~~~~~~~~~~ -- Fix `variables` arg typo in `Dataset.sortby()` docstring - (:issue:`8663`, :pull:`8670`) +- Fix `variables` arg typo in `Dataset.sortby()` docstring (:issue:`8663`, :pull:`8670`) By `Tom Vo `_. +- Fixed documentation where the use of the depreciated pandas frequency string prevented the + documentation from being built. (:pull:`8638`) + By `Sam Coleman `_. Internal Changes ~~~~~~~~~~~~~~~~ -- ``DataArray.dt`` now raises an ``AttributeError`` rather than a ``TypeError`` - when the data isn't datetime-like. (:issue:`8718`, :pull:`8724`) +- ``DataArray.dt`` now raises an ``AttributeError`` rather than a ``TypeError`` when the data isn't + datetime-like. (:issue:`8718`, :pull:`8724`) By `Maximilian Roos `_. - -- Move ``parallelcompat`` and ``chunk managers`` modules from ``xarray/core`` to ``xarray/namedarray``. (:pull:`8319`) +- Move ``parallelcompat`` and ``chunk managers`` modules from ``xarray/core`` to + ``xarray/namedarray``. (:pull:`8319`) By `Tom Nicholas `_ and `Anderson Banihirwe `_. - -- Imports ``datatree`` repository and history into internal - location. (:pull:`8688`) By `Matt Savoie `_ - and `Justus Magin `_. - -- Adds :py:func:`open_datatree` into ``xarray/backends`` (:pull:`8697`) By `Matt - Savoie `_. - -- Refactor :py:meth:`xarray.core.indexing.DaskIndexingAdapter.__getitem__` to remove an unnecessary rewrite of the indexer key - (:issue: `8377`, :pull:`8758`) By `Anderson Banihirwe ` +- Imports ``datatree`` repository and history into internal location. (:pull:`8688`) + By `Matt Savoie `_ and `Justus Magin `_. +- Adds :py:func:`open_datatree` into ``xarray/backends`` (:pull:`8697`) + By `Matt Savoie `_. +- Refactor :py:meth:`xarray.core.indexing.DaskIndexingAdapter.__getitem__` to remove an unnecessary + rewrite of the indexer key (:issue: `8377`, :pull:`8758`) + By `Anderson Banihirwe `_. .. _whats-new.2024.01.1: @@ -134,9 +144,6 @@ Documentation - Pin ``sphinx-book-theme`` to ``1.0.1`` to fix a rendering issue with the sidebar in the docs. (:issue:`8619`, :pull:`8632`) By `Tom Nicholas `_. -- Fixed documentation where the use of the depreciated pandas frequency string - prevented the documentation from being built. (:pull:`8638`) - By `Sam Coleman `_. .. _whats-new.2024.01.0: