| Index | index by Group | index by Distribution | index by Vendor | index by creation date | index by Name | Mirrors | Help | Search |
| Name: python311-xarray-parallel | Distribution: openSUSE:Factory:zSystems |
| Version: 2024.3.0 | Vendor: openSUSE |
| Release: 1.1 | Build date: Fri May 3 15:02:26 2024 |
| Group: Unspecified | Build host: reproducible |
| Size: 19244 | Source RPM: python-xarray-2024.3.0-1.1.src.rpm |
| Packager: https://bugs.opensuse.org | |
| Url: https://github.com/pydata/xarray | |
| Summary: The python xarray[parallel] extra | |
The [parallel] extra for xarray, N-D labeled arrays and datasets in Python
Apache-2.0
* Fri May 03 2024 Ben Greiner <code@bnavigator.de>
- Update to 2024.3.0
[#]# New Features
* Partial writes to existing chunks with region or append_dim
will now raise an error (unless safe_chunks=False); previously
an error would only be raised on new variables. (PR8459,
GH8371, GH8882) By Maximilian Roos.
* Grouped and resampling quantile calculations now use the
vectorized algorithm in flox>=0.9.4 if present. By Deepak
Cherian.
* Do not broadcast in arithmetic operations when global option
arithmetic_broadcast=False (GH6806, PR8784). By Etienne Schalk
and Deepak Cherian.
* Add the .oindex property to Explicitly Indexed Arrays for
orthogonal indexing functionality. (GH8238, PR8750) By Anderson
Banihirwe.
* Add the .vindex property to Explicitly Indexed Arrays for
vectorized indexing functionality. (GH8238, PR8780) By Anderson
Banihirwe.
* Expand use of .oindex and .vindex properties. (:pull: 8790) By
Anderson Banihirwe and Deepak Cherian.
* Allow creating xr.Coordinates objects with no indexes (PR8711)
By Benoit Bovy and Tom Nicholas.
* Enable plotting of datetime.dates. (GH8866, PR8873) By Sascha
Hofmann.
[#]# Breaking changes
* Don’t allow overwriting index variables with to_zarr region
writes. (GH8589, PR8876). By Deepak Cherian.
[#]# Bug fixes
* The default freq parameter in xr.date_range() and
xr.cftime_range() is set to 'D' only if periods, start, or end
are None (GH8770, PR8774). By Roberto Chang.
* Ensure that non-nanosecond precision numpy.datetime64 and
numpy.timedelta64 values are cast to nanosecond precision
values when used in DataArray.expand_dims() and
:Dataset.expand_dims() (PR8781). By Spencer Clark.
* CF conform handling of _FillValue/missing_value and dtype in
CFMaskCoder/CFScaleOffsetCoder (GH2304, GH5597, GH7691, PR8713,
see also discussion in PR7654). By Kai Mühlbauer.
* Do not cast _FillValue/missing_value in CFMaskCoder if
_Unsigned is provided (GH8844, PR8852).
* Adapt handling of copy keyword argument for numpy >= 2.0dev
(GH8844, PR8851, PR8865). By Kai Mühlbauer.
* Import trapz/trapezoid depending on numpy version (GH8844,
PR8865). By Kai Mühlbauer.
* Warn and return bytes undecoded in case of UnicodeDecodeError
in h5netcdf-backend (GH5563, PR8874). By Kai Mühlbauer.
* Fix bug incorrectly disallowing creation of a dataset with a
multidimensional coordinate variable with the same name as one
of its dims. (GH8884, PR8886) By Tom Nicholas.
[#]# Internal Changes
* Migrates treenode functionality into xarray/core (PR8757) By
Matt Savoie and Tom Nicholas.
* Migrates datatree functionality into xarray/core. (:pull: 8789)
By Owen Littlejohns, Matt Savoie and Tom Nicholas.
- Drop Add xarray-pr8797-tokenize.patch
- Add xarray-pr8953-nodatatreeprune.patch gh#pydata/xarray#8953
* Mon Mar 18 2024 Ben Greiner <code@bnavigator.de>
- Add xarray-pr8797-tokenize.patch
* gh#pydata/xarray#8797 fixes gh#pydata/xarray#8788
* Fri Mar 01 2024 Matej Cepl <mcepl@cepl.eu>
- Skip Python 3.9. It requires pydap, which is not available any
more.
* Tue Feb 27 2024 Ben Greiner <code@bnavigator.de>
- Update to 2024.2.0
* This release brings size information to the text repr, changes
to the accepted frequency strings, and various bug fixes.
[#]# New Features
* Added a simple nbytes representation in DataArrays and Dataset
repr. (GH8690, PR8702). By Etienne Schalk.
* Allow negative frequency strings (e.g. "-1YE"). These strings
are for example used in date_range(), and cftime_range()
(PR8651). By Mathias Hauser.
* Add NamedArray.expand_dims(), NamedArray.permute_dims() and
NamedArray.broadcast_to() (PR8380) 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. 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’). (GH7377, PR8684) By
Marco Wolsza.
[#]# Breaking changes
* infer_freq() always returns the frequency strings as defined in
pandas 2.2 (GH8612, PR8627). By Mathias Hauser.
* Deprecations
* The dt.weekday_name parameter wasn’t functional on modern
pandas versions and has been removed. (GH8610, PR8664) By Sam
Coleman.
[#]# Bug fixes
* Fixed a regression that prevented multi-index level coordinates
being serialized after resetting or dropping the multi-index
(GH8628, PR8672). By Benoit Bovy.
* Fix bug with broadcasting when wrapping array API-compliant
classes. (GH8665, PR8669) By Tom Nicholas.
* Ensure DataArray.unstack() works when wrapping array
API-compliant classes. (GH8666, PR8668) By Tom Nicholas.
* Fix negative slicing of Zarr arrays without dask installed.
(GH8252) By Deepak Cherian.
* Preserve chunks when writing time-like variables to zarr by
enabling lazy CF encoding of time-like variables (GH7132,
GH8230, GH8432, PR8575). By Spencer Clark and Mattia Almansi.
* Preserve chunks when writing time-like variables to zarr by
enabling their lazy encoding (GH7132, GH8230, GH8432, PR8253,
PR8575; see also discussion in PR8253). 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 (GH8542, PR8575). By
Spencer Clark.
* Raise an error when unstacking a MultiIndex that has duplicates
as this would lead to silent data loss (GH7104, PR8737). By
Mathias Hauser.
- Release 2024.1.1
[#]# Breaking changes
* Following pandas, infer_freq() will return "YE", instead of "Y"
(formerly "A"). This is to be consistent with the deprecation
of the latter frequency string in pandas 2.2. This is a follow
up to PR8415 (GH8612, PR8642). By Mathias Hauser.
[#]# Deprecations
* Following pandas, the frequency string "Y" (formerly "A") is
deprecated in favor of "YE". These strings are used, for
example, in date_range(), cftime_range(), DataArray.resample(),
and Dataset.resample() among others (GH8612, PR8629). By
Mathias Hauser.
- Release 2024.1.0
* This release brings support for weights in correlation and
covariance functions, a new DataArray.cumulative aggregation,
improvements to xr.map_blocks, an update to our minimum
dependencies, and various bugfixes.
[#]# New Features
* xr.cov() and xr.corr() now support using weights (GH8527,
PR7392). By Llorenç Lledó.
* Accept the compression arguments new in netCDF 1.6.0 in the
netCDF4 backend. See netCDF4 documentation for details. Note
that some new compression filters needs plugins to be installed
which may not be available in all netCDF distributions. By
Markel García-Díez. (GH6929, PR7551)
* Add DataArray.cumulative() & Dataset.cumulative() to compute
cumulative aggregations, such as sum, along a dimension — for
example da.cumulative('time').sum(). This is similar to pandas’
.expanding, and mostly equivalent to .cumsum methods, or to
DataArray.rolling() with a window length equal to the dimension
size. By Maximilian Roos. (PR8512)
* Decode/Encode netCDF4 enums and store the enum definition in
dataarrays’ dtype metadata. If multiple variables share the
same enum in netCDF4, each dataarray will have its own enum
definition in their respective dtype metadata. By Abel Aoun.
(GH8144, PR8147)
[#]# Deprecations
* The squeeze kwarg to GroupBy is now deprecated. (GH2157,
PR8507) By Deepak Cherian.
[#]# Bug fixes
* Support non-string hashable dimensions in xarray.DataArray
(GH8546, PR8559). By Michael Niklas.
* Reverse index output of bottleneck’s rolling
move_argmax/move_argmin functions (GH8541, PR8552). By Kai
Mühlbauer.
* Vendor SerializableLock from dask and use as default lock for
netcdf4 backends (GH8442, PR8571). By Kai Mühlbauer.
* Add tests and fixes for empty CFTimeIndex, including broken
html repr (GH7298, PR8600). By Mathias Hauser.
- Create subpackages for the python [extras], test dependencies
with _multibuild
* Thu Jan 04 2024 Sebastian Wagner <sebix@sebix.at>
- Disable ROS3 tests, because hdf5 library was built without ROS3 support.
* Wed Dec 20 2023 Sebastian Wagner <sebix@sebix.at>
- remove obsolete patch file xarray-pr8139-pandas-fill_value.patch
* Wed Dec 13 2023 Sebastian Wagner <sebix@sebix.at>
- update to version 2023.12.0:
- This release brings new `hypothesis <https://hypothesis.works/>`_ strategies for testing, significantly faster rolling aggregations as well as:
``ffill`` and ``bfill`` with ``numbagg``, a new :py:meth:`Dataset.eval` method, and improvements to
- reading and writing Zarr arrays (including a new ``"a-"`` mode).:
- Thanks to our 16 contributors:
- Anderson Banihirwe, Ben Mares, Carl Andersson, Deepak Cherian, Doug Latornell, Gregorio L. Trevisan, Illviljan, Jens Hedegaard Nielsen, Justus Magin, Mathias Hauser, Max Jones, Maximilian Roos, Michael Niklas, Patrick Hoefler, Ryan Abernathey, Tom Nicholas:
- New Features:
- Added hypothesis strategies for generating :py:class:`xarray.Variable` objects containing arbitrary data, useful for parametrizing downstream tests.
Accessible under :py:mod:`testing.strategies`, and documented in a new page on testing in the User Guide.
(:issue:`6911`, :pull:`8404`)
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- :py:meth:`rolling` uses `numbagg <https://github.com/numbagg/numbagg>`_ for
most of its computations by default. Numbagg is up to 5x faster than bottleneck
where parallelization is possible. Where parallelization isn't possible — for
example a 1D array — it's about the same speed as bottleneck, and 2-5x faster
than pandas' default functions. (:pull:`8493`). numbagg is an optional
dependency, so requires installing separately.
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Use a concise format when plotting datetime arrays. (:pull:`8449`).
By `Jimmy Westling <https://github.com/illviljan>`_.
- Avoid overwriting unchanged existing coordinate variables when appending with :py:meth:`Dataset.to_zarr` by setting ``mode='a-'``.
By `Ryan Abernathey <https://github.com/rabernat>`_ and `Deepak Cherian <https://github.com/dcherian>`_.
- :py:meth:`~xarray.DataArray.rank` now operates on dask-backed arrays, assuming
the core dim has exactly one chunk. (:pull:`8475`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Add a :py:meth:`Dataset.eval` method, similar to the pandas' method of the
same name. (:pull:`7163`). This is currently marked as experimental and
doesn't yet support the ``numexpr`` engine.
- :py:meth:`Dataset.drop_vars` & :py:meth:`DataArray.drop_vars` allow passing a
callable, similar to :py:meth:`Dataset.where` & :py:meth:`Dataset.sortby` & others.
(:pull:`8511`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Breaking changes:
- Explicitly warn when creating xarray objects with repeated dimension names.
Such objects will also now raise when :py:meth:`DataArray.get_axis_num` is called,
which means many functions will raise.
This latter change is technically a breaking change, but whilst allowed,
this behaviour was never actually supported! (:issue:`3731`, :pull:`8491`)
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Deprecations:
- As part of an effort to standardize the API, we're renaming the ``dims``
keyword arg to ``dim`` for the minority of functions which current use
``dims``. This started with :py:func:`xarray.dot` & :py:meth:`DataArray.dot`
and we'll gradually roll this out across all functions. The warnings are
currently ``PendingDeprecationWarning``, which are silenced by default. We'll
convert these to ``DeprecationWarning`` in a future release.
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Raise a ``FutureWarning`` warning that the type of :py:meth:`Dataset.dims` will be changed
from a mapping of dimension names to lengths to a set of dimension names.
This is to increase consistency with :py:meth:`DataArray.dims`.
To access a mapping of dimension names to lengths please use :py:meth:`Dataset.sizes`.
The same change also applies to `DatasetGroupBy.dims`.
(:issue:`8496`, :pull:`8500`)
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- :py:meth:`Dataset.drop` & :py:meth:`DataArray.drop` are now deprecated, since pending deprecation for
several years. :py:meth:`DataArray.drop_sel` & :py:meth:`DataArray.drop_var`
replace them for labels & variables respectively. (:pull:`8497`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Bug fixes:
- Fix dtype inference for ``pd.CategoricalIndex`` when categories are backed by a ``pd.ExtensionDtype`` (:pull:`8481`)
- Fix writing a variable that requires transposing when not writing to a region (:pull:`8484`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Static typing of ``p0`` and ``bounds`` arguments of :py:func:`xarray.DataArray.curvefit` and :py:func:`xarray.Dataset.curvefit`
was changed to ``Mapping`` (:pull:`8502`).
By `Michael Niklas <https://github.com/headtr1ck>`_.
- Fix typing of :py:func:`xarray.DataArray.to_netcdf` and :py:func:`xarray.Dataset.to_netcdf`
when ``compute`` is evaluated to bool instead of a Literal (:pull:`8268`).
By `Jens Hedegaard Nielsen <https://github.com/jenshnielsen>`_.
- Documentation:
- Added illustration of updating the time coordinate values of a resampled dataset using
time offset arithmetic.
This is the recommended technique to replace the use of the deprecated ``loffset`` parameter
in ``resample`` (:pull:`8479`).
By `Doug Latornell <https://github.com/douglatornell>`_.
- Improved error message when attempting to get a variable which doesn't exist from a Dataset.
(:pull:`8474`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Fix default value of ``combine_attrs`` in :py:func:`xarray.combine_by_coords` (:pull:`8471`)
By `Gregorio L. Trevisan <https://github.com/gtrevisan>`_.
- Internal Changes:
- :py:meth:`DataArray.bfill` & :py:meth:`DataArray.ffill` now use numbagg <https://github.com/numbagg/numbagg>`_ by
default, which is up to 5x faster where parallelization is possible. (:pull:`8339`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Update mypy version to 1.7 (:issue:`8448`, :pull:`8501`).
By `Michael Niklas <https://github.com/headtr1ck>`_.
- update to version 2023.11.0:
`This is our 10th year anniversary release! <https://github.com/pydata/xarray/discussions/8462>`_ Thank you for your love and support.
- This release brings the ability to use ``opt_einsum`` for :py:func:`xarray.dot` by default,:
- support for auto-detecting ``region`` when writing partial datasets to Zarr, and the use of h5py:
- drivers with ``h5netcdf``.:
- Thanks to the 19 contributors to this release:
- Aman Bagrecha, Anderson Banihirwe, Ben Mares, Deepak Cherian, Dimitri Papadopoulos Orfanos, Ezequiel Cimadevilla Alvarez,:
- Illviljan, Justus Magin, Katelyn FitzGerald, Kai Muehlbauer, Martin Durant, Maximilian Roos, Metamess, Sam Levang, Spencer Clark, Tom Nicholas, mgunyho, templiert:
- New Features:
- Use `opt_einsum <https://optimized-einsum.readthedocs.io/en/stable/>`_ for :py:func:`xarray.dot` by default if installed.
By `Deepak Cherian <https://github.com/dcherian>`_. (:issue:`7764`, :pull:`8373`).
- Add ``DataArray.dt.total_seconds()`` method to match the Pandas API. (:pull:`8435`).
By `Ben Mares <https://github.com/maresb>`_.
- Allow passing ``region="auto"`` in :py:meth:`Dataset.to_zarr` to automatically infer the
region to write in the original store. Also implement automatic transpose when dimension
order does not match the original store. (:issue:`7702`, :issue:`8421`, :pull:`8434`).
By `Sam Levang <https://github.com/slevang>`_.
- Allow the usage of h5py drivers (eg: ros3) via h5netcdf (:pull:`8360`).
By `Ezequiel Cimadevilla <https://github.com/zequihg50>`_.
- Enable VLEN string fill_values, preserve VLEN string dtypes (:issue:`1647`, :issue:`7652`, :issue:`7868`, :pull:`7869`).
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
- Breaking changes:
- drop support for `cdms2 <https://github.com/CDAT/cdms>`_. Please use
`xcdat <https://github.com/xCDAT/xcdat>`_ instead (:pull:`8441`).
By `Justus Magin <https://github.com/keewis>`_.
- Following pandas, :py:meth:`infer_freq` will return ``"Y"``, ``"YS"``,
``"QE"``, ``"ME"``, ``"h"``, ``"min"``, ``"s"``, ``"ms"``, ``"us"``, or
``"ns"`` instead of ``"A"``, ``"AS"``, ``"Q"``, ``"M"``, ``"H"``, ``"T"``,
``"S"``, ``"L"``, ``"U"``, or ``"N"``. This is to be consistent with the
deprecation of the latter frequency strings (:issue:`8394`, :pull:`8415`). By
`Spencer Clark <https://github.com/spencerkclark>`_.
- Bump minimum tested pint version to ``>=0.22``. By `Deepak Cherian <https://github.com/dcherian>`_.
- Minimum supported versions for the following packages have changed: ``h5py >=3.7``, ``h5netcdf>=1.1``.
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
- Deprecations:
- The PseudoNetCDF backend has been removed. By `Deepak Cherian <https://github.com/dcherian>`_.
- Supplying dimension-ordered sequences to :py:meth:`DataArray.chunk` &
:py:meth:`Dataset.chunk` is deprecated in favor of supplying a dictionary of
dimensions, or a single ``int`` or ``"auto"`` argument covering all
dimensions. Xarray favors using dimensions names rather than positions, and
this was one place in the API where dimension positions were used.
(:pull:`8341`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Following pandas, the frequency strings ``"A"``, ``"AS"``, ``"Q"``, ``"M"``,
``"H"``, ``"T"``, ``"S"``, ``"L"``, ``"U"``, and ``"N"`` are deprecated in
favor of ``"Y"``, ``"YS"``, ``"QE"``, ``"ME"``, ``"h"``, ``"min"``, ``"s"``,
``"ms"``, ``"us"``, and ``"ns"``, respectively. These strings are used, for
example, in :py:func:`date_range`, :py:func:`cftime_range`,
:py:meth:`DataArray.resample`, and :py:meth:`Dataset.resample` among others
(:issue:`8394`, :pull:`8415`). By `Spencer Clark
<https://github.com/spencerkclark>`_.
- Rename :py:meth:`Dataset.to_array` to :py:meth:`Dataset.to_dataarray` for
consistency with :py:meth:`DataArray.to_dataset` &
:py:func:`open_dataarray` functions. This is a "soft" deprecation — the
existing methods work and don't raise any warnings, given the relatively small
benefits of the change.
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Finally remove ``keep_attrs`` kwarg from :py:meth:`DataArray.resample` and
:py:meth:`Dataset.resample`. These were deprecated a long time ago.
By `Deepak Cherian <https://github.com/dcherian>`_.
- Bug fixes:
- Port `bug fix from pandas <https://github.com/pandas-dev/pandas/pull/55283>`_
to eliminate the adjustment of resample bin edges in the case that the
resampling frequency has units of days and is greater than one day
(e.g. ``"2D"``, ``"3D"`` etc.) and the ``closed`` argument is set to
``"right"`` to xarray's implementation of resample for data indexed by a
:py:class:`CFTimeIndex` (:pull:`8393`).
By `Spencer Clark <https://github.com/spencerkclark>`_.
- Fix to once again support date offset strings as input to the loffset
parameter of resample and test this functionality (:pull:`8422`, :issue:`8399`).
By `Katelyn FitzGerald <https://github.com/kafitzgerald>`_.
- Fix a bug where :py:meth:`DataArray.to_dataset` silently drops a variable
if a coordinate with the same name already exists (:pull:`8433`, :issue:`7823`).
By `András Gunyhó <https://github.com/mgunyho>`_.
- Fix for :py:meth:`DataArray.to_zarr` & :py:meth:`Dataset.to_zarr` to close
the created zarr store when passing a path with `.zip` extension (:pull:`8425`).
By `Carl Andersson <https://github.com/CarlAndersson>_`.
- Documentation:
- Small updates to documentation on distributed writes: See :ref:`io.zarr.appending` to Zarr.
By `Deepak Cherian <https://github.com/dcherian>`_.
- update to version 2023.10.1:
- This release updates our minimum numpy version in ``pyproject.toml`` to 1.22,:
- consistent with our documentation below.:
- update to version 2023.10.0:
- This release brings performance enhancements to reading Zarr datasets, the ability to use `numbagg <https://github.com/numbagg/numbagg>`_ for reductions,:
- an expansion in API for ``rolling_exp``, fixes two regressions with datetime decoding,:
- and many other bugfixes and improvements. Groupby reductions will also use ``numbagg`` if ``flox>=0.8.1`` and ``numbagg`` are both installed.:
- Thanks to our 13 contributors:
- Anderson Banihirwe, Bart Schilperoort, Deepak Cherian, Illviljan, Kai Mühlbauer, Mathias Hauser, Maximilian Roos, Michael Niklas, Pieter Eendebak, Simon Høxbro Hansen, Spencer Clark, Tom White, olimcc:
- New Features:
- Support high-performance reductions with `numbagg <https://github.com/numbagg/numbagg>`_.
This is enabled by default if ``numbagg`` is installed.
By `Deepak Cherian <https://github.com/dcherian>`_. (:pull:`8316`)
- Add ``corr``, ``cov``, ``std`` & ``var`` to ``.rolling_exp``.
By `Maximilian Roos <https://github.com/max-sixty>`_. (:pull:`8307`)
- :py:meth:`DataArray.where` & :py:meth:`Dataset.where` accept a callable for
the ``other`` parameter, passing the object as the only argument. Previously,
this was only valid for the ``cond`` parameter. (:issue:`8255`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- ``.rolling_exp`` functions can now take a ``min_weight`` parameter, to only
output values when there are sufficient recent non-nan values.
``numbagg>=0.3.1`` is required. (:pull:`8285`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- :py:meth:`DataArray.sortby` & :py:meth:`Dataset.sortby` accept a callable for
the ``variables`` parameter, passing the object as the only argument.
By `Maximilian Roos <https://github.com/max-sixty>`_.
- ``.rolling_exp`` functions can now operate on dask-backed arrays, assuming the
core dim has exactly one chunk. (:pull:`8284`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Breaking changes:
- Made more arguments keyword-only (e.g. ``keep_attrs``, ``skipna``) for many :py:class:`xarray.DataArray` and
:py:class:`xarray.Dataset` methods (:pull:`6403`). By `Mathias Hauser <https://github.com/mathause>`_.
- :py:meth:`Dataset.to_zarr` & :py:meth:`DataArray.to_zarr` require keyword
arguments after the initial 7 positional arguments.
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Deprecations:
- Rename :py:meth:`Dataset.reset_encoding` & :py:meth:`DataArray.reset_encoding`
to :py:meth:`Dataset.drop_encoding` & :py:meth:`DataArray.drop_encoding` for
consistency with other ``drop`` & ``reset`` methods — ``drop`` generally
removes something, while ``reset`` generally resets to some default or
standard value. (:pull:`8287`, :issue:`8259`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Bug fixes:
- :py:meth:`DataArray.rename` & :py:meth:`Dataset.rename` would emit a warning
when the operation was a no-op. (:issue:`8266`)
By `Simon Hansen <https://github.com/hoxbro>`_.
- Fixed a regression introduced in the previous release checking time-like units
when encoding/decoding masked data (:issue:`8269`, :pull:`8277`).
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
- Fix datetime encoding precision loss regression introduced in the previous
release for datetimes encoded with units requiring floating point values, and
a reference date not equal to the first value of the datetime array
(:issue:`8271`, :pull:`8272`). By `Spencer Clark
<https://github.com/spencerkclark>`_.
- Fix excess metadata requests when using a Zarr store. Prior to this, metadata
was re-read every time data was retrieved from the array, now metadata is retrieved only once
when they array is initialized.
(:issue:`8290`, :pull:`8297`).
By `Oliver McCormack <https://github.com/olimcc>`_.
- Fix to_zarr ending in a ReadOnlyError when consolidated metadata was used and the
write_empty_chunks was provided.
(:issue:`8323`, :pull:`8326`)
By `Matthijs Amesz <https://github.com/Metamess>`_.
- Documentation:
- Added page on the interoperability of xarray objects.
(:pull:`7992`) By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Added xarray-regrid to the list of xarray related projects (:pull:`8272`).
By `Bart Schilperoort <https://github.com/BSchilperoort>`_.
- Internal Changes:
- More improvements to support the Python `array API standard <https://data-apis.org/array-api/latest/>`_
by using duck array ops in more places in the codebase. (:pull:`8267`)
By `Tom White <https://github.com/tomwhite>`_.
- update to version 2023.09.0:
- This release continues work on the new :py:class:`xarray.Coordinates` object, allows to provide `preferred_chunks` when:
- reading from netcdf files, enables :py:func:`xarray.apply_ufunc` to handle missing core dimensions and fixes several bugs.:
- Thanks to the 24 contributors to this release: Alexander Fischer, Amrest Chinkamol, Benoit Bovy, Darsh Ranjan, Deepak Cherian,:
- Gianfranco Costamagna, Gregorio L. Trevisan, Illviljan, Joe Hamman, JR, Justus Magin, Kai Mühlbauer, Kian-Meng Ang, Kyle Sunden,:
- Martin Raspaud, Mathias Hauser, Mattia Almansi, Maximilian Roos, András Gunyhó, Michael Niklas, Richard Kleijn, Riulinchen,:
- Tom Nicholas and Wiktor Kraśnicki.:
- We welcome the following new contributors to Xarray!: Alexander Fischer, Amrest Chinkamol, Darsh Ranjan, Gianfranco Costamagna, Gregorio L. Trevisan,:
- Kian-Meng Ang, Riulinchen and Wiktor Kraśnicki.:
- New Features:
- Added the :py:meth:`Coordinates.assign` method that can be used to combine
different collections of coordinates prior to assign them to a Dataset or
DataArray (:pull:`8102`) at once.
By `Benoît Bovy <https://github.com/benbovy>`_.
- Provide `preferred_chunks` for data read from netcdf files (:issue:`1440`, :pull:`7948`).
By `Martin Raspaud <https://github.com/mraspaud>`_.
- Added `on_missing_core_dims` to :py:meth:`apply_ufunc` to allow for copying or
dropping a :py:class:`Dataset`'s variables with missing core dimensions (:pull:`8138`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Breaking changes:
- The :py:class:`Coordinates` constructor now creates a (pandas) index by
default for each dimension coordinate. To keep the previous behavior (no index
created), pass an empty dictionary to ``indexes``. The constructor now also
extracts and add the indexes from another :py:class:`Coordinates` object
passed via ``coords`` (:pull:`8107`).
By `Benoît Bovy <https://github.com/benbovy>`_.
- Static typing of ``xlim`` and ``ylim`` arguments in plotting functions now must
be ``tuple[float, float]`` to align with matplotlib requirements. (:issue:`7802`, :pull:`8030`).
By `Michael Niklas <https://github.com/headtr1ck>`_.
- Deprecations:
- Deprecate passing a :py:class:`pandas.MultiIndex` object directly to the
:py:class:`Dataset` and :py:class:`DataArray` constructors as well as to
:py:meth:`Dataset.assign` and :py:meth:`Dataset.assign_coords`.
A new Xarray :py:class:`Coordinates` object has to be created first using
:py:meth:`Coordinates.from_pandas_multiindex` (:pull:`8094`).
By `Benoît Bovy <https://github.com/benbovy>`_.
- Bug fixes:
- Improved static typing of reduction methods (:pull:`6746`).
By `Richard Kleijn <https://github.com/rhkleijn>`_.
- Fix bug where empty attrs would generate inconsistent tokens (:issue:`6970`, :pull:`8101`).
By `Mattia Almansi <https://github.com/malmans2>`_.
- Improved handling of multi-coordinate indexes when updating coordinates, including bug fixes
(and improved warnings for deprecated features) for pandas multi-indexes (:pull:`8094`).
By `Benoît Bovy <https://github.com/benbovy>`_.
- Fixed a bug in :py:func:`merge` with ``compat='minimal'`` where the coordinate
names were not updated properly internally (:issue:`7405`, :issue:`7588`,
:pull:`8104`).
By `Benoît Bovy <https://github.com/benbovy>`_.
- Fix bug where :py:class:`DataArray` instances on the right-hand side
of :py:meth:`DataArray.__setitem__` lose dimension names (:issue:`7030`, :pull:`8067`).
By `Darsh Ranjan <https://github.com/dranjan>`_.
- Return ``float64`` in presence of ``NaT`` in :py:class:`~core.accessor_dt.DatetimeAccessor` and
special case ``NaT`` handling in :py:meth:`~core.accessor_dt.DatetimeAccessor.isocalendar`
(:issue:`7928`, :pull:`8084`).
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
- Fix :py:meth:`~core.rolling.DatasetRolling.construct` with stride on Datasets without indexes.
(:issue:`7021`, :pull:`7578`).
By `Amrest Chinkamol <https://github.com/p4perf4ce>`_ and `Michael Niklas <https://github.com/headtr1ck>`_.
- Calling plot with kwargs ``col``, ``row`` or ``hue`` no longer squeezes dimensions passed via these arguments
(:issue:`7552`, :pull:`8174`).
By `Wiktor Kraśnicki <https://github.com/wkrasnicki>`_.
- Fixed a bug where casting from ``float`` to ``int64`` (undefined for ``NaN``) led to varying issues (:issue:`7817`, :issue:`7942`, :issue:`7790`, :issue:`6191`, :issue:`7096`,
:issue:`1064`, :pull:`7827`).
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
- Fixed a bug where inaccurate ``coordinates`` silently failed to decode variable (:issue:`1809`, :pull:`8195`).
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_
- ``.rolling_exp`` functions no longer mistakenly lose non-dimensioned coords
(:issue:`6528`, :pull:`8114`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- In the event that user-provided datetime64/timedelta64 units and integer dtype encoding parameters conflict with each other, override the units to preserve an integer dtype for most faithful serialization to disk (:issue:`1064`, :pull:`8201`).
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
- Static typing of dunder ops methods (like :py:meth:`DataArray.__eq__`) has been fixed.
Remaining issues are upstream problems (:issue:`7780`, :pull:`8204`).
By `Michael Niklas <https://github.com/headtr1ck>`_.
- Fix type annotation for ``center`` argument of plotting methods (like :py:meth:`xarray.plot.dataarray_plot.pcolormesh`) (:pull:`8261`).
By `Pieter Eendebak <https://github.com/eendebakpt>`_.
- Documentation:
- Make documentation of :py:meth:`DataArray.where` clearer (:issue:`7767`, :pull:`7955`).
By `Riulinchen <https://github.com/Riulinchen>`_.
- Internal Changes:
- Many error messages related to invalid dimensions or coordinates now always show the list of valid dims/coords (:pull:`8079`).
By `András Gunyhó <https://github.com/mgunyho>`_.
- Refactor of encoding and decoding times/timedeltas to preserve nanosecond resolution in arrays that contain missing values (:pull:`7827`).
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
- Transition ``.rolling_exp`` functions to use `.apply_ufunc` internally rather
than `.reduce`, as the start of a broader effort to move non-reducing
functions away from ```.reduce``, (:pull:`8114`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Test range of fill_value's in test_interpolate_pd_compat (:issue:`8146`, :pull:`8189`).
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
* Sun Sep 10 2023 Ben Greiner <code@bnavigator.de>
- Update to 2023.8.0
* This release brings changes to minimum dependencies, allows
reading of datasets where a dimension name is associated with a
multidimensional variable (e.g. finite volume ocean model
output), and introduces a new xarray.Coordinates object.
[#]# Announcements
* The xarray.Variable class is being refactored out to a new
project title 'namedarray'. See the design doc for more
details. Reach out to us on this discussion topic if you have
any thoughts.
[#]# What's Changed
* Use variable name in all exceptions raised in as_variable by
@ZedThree in #7995
* Allow opening datasets with nD dimenson coordinate variables.
by @dcherian in #7989
* join together duplicate entries in the text repr by @keewis in
[#7225]
* Expose "Coordinates" as part of Xarray's public API by @benbovy
in #7368
* Update interpolate_na in dataset.py by @ilgast in #7974
* Add HDF5 Section to read/write docs page by @rwegener2 in #8012
* Add examples to docstrings by @harshitha1201 in #7937
* (chore) min versions bump by @jhamman in #8022
* Automatically chunk other in GroupBy binary ops. by @dcherian
in #7684
* change cumproduct to cumprod by @quantsnus in #8031
* Reduce pre-commit update frequency to monthly from weekly. by
@dcherian in #8033
* sort when encoding coordinates for deterministic outputs by
@itcarroll in #8034
* Zarr : Allow setting write_empty_chunks by @RKuttruff in #8016
* Count documentation by @Articoking in #8057
* unpin numpy by @keewis in #8061
- Release 2023.7.0
* This release brings improvements to the documentation on
wrapping numpy-like arrays, improved docstrings, and bug fixes.
[#]# What's Changed
* Allow cubed arrays to be passed to flox groupby by @TomNicholas
in #7941
* Duck array documentation improvements by @TomNicholas in #7911
* Docstring examples by @harshitha1201 in #7881
* Chunked array docs by @TomNicholas in #7951
* ensure no forward slashes in names for HDF5-based backends by
@kmuehlbauer in #7953
* Move absolute path finder from open_mfdataset to own function
by @Illviljan in #7968
* Skip broken tests on Python 3.11 and Windows by @Illviljan in
[#7972]
* Examples added to docstrings by @harshitha1201 in #7936
* Fix typo in zarr.py by @johmathe in #7983
* Improve explanation in example "Working with Multidimensional
Coordinates" by @yvonnefroehlich in #7984
* Remove hue_style from plot1d docstring by @Illviljan in #7925
- Release 2023.06.0
* This release adds features to curvefit, improves the
performance of concatenation, and fixes various bugs.
[#]# What's Changed
* Array API fixes for astype by @TomNicholas in #7847
* Add type hints to test_dtypes by @Illviljan in #7858
* adapt the pint + dask test to the newest version of pint by
@keewis in #7855
* Avoid explicit loop when updating OrderedSet by @Illviljan in
[#7857]
* Improve to_dask_dataframe performance by @Illviljan in #7844
* Changed duck typing exception to: (ImportError, AttributeError)
by @vhaasteren in #7874
* defer to numpy for the expected result by @keewis in #7875
* deprecate the cdms2 conversion methods by @keewis in #7876
* Implement multidimensional initial guess and bounds for
curvefit by @mgunyho in #7821
* Improve concat performance by @Illviljan in #7824
* Fix .groupby(multi index level) by @dcherian in #7830
* don't use CacheFileManager.__del__ on interpreter shutdown by
@keewis in #7880
* fix polyfit changing the original object by @malmans2 in #7900
* Fix flaky doctest for curvefit by @mgunyho in #7893
* Ensure dtype of reindex result matches dtype of the original
DataArray by @andersy005 in #7917
* Add errors option to curvefit by @mgunyho in #7891
* CF encoding should preserve vlen dtype for empty arrays by
@tomwhite in #7862
* use trusted publishers instead of a API token by @keewis in
[#7899]
* Add cfgrib,ipywidgets to doc env by @dcherian in #7888
* Fix regression with grouper object on an IndexVariable by
@mwtoews in #7920
* Fix check for chunk_store in zarr backend by @juntyr in #7923
* fixing rolling_window issue with cupy by @negin513 in #7938
- Add xarray-pr8139-pandas-fill_value.patch gh#pydata/xarray#8125,
gh#pydata/xarray#8139
* Wed May 31 2023 Dirk Müller <dmueller@suse.com>
- update to 2023.05.0:
* This release adds some new methods and operators, updates our
deprecation policy for python versions, fixes some bugs with
groupby, and introduces experimental support for alternative
chunked parallel array computation backends via a new plugin
system!
* Docstrings examples for string methods
* Fix groupby_bins when labels are specified
* Fix binning by unsorted array
* This release includes support for pandas v2, allows
refreshing of backend engines in a session, and removes
deprecated backends for ``rasterio`` and ``cfgrib``.
* Thu Mar 09 2023 Sebastian Wagner <sebix@sebix.at>
- update to version 2023.02.0:
- This release brings a major upgrade to :py:func:`xarray.concat`, many bug fixes,:
- and a bump in supported dependency versions. Thanks to our 11 contributors:
- Aron Gergely, Deepak Cherian, Illviljan, James Bourbeau, Joe Hamman,:
- Justus Magin, Hauke Schulz, Kai Mühlbauer, Ken Mankoff, Spencer Clark, Tom Nicholas.:
- Breaking changes:
- Support for ``python 3.8`` has been dropped and the minimum versions of some
dependencies were changed (:pull:`7461`):
===================== ========= ========
Package Old New
===================== ========= ========
python 3.8 3.9
numpy 1.20 1.21
pandas 1.3 1.4
dask 2021.11 2022.1
distributed 2021.11 2022.1
h5netcdf 0.11 0.13
lxml 4.6 4.7
numba 5.4 5.5
===================== ========= ========
- Deprecations:
- Following pandas, the `closed` parameters of :py:func:`cftime_range` and
:py:func:`date_range` are deprecated in favor of the `inclusive` parameters,
and will be removed in a future version of xarray (:issue:`6985`:,
:pull:`7373`).
- Bug fixes:
- :py:func:`xarray.concat` can now concatenate variables present in some datasets but
not others (:issue:`508`, :pull:`7400`).
- Handle ``keep_attrs`` option in binary operators of :py:meth:`Dataset` (:issue:`7390`, :pull:`7391`).
- Improve error message when using dask in :py:func:`apply_ufunc` with ``output_sizes`` not supplied. (:pull:`7509`)
- :py:func:`xarray.Dataset.to_zarr` now drops variable encodings that have been added by xarray during reading
a dataset. (:issue:`7129`, :pull:`7500`).
- Documentation:
- Mention the `flox package <https://flox.readthedocs.io>`_ in GroupBy documentation and docstrings.
- update to version 2023.01.0:
- This release includes a number of bug fixes. Thanks to the 14 contributors to this release:
- Aron Gergely, Benoit Bovy, Deepak Cherian, Ian Carroll, Illviljan, Joe Hamman, Justus Magin, Mark Harfouche,:
- Matthew Roeschke, Paige Martin, Pierre, Sam Levang, Tom White, stefank0.:
- Breaking changes:
- :py:meth:`CFTimeIndex.get_loc` has removed the ``method`` and ``tolerance`` keyword arguments.
Use ``.get_indexer([key], method=..., tolerance=...)`` instead (:pull:`7361`).
- Bug fixes:
- Avoid in-memory broadcasting when converting to a dask dataframe
using ``.to_dask_dataframe.`` (:issue:`6811`, :pull:`7472`).
- Accessing the property ``.nbytes`` of a DataArray, or Variable no longer
accidentally triggers loading the variable into memory.
- Allow numpy-only objects in :py:func:`where` when ``keep_attrs=True`` (:issue:`7362`, :pull:`7364`).
- add a ``keep_attrs`` parameter to :py:meth:`Dataset.pad`, :py:meth:`DataArray.pad`,
and :py:meth:`Variable.pad` (:pull:`7267`).
- Fixed performance regression in alignment between indexed and non-indexed objects
of the same shape (:pull:`7382`).
- Preserve original dtype on accessing MultiIndex levels (:issue:`7250`,
:pull:`7393`).
- Internal Changes:
- Add the pre-commit hook `absolufy-imports` to convert relative xarray imports to
absolute imports (:pull:`7204`, :pull:`7370`).
* Sat Jan 07 2023 Ben Greiner <code@bnavigator.de>
- Update to 2022.12.0
* This release includes a number of bug fixes and experimental
support for Zarr V3.
[#]# New Features
* Enable using offset and origin arguments in
DataArray.resample() and Dataset.resample() (GH7266, PR7284).
* Add experimental support for Zarr’s in-progress V3
specification. (PR6475).
[#]# Breaking changes
* The minimum versions of some dependencies were changed
(PR7300):
[#]# Deprecations
* The PyNIO backend has been deprecated (GH4491, PR7301).
[#]# Bug fixes
* Fix handling of coordinate attributes in where(). (GH7220,
PR7229)
* Import nc_time_axis when needed (GH7275, PR7276).
* Fix static typing of xr.polyval() (GH7312, PR7315).
* Fix multiple reads on fsspec S3 files by resetting file pointer
to 0 when reading file streams (GH6813, PR7304).
* Fix Dataset.assign_coords() resetting all dimension coordinates
to default (pandas) index (GH7346, PR7347).
* Tue Nov 22 2022 Ben Greiner <code@bnavigator.de>
- Update to 2022.11.0
* This release brings a number of bugfixes and documentation
improvements. Both text and HTML reprs now have a new "Indexes"
section, which we expect will help with development of new
Index objects. This release also features more support for the
Python Array API.
[#]# New Features
* Add static typing to plot accessors (GH6949, PR7052). By
Michael Niklas.
* Display the indexes in a new section of the text and HTML reprs
(PR6795, PR7183, PR7185) By Justus Magin and Benoît Bovy.
* Added methods DataArrayGroupBy.cumprod() and
DatasetGroupBy.cumprod(). (PR5816) By Patrick Naylor
[#]# Breaking changes
* repr(ds) may not show the same result because it doesn’t load
small, lazy data anymore. Use ds.head().load() when wanting to
see just a sample of the data. (GH6722, PR7203). By Jimmy
Westling.
* Many arguments of plotmethods have been made keyword-only.
* xarray.plot.plot module renamed to xarray.plot.dataarray_plot
to prevent shadowing of the plot method. (GH6949, PR7052). By
Michael Niklas.
[#]# Deprecations
* Positional arguments for all plot methods have been deprecated
(GH6949, PR7052). By Michael Niklas.
* xarray.plot.FacetGrid.axes has been renamed to
xarray.plot.FacetGrid.axs because it’s not clear if axes refers
to single or multiple Axes instances. This aligns with
matplotlib.pyplot.subplots. (PR7194) By Jimmy Westling.
[#]# Bug fixes
* Explicitly opening a file multiple times (e.g., after modifying
it on disk) now reopens the file from scratch for h5netcdf and
scipy netCDF backends, rather than reusing a cached version
(GH4240, GH4862). By Stephan Hoyer.
* Fixed bug where Dataset.coarsen.construct() would demote
non-dimension coordinates to variables. (PR7233) By Tom
Nicholas.
* Raise a TypeError when trying to plot empty data (GH7156,
PR7228). By Michael Niklas.
[#]# Internal Changes
* Doctests fail on any warnings (PR7166) By Maximilian Roos.
* Improve import time by lazy loading dask.distributed (:pull:
7172).
* Explicitly specify longdouble=False in cftime.date2num() when
encoding times to preserve existing behavior and prevent future
errors when it is eventually set to True by default in cftime
(PR7171). By Spencer Clark.
* Improved import time by lazily importing backend modules,
matplotlib, dask.array and flox. (GH6726, PR7179) By Michael
Niklas.
* Emit a warning under the development version of pandas when we
convert non-nanosecond precision datetime or timedelta values
to nanosecond precision. This was required in the past, because
pandas previously was not compatible with non-nanosecond
precision values. However pandas is currently working towards
removing this restriction. When things stabilize in pandas we
will likely consider relaxing this behavior in xarray as well
(GH7175, PR7201). By Spencer Clark.
- Drop scipy-interpolate.patch: not required
* Tue Oct 18 2022 Matej Cepl <mcepl@suse.com>
- Update to 2022.10.0:
- This release brings numerous bugfixes, a change in minimum
supported versions, and a new scatter plot method for
DataArrays.
- Also, temporarily import loop_in_thread fixture from
distributed.
- Update to 2022.9.0:
- This release brings a large number of bugfixes and
documentation improvements, as well as an external interface
for setting custom indexes!
* Sun Aug 07 2022 Arun Persaud <arun@gmx.de>
- specfile:
* updated requirements versions
* added new requirements: packaging and flox (recommends)
* require python >= 3.8
* update line numbers in patches
* changed README.rst->README.md
- update to version 2022.6.0:
* 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. It also stops testing
support for the abandoned PyNIO.
* Much effort has been made to preserve backwards compatibility as
part of the indexing refactor. We are aware of one unfixed issue.
* New Features
+ Add Dataset.dtypes, core.coordinates.DatasetCoordinates.dtypes,
core.coordinates.DataArrayCoordinates.dtypes properties: Mapping
from variable names to dtypes. (PR6706) By Michael Niklas.
+ Initial typing support for groupby(), rolling(), rolling_exp(),
coarsen(), weighted(), resample(), (PR6702) By Michael Niklas.
+ Experimental support for wrapping any array type that conforms
to the python array api standard. (PR6804) By Tom White.
* Bug fixes
+ save_mfdataset() now passes **kwargs on to Dataset.to_netcdf(),
allowing the encoding and unlimited_dims options with
save_mfdataset(). (GH6684) By Travis A. O’Brien.
+ Fix backend support of pydap versions <3.3.0 (GH6648,
PR6656). By Hauke Schulz.
+ Dataset.where() with drop=True now behaves correctly with mixed
dimensions. (GH6227, PR6690) By Michael Niklas.
+ Accommodate newly raised OutOfBoundsTimedelta error in the
development version of pandas when decoding times outside the
range that can be represented with nanosecond-precision values
(GH6716, PR6717). By Spencer Clark.
+ open_dataset() with dask and ~ in the path now resolves the home
directory instead of raising an error. (GH6707, PR6710) By
Michael Niklas.
+ DataArrayRolling.__iter__() with center=True now works
correctly. (GH6739, PR6744) By Michael Niklas.
* Internal Changes
+ xarray.core.groupby, xarray.core.rolling,
xarray.core.rolling_exp, xarray.core.weighted and
xarray.core.resample modules are no longer imported by
default. (PR6702)
- changes from version 2022.06.0rc0:
* This pre-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.
* Known Regressions
+ reset_coords(drop=True) does not create indexes (GH6607)
* New Features
+ The zarr backend is now able to read NCZarr. By Mattia Almansi.
+ Add a weighted quantile method to DatasetWeighted and
DataArrayWeighted (PR6059). By Christian Jauvin and David Huard.
+ Add a create_index=True parameter to Dataset.stack() and
DataArray.stack() so that the creation of multi-indexes is
optional (PR5692). By Benoît Bovy.
+ Multi-index levels are now accessible through their own, regular
coordinates instead of virtual coordinates (PR5692). By Benoît
Bovy.
+ Add a display_values_threshold option to control the total
number of array elements which trigger summarization rather than
full repr in (numpy) array detailed views of the html repr
(PR6400). By Benoît Bovy.
+ Allow passing chunks in kwargs form to Dataset.chunk(),
DataArray.chunk(), and Variable.chunk(). (PR6471) By Tom
Nicholas.
+ Add core.groupby.DatasetGroupBy.cumsum() and
core.groupby.DataArrayGroupBy.cumsum(). By Vladislav Skripniuk
and Deepak Cherian. (PR3147, PR6525, GH3141)
+ Expose inline_array kwarg from dask.array.from_array in
open_dataset(), Dataset.chunk(), DataArray.chunk(), and
Variable.chunk(). (PR6471)
+ Expose the inline_array kwarg from dask.array.from_array() in
open_dataset(), Dataset.chunk(), DataArray.chunk(), and
Variable.chunk(). (PR6471) By Tom Nicholas.
+ polyval() now supports Dataset and DataArray args of any shape,
is faster and requires less memory. (PR6548) By Michael Niklas.
+ Improved overall typing.
+ Dataset.to_dict() and DataArray.to_dict() may now optionally
include encoding attributes. (PR6635) By Joe Hamman.
+ Upload development versions to TestPyPI. By Justus Magin.
* Breaking changes
+ PyNIO support is now untested.
+ The Dataset and DataArray rename" methods do not implicitly add
or drop indexes. (PR5692). By Benoît Bovy.
+ Many arguments like keep_attrs, axis, and skipna are now keyword
only for all reduction operations like .mean. By Deepak Cherian,
Jimmy Westling.
+ Xarray’s ufuncs have been removed, now that they can be replaced
by numpy’s ufuncs in all supported versions of numpy. By
Maximilian Roos.
+ xr.polyval() now uses the coord argument directly instead of its
index coordinate. (PR6548) By Michael Niklas.
* Bug fixes
+ Dataset.to_zarr() now allows to write all attribute types
supported by zarr-python. By Mattia Almansi.
+ Set skipna=None for all quantile methods
(e.g. Dataset.quantile()) and ensure it skips missing values for
float dtypes (consistent with other methods). This should not
change the behavior (PR6303). By Mathias Hauser.
+ Many bugs fixed by the explicit indexes refactor, mainly related
to multi-index (virtual) coordinates. See the corresponding
pull-request on GitHub for more details. (PR5692). By Benoît
Bovy.
+ Fixed “unhashable type” error trying to read NetCDF file with
variable having its ‘units’ attribute not str
(e.g. numpy.ndarray) (GH6368). By Oleh Khoma.
+ Omit warning about specified dask chunks separating chunks on
disk when the underlying array is empty (e.g., because of an
empty dimension) (GH6401). By Joseph K Aicher.
+ Fixed the poor html repr performance on large multi-indexes
(PR6400). By Benoît Bovy.
+ Allow fancy indexing of duck dask arrays along multiple
dimensions. (PR6414) By Justus Magin.
+ In the API for backends, support dimensions that express their
preferred chunk sizes as a tuple of integers. (GH6333, PR6334)
By Stan West.
+ Fix bug in where() when passing non-xarray objects with
keep_attrs=True. (GH6444, PR6461) By Sam Levang.
+ Allow passing both other and drop=True arguments to
DataArray.where() and Dataset.where() (PR6466, PR6467). By
Michael Delgado.
+ Ensure dtype encoding attributes are not added or modified on
variables that contain datetime-like values prior to being
passed to xarray.conventions.decode_cf_variable() (GH6453,
PR6489). By Spencer Clark.
+ Dark themes are now properly detected in Furo-themed Sphinx
documents (GH6500, PR6501). By Kevin Paul.
+ Dataset.isel(), DataArray.isel() with drop=True works as
intended with scalar DataArray indexers. (GH6554, PR6579) By
Michael Niklas.
+ Fixed silent overflow issue when decoding times encoded with
32-bit and below unsigned integer data types (GH6589,
PR6598). By Spencer Clark.
+ Fixed .chunks loading lazy data (GH6538). By Deepak Cherian.
* Documentation
+ Revise the documentation for developers on specifying a
backend’s preferred chunk sizes. In particular, correct the
syntax and replace lists with tuples in the examples. (GH6333,
PR6334) By Stan West.
+ Mention that DataArray.rename() can rename coordinates. (GH5458,
PR6665) By Michael Niklas.
+ Added examples to Dataset.thin() and DataArray.thin() By Emma
Marshall.
* Performance
+ GroupBy binary operations are now vectorized. Previously this
involved looping over all groups. (GH5804, PR6160) 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 the old
algorithm. (GH4473, GH4498, GH659, GH2237, PR271). By Deepak
Cherian, Anderson Banihirwe, Jimmy Westling.
* Internal Changes
+ Many internal changes due to the explicit indexes refactor. See
the corresponding pull-request on GitHub for more
details. (PR5692). By Benoît Bovy.
* Fri Mar 04 2022 Sebastian Wagner <sebix+novell.com@sebix.at>
- - update to version 2022.03.0:
- This release brings a number of small improvements, as well as a move to `calendar versioning <https://calver.org/>`_ (:issue:`6176`).:
- Many thanks to the 16 contributors to the v2022.02.0 release!:
- Aaron Spring, Alan D. Snow, Anderson Banihirwe, crusaderky, Illviljan, Joe Hamman, Jonas Gliß,:
- Lukas Pilz, Martin Bergemann, Mathias Hauser, Maximilian Roos, Romain Caneill, Stan West, Stijn Van Hoey,:
- Tobias Kölling, and Tom Nicholas.:
- New Features:
- Enabled multiplying tick offsets by floats. Allows ``float`` ``n`` in
:py:meth:`CFTimeIndex.shift` if ``shift_freq`` is between ``Day``
and ``Microsecond``. (:issue:`6134`, :pull:`6135`).
By `Aaron Spring <https://github.com/aaronspring>`_.
- Enbable to provide more keyword arguments to `pydap` backend when reading
OpenDAP datasets (:issue:`6274`).
By `Jonas Gliß <https://github.com/jgliss>`.
- Allow :py:meth:`DataArray.drop_duplicates` to drop duplicates along multiple dimensions at once,
and add :py:meth:`Dataset.drop_duplicates`. (:pull:`6307`)
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Breaking changes:
- Renamed the ``interpolation`` keyword of all ``quantile`` methods (e.g. :py:meth:`DataArray.quantile`)
to ``method`` for consistency with numpy v1.22.0 (:pull:`6108`).
By `Mathias Hauser <https://github.com/mathause>`_.
- Deprecations:
- Bug fixes:
- Variables which are chunked using dask in larger (but aligned) chunks than the target zarr chunk size
can now be stored using `to_zarr()` (:pull:`6258`) By `Tobias Kölling <https://github.com/d70-t>`_.
- Multi-file datasets containing encoded :py:class:`cftime.datetime` objects can be read in parallel again (:issue:`6226`, :pull:`6249`, :pull:`6305`). By `Martin Bergemann <https://github.com/antarcticrainforest>`_ and `Stan West <https://github.com/stanwest>`_.
- Documentation:
- Delete files of datasets saved to disk while building the documentation and enable
building on Windows via `sphinx-build` (:pull:`6237`).
By `Stan West <https://github.com/stanwest>`_.
- Internal Changes:
- update to version 0.21.1:
- This is a bugfix release to resolve (:issue:`6216`, :pull:`6207`).:
- Bug fixes:
- Add `packaging` as a dependency to Xarray (:issue:`6216`, :pull:`6207`).
By `Sebastian Weigand <https://github.com/s-weigand>`_ and `Joe Hamman <https://github.com/jhamman>`_.
* Wed Feb 02 2022 Sebastian Wagner <sebix+novell.com@sebix.at>
- - update to version 0.21.1:
- This is a bugfix release to resolve (:issue:`6216`, :pull:`6207`).:
- Bug fixes:
- Add `packaging` as a dependency to Xarray (:issue:`6216`, :pull:`6207`).
By `Sebastian Weigand <https://github.com/s-weigand>`_ and `Joe Hamman <https://github.com/jhamman>`_.
* Sat Jan 29 2022 Sebastian Wagner <sebix+novell.com@sebix.at>
- update to version 0.21.0:
- Many thanks to the 20 contributors to the v0.21.0 release!:
- Abel Aoun, Anderson Banihirwe, Ant Gib, Chris Roat, Cindy Chiao,:
- Deepak Cherian, Dominik Stańczak, Fabian Hofmann, Illviljan, Jody Klymak, Joseph:
- K Aicher, Mark Harfouche, Mathias Hauser, Matthew Roeschke, Maximilian Roos,:
- Michael Delgado, Pascal Bourgault, Pierre, Ray Bell, Romain Caneill, Tim Heap,:
- Tom Nicholas, Zeb Nicholls, joseph nowak, keewis.:
- New Features:
- New top-level function :py:func:`cross`. (:issue:`3279`, :pull:`5365`).
By `Jimmy Westling <https://github.com/illviljan>`_.
- ``keep_attrs`` support for :py:func:`where` (:issue:`4141`, :issue:`4682`, :pull:`4687`).
By `Justus Magin <https://github.com/keewis>`_.
- Enable the limit option for dask array in the following methods :py:meth:`DataArray.ffill`, :py:meth:`DataArray.bfill`, :py:meth:`Dataset.ffill` and :py:meth:`Dataset.bfill` (:issue:`6112`)
By `Joseph Nowak <https://github.com/josephnowak>`_.
- Breaking changes:
- Rely on matplotlib's default datetime converters instead of pandas' (:issue:`6102`, :pull:`6109`).
By `Jimmy Westling <https://github.com/illviljan>`_.
- Improve repr readability when there are a large number of dimensions in datasets or dataarrays by
wrapping the text once the maximum display width has been exceeded. (:issue:`5546`, :pull:`5662`)
By `Jimmy Westling <https://github.com/illviljan>`_.
- Deprecations:
- Removed the lock kwarg from the zarr and pydap backends, completing the deprecation cycle started in :issue:`5256`.
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Support for ``python 3.7`` has been dropped. (:pull:`5892`)
By `Jimmy Westling <https://github.com/illviljan>`_.
- Bug fixes:
- Preserve chunks when creating a :py:class:`DataArray` from another :py:class:`DataArray`
(:pull:`5984`). By `Fabian Hofmann <https://github.com/FabianHofmann>`_.
- Properly support :py:meth:`DataArray.ffill`, :py:meth:`DataArray.bfill`, :py:meth:`Dataset.ffill` and :py:meth:`Dataset.bfill` along chunked dimensions (:issue:`6112`).
By `Joseph Nowak <https://github.com/josephnowak>`_.
- Subclasses of ``byte`` and ``str`` (e.g. ``np.str_`` and ``np.bytes_``) will now serialise to disk rather than raising a ``ValueError: unsupported dtype for netCDF4 variable: object`` as they did previously (:pull:`5264`).
By `Zeb Nicholls <https://github.com/znicholls>`_.
- Fix applying function with non-xarray arguments using :py:func:`xr.map_blocks`.
By `Cindy Chiao <https://github.com/tcchiao>`_.
- No longer raise an error for an all-nan-but-one argument to
:py:meth:`DataArray.interpolate_na` when using `method='nearest'` (:issue:`5994`, :pull:`6144`).
By `Michael Delgado <https://github.com/delgadom>`_.
- `dt.season <https://xarray.pydata.org/en/stable/generated/xarray.DataArray.dt.season.html>`_ can now handle NaN and NaT. (:pull:`5876`).
By `Pierre Loicq <https://github.com/pierreloicq>`_.
- Determination of zarr chunks handles empty lists for encoding chunks or variable chunks that occurs in certain cirumstances (:pull:`5526`). By `Chris Roat <https://github.com/chrisroat>`_.
- Internal Changes:
- Replace ``distutils.version`` with ``packaging.version`` (:issue:`6092`).
By `Mathias Hauser <https://github.com/mathause>`_.
- Removed internal checks for ``pd.Panel`` (:issue:`6145`).
By `Matthew Roeschke <https://github.com/mroeschke>`_.
- Add ``pyupgrade`` pre-commit hook (:pull:`6152`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
* Mon Jan 24 2022 Ben Greiner <code@bnavigator.de>
- Don't test with dask and distributed in python310: not supported
yet
* Fri Dec 10 2021 Sebastian Wagner <sebix+novell.com@sebix.at>
- update to version 0.20.2:
- This is a bugfix release to resolve (:issue:`3391`, :issue:`5715`). It also:
- includes performance improvements in unstacking to a ``sparse`` array and a:
- number of documentation improvements.:
- Many thanks to the 20 contributors:
- Aaron Spring, Alexandre Poux, Deepak Cherian, Enrico Minack, Fabien Maussion,:
- Giacomo Caria, Gijom, Guillaume Maze, Illviljan, Joe Hamman, Joseph Hardin, Kai:
- Mühlbauer, Matt Henderson, Maximilian Roos, Michael Delgado, Robert Gieseke,:
- Sebastian Weigand and Stephan Hoyer.:
- Breaking changes:
- Use complex nan when interpolating complex values out of bounds by default (instead of real nan) (:pull:`6019`).
By `Alexandre Poux <https://github.com/pums974>`_.
- Performance:
- Significantly faster unstacking to a ``sparse`` array. :pull:`5577`
By `Deepak Cherian <https://github.com/dcherian>`_.
- Bug fixes:
- :py:func:`xr.map_blocks` and :py:func:`xr.corr` now work when dask is not installed (:issue:`3391`, :issue:`5715`, :pull:`5731`).
By `Gijom <https://github.com/Gijom>`_.
- Fix plot.line crash for data of shape ``(1, N)`` in _title_for_slice on format_item (:pull:`5948`).
By `Sebastian Weigand <https://github.com/s-weigand>`_.
- Fix a regression in the removal of duplicate backend entrypoints (:issue:`5944`, :pull:`5959`)
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
- Documentation:
- Better examples in docstrings for groupby and resampling reductions (:pull:`5871`).
By `Deepak Cherian <https://github.com/dcherian>`_,
`Maximilian Roos <https://github.com/max-sixty>`_,
`Jimmy Westling <https://github.com/illviljan>`_ .
- Internal Changes:
- Use ``importlib`` to replace functionality of ``pkg_resources`` in
backend plugins tests. (:pull:`5959`).
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
* Mon Nov 15 2021 Sebastian Wagner <sebix+novell.com@sebix.at>
- update to version 0.20.1:
- This is a bugfix release to fix :issue:`5930`.:
- Bug fixes:
- Fix a regression in the detection of the backend entrypoints (:issue:`5930`, :pull:`5931`)
By `Justus Magin <https://github.com/keewis>`_.
- Documentation:
- Significant improvements to :ref:`api`. By `Deepak Cherian <https://github.com/dcherian>`_.
* Tue Nov 02 2021 Sebastian Wagner <sebix+novell.com@sebix.at>
- update to version 0.20.0:
- This release brings improved support for pint arrays, methods for weighted standard deviation, variance,:
- and sum of squares, the option to disable the use of the bottleneck library, significantly improved performance of:
- unstack, as well as many bugfixes and internal changes.:
- Many thanks to the 38 contributors to this release!:
- Aaron Spring, Akio Taniguchi, Alan D. Snow, arfy slowy, Benoit Bovy, Christian Jauvin, crusaderky, Deepak Cherian,:
- Giacomo Caria, Illviljan, James Bourbeau, Joe Hamman, Joseph K Aicher, Julien Herzen, Kai Mühlbauer,:
- keewis, lusewell, Martin K. Scherer, Mathias Hauser, Max Grover, Maxime Liquet, Maximilian Roos, Mike Taves, pmav99,:
- Pushkar Kopparla, Ray Bell, Rio McMahon, Scott Staniewicz, Spencer Clark, Stefan Bender, Taher Chegini, Thomas Nicholas,:
- Tomas Chor, Tom Augspurger, Victor Negîrneac, Zachary Moon, and Zeb Nicholls.:
- New Features:
- Add ``std``, ``var``, ``sum_of_squares`` to :py:class:`~core.weighted.DatasetWeighted` and :py:class:`~core.weighted.DataArrayWeighted`.
By `Christian Jauvin <https://github.com/cjauvin>`_.
- Added a :py:func:`get_options` method to xarray's root namespace (:issue:`5698`, :pull:`5716`)
By `Pushkar Kopparla <https://github.com/pkopparla>`_.
- Xarray now does a better job rendering variable names that are long LaTeX sequences when plotting (:issue:`5681`, :pull:`5682`).
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`).
By `Pushkar Kopparla <https://github.com/pkopparla>`_.
- Added ``storage_options`` argument to :py:meth:`to_zarr` (:issue:`5601`).
By `Ray Bell <https://github.com/raybellwaves>`_, `Zachary Blackwood <https://github.com/blackary>`_ and
`Nathan Lis <https://github.com/wxman22>`_.
- Histogram plots are set with a title displaying the scalar coords if any, similarly to the other plots (:issue:`5791`, :pull:`5792`).
By `Maxime Liquet <https://github.com/maximlt>`_.
- Slice plots display the coords units in the same way as x/y/colorbar labels (:pull:`5847`).
By `Victor Negîrneac <https://github.com/caenrigen>`_.
- Added a new :py:attr:`Dataset.chunksizes`, :py:attr:`DataArray.chunksizes`, and :py:attr:`Variable.chunksizes`
property, which will always return a mapping from dimension names to chunking pattern along that dimension,
regardless of whether the object is a Dataset, DataArray, or Variable. (:issue:`5846`, :pull:`5900`)
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Breaking changes:
- The minimum versions of some dependencies were changed:
=============== ====== ====
Package Old New
=============== ====== ====
cftime 1.1 1.2
dask 2.15 2.30
distributed 2.15 2.30
lxml 4.5 4.6
matplotlib-base 3.2 3.3
numba 0.49 0.51
numpy 1.17 1.18
pandas 1.0 1.1
pint 0.15 0.16
scipy 1.4 1.5
seaborn 0.10 0.11
sparse 0.8 0.11
toolz 0.10 0.11
zarr 2.4 2.5
=============== ====== ====
- The ``__repr__`` of a :py:class:`xarray.Dataset`'s ``coords`` and ``data_vars``
ignore ``xarray.set_option(display_max_rows=...)`` and show the full output
when called directly as, e.g., ``ds.data_vars`` or ``print(ds.data_vars)``
(:issue:`5545`, :pull:`5580`).
By `Stefan Bender <https://github.com/st-bender>`_.
- Deprecations:
- Deprecate :py:func:`open_rasterio` (:issue:`4697`, :pull:`5808`).
By `Alan Snow <https://github.com/snowman2>`_.
- Set the default argument for `roll_coords` to `False` for :py:meth:`DataArray.roll`
and :py:meth:`Dataset.roll`. (:pull:`5653`)
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- :py:meth:`xarray.open_mfdataset` will now error instead of warn when a value for ``concat_dim`` is
passed alongside ``combine='by_coords'``.
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Bug fixes:
- Fix ZeroDivisionError from saving dask array with empty dimension (:issue: `5741`).
By `Joseph K Aicher <https://github.com/jaicher>`_.
- Fixed performance bug where ``cftime`` import attempted within various core operations if ``cftime`` not
installed (:pull:`5640`).
By `Luke Sewell <https://github.com/lusewell>`_
- Fixed bug when combining named DataArrays using :py:func:`combine_by_coords`. (:pull:`5834`).
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- When a custom engine was used in :py:func:`~xarray.open_dataset` the engine
wasn't initialized properly, causing missing argument errors or inconsistent
method signatures. (:pull:`5684`)
By `Jimmy Westling <https://github.com/illviljan>`_.
- Numbers are properly formatted in a plot's title (:issue:`5788`, :pull:`5789`).
By `Maxime Liquet <https://github.com/maximlt>`_.
- Faceted plots will no longer raise a `pint.UnitStrippedWarning` when a `pint.Quantity` array is plotted,
and will correctly display the units of the data in the colorbar (if there is one) (:pull:`5886`).
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- With backends, check for path-like objects rather than ``pathlib.Path``
type, use ``os.fspath`` (:pull:`5879`).
By `Mike Taves <https://github.com/mwtoews>`_.
- ``open_mfdataset()`` now accepts a single ``pathlib.Path`` object (:issue: `5881`).
By `Panos Mavrogiorgos <https://github.com/pmav99>`_.
- Improved performance of :py:meth:`Dataset.unstack` (:pull:`5906`). By `Tom Augspurger <https://github.com/TomAugspurger>`_.
- Documentation:
- Users are instructed to try ``use_cftime=True`` if a ``TypeError`` occurs when combining datasets and one of the types involved is a subclass of ``cftime.datetime`` (:pull:`5776`).
By `Zeb Nicholls <https://github.com/znicholls>`_.
- A clearer error is now raised if a user attempts to assign a Dataset to a single key of
another Dataset. (:pull:`5839`)
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Internal Changes:
- Explicit indexes refactor: avoid ``len(index)`` in ``map_blocks`` (:pull:`5670`).
By `Deepak Cherian <https://github.com/dcherian>`_.
- Explicit indexes refactor: decouple ``xarray.Index``` from ``xarray.Variable`` (:pull:`5636`).
By `Benoit Bovy <https://github.com/benbovy>`_.
- Fix ``Mapping`` argument typing to allow mypy to pass on ``str`` keys (:pull:`5690`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Annotate many of our tests, and fix some of the resulting typing errors. This will
also mean our typing annotations are tested as part of CI. (:pull:`5728`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Improve the performance of reprs for large datasets or dataarrays. (:pull:`5661`)
By `Jimmy Westling <https://github.com/illviljan>`_.
- Use isort's `float_to_top` config. (:pull:`5695`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Remove use of the deprecated ``kind`` argument in
:py:meth:`pandas.Index.get_slice_bound` inside :py:class:`xarray.CFTimeIndex`
tests (:pull:`5723`). By `Spencer Clark <https://github.com/spencerkclark>`_.
- Refactor `xarray.core.duck_array_ops` to no longer special-case dispatching to
dask versions of functions when acting on dask arrays, instead relying numpy
and dask's adherence to NEP-18 to dispatch automatically. (:pull:`5571`)
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Add an ASV benchmark CI and improve performance of the benchmarks (:pull:`5796`)
By `Jimmy Westling <https://github.com/illviljan>`_.
- Use ``importlib`` to replace functionality of ``pkg_resources`` such
as version setting and loading of resources. (:pull:`5845`).
By `Martin K. Scherer <https://github.com/marscher>`_.
* Tue Sep 21 2021 Ben Greiner <code@bnavigator.de>
- Tests require dask[diagnostics] extra now (for Jinja2)
* Tue Jul 27 2021 Sebastian Wagner <sebix+novell.com@sebix.at>
- remove xarray-pr5449-dask-meta.patch, merged upstream.
- remove test_resample_loffset.patch, merged upstream.
- update to version 0.19.0:
- This release brings improvements to plotting of categorical data, the ability to specify how attributes:
- are combined in xarray operations, a new high-level :py:func:`unify_chunks` function, as well as various:
- deprecations, bug fixes, and minor improvements.:
- Many thanks to the 29 contributors to this release!:
- Andrew Williams, Augustus, Aureliana Barghini, Benoit Bovy, crusaderky, Deepak Cherian, ellesmith88,:
- Elliott Sales de Andrade, Giacomo Caria, github-actions[bot], Illviljan, Joeperdefloep, joooeey, Julia Kent,:
- Julius Busecke, keewis, Mathias Hauser, Matthias Göbel, Mattia Almansi, Maximilian Roos, Peter Andreas Entschev,:
- Ray Bell, Sander, Santiago Soler, Sebastian, Spencer Clark, Stephan Hoyer, Thomas Hirtz, Thomas Nicholas.:
- New Features:
- Allow passing argument ``missing_dims`` to :py:meth:`Variable.transpose` and :py:meth:`Dataset.transpose`
(:issue:`5550`, :pull:`5586`)
By `Giacomo Caria <https://github.com/gcaria>`_.
- Allow passing a dictionary as coords to a :py:class:`DataArray` (:issue:`5527`,
reverts :pull:`1539`, which had deprecated this due to python's inconsistent ordering in earlier versions).
By `Sander van Rijn <https://github.com/sjvrijn>`_.
- Added :py:meth:`Dataset.coarsen.construct`, :py:meth:`DataArray.coarsen.construct` (:issue:`5454`, :pull:`5475`).
By `Deepak Cherian <https://github.com/dcherian>`_.
- Xarray now uses consolidated metadata by default when writing and reading Zarr
stores (:issue:`5251`).
By `Stephan Hoyer <https://github.com/shoyer>`_.
- New top-level function :py:func:`unify_chunks`.
By `Mattia Almansi <https://github.com/malmans2>`_.
- Allow assigning values to a subset of a dataset using positional or label-based
indexing (:issue:`3015`, :pull:`5362`).
By `Matthias Göbel <https://github.com/matzegoebel>`_.
- Attempting to reduce a weighted object over missing dimensions now raises an error (:pull:`5362`).
By `Mattia Almansi <https://github.com/malmans2>`_.
- Add ``.sum`` to :py:meth:`~xarray.DataArray.rolling_exp` and
:py:meth:`~xarray.Dataset.rolling_exp` for exponentially weighted rolling
sums. These require numbagg 0.2.1;
(:pull:`5178`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- :py:func:`xarray.cov` and :py:func:`xarray.corr` now lazily check for missing
values if inputs are dask arrays (:issue:`4804`, :pull:`5284`).
By `Andrew Williams <https://github.com/AndrewWilliams3142>`_.
- Attempting to ``concat`` list of elements that are not all ``Dataset`` or all ``DataArray`` now raises an error (:issue:`5051`, :pull:`5425`).
By `Thomas Hirtz <https://github.com/thomashirtz>`_.
- allow passing a function to ``combine_attrs`` (:pull:`4896`).
By `Justus Magin <https://github.com/keewis>`_.
- Allow plotting categorical data (:pull:`5464`).
By `Jimmy Westling <https://github.com/illviljan>`_.
- Allow removal of the coordinate attribute ``coordinates`` on variables by setting ``.attrs['coordinates']= None``
(:issue:`5510`).
By `Elle Smith <https://github.com/ellesmith88>`_.
- Added :py:meth:`DataArray.to_numpy`, :py:meth:`DataArray.as_numpy`, and :py:meth:`Dataset.as_numpy`. (:pull:`5568`).
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Units in plot labels are now automatically inferred from wrapped :py:meth:`pint.Quantity` arrays. (:pull:`5561`).
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Breaking changes:
- The default ``mode`` for :py:meth:`Dataset.to_zarr` when ``region`` is set
has changed to the new ``mode="r+"``, which only allows for overriding
pre-existing array values. This is a safer default than the prior ``mode="a"``,
and allows for higher performance writes (:pull:`5252`).
By `Stephan Hoyer <https://github.com/shoyer>`_.
- The main parameter to :py:func:`combine_by_coords` is renamed to `data_objects` instead
of `datasets` so anyone calling this method using a named parameter will need to update
the name accordingly (:issue:`3248`, :pull:`4696`).
By `Augustus Ijams <https://github.com/aijams>`_.
- Deprecations:
- Removed the deprecated ``dim`` kwarg to :py:func:`DataArray.integrate` (:pull:`5630`)
- Removed the deprecated ``keep_attrs`` kwarg to :py:func:`DataArray.rolling` (:pull:`5630`)
- Removed the deprecated ``keep_attrs`` kwarg to :py:func:`DataArray.coarsen` (:pull:`5630`)
- Completed deprecation of passing an ``xarray.DataArray`` to :py:func:`Variable` - will now raise a ``TypeError`` (:pull:`5630`)
- Bug fixes:
- Fix a minor incompatibility between partial datetime string indexing with a
:py:class:`CFTimeIndex` and upcoming pandas version 1.3.0 (:issue:`5356`,
:pull:`5359`).
By `Spencer Clark <https://github.com/spencerkclark>`_.
- Fix 1-level multi-index incorrectly converted to single index (:issue:`5384`,
:pull:`5385`).
By `Benoit Bovy <https://github.com/benbovy>`_.
- Don't cast a duck array in a coordinate to :py:class:`numpy.ndarray` in
:py:meth:`DataArray.differentiate` (:pull:`5408`)
By `Justus Magin <https://github.com/keewis>`_.
- Fix the ``repr`` of :py:class:`Variable` objects with ``display_expand_data=True``
(:pull:`5406`)
By `Justus Magin <https://github.com/keewis>`_.
- Plotting a pcolormesh with ``xscale="log"`` and/or ``yscale="log"`` works as
expected after improving the way the interval breaks are generated (:issue:`5333`).
By `Santiago Soler <https://github.com/santisoler>`_
- :py:func:`combine_by_coords` can now handle combining a list of unnamed
``DataArray`` as input (:issue:`3248`, :pull:`4696`).
By `Augustus Ijams <https://github.com/aijams>`_.
- Internal Changes:
- Run CI on the first & last python versions supported only; currently 3.7 & 3.9.
(:pull:`5433`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Publish test results & timings on each PR.
(:pull:`5537`)
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Explicit indexes refactor: add a ``xarray.Index.query()`` method in which
one may eventually provide a custom implementation of label-based data
selection (not ready yet for public use). Also refactor the internal,
pandas-specific implementation into ``PandasIndex.query()`` and
``PandasMultiIndex.query()`` (:pull:`5322`).
By `Benoit Bovy <https://github.com/benbovy>`_.
* Fri Jul 16 2021 Ben Greiner <code@bnavigator.de>
- Add xarray-pr5449-dask-meta.patch in order to support updated
dask -- gh#pydata/xarray#5449
* Tue May 25 2021 Matej Cepl <mcepl@suse.com>
- Add local_dataset.patch allowing the use of the cached datasets
(gh#pydata/xarray#5377).
- Add scipy-interpolate.patch adding a missing import
scipy.interpolate to test_interp.py (gh#pydata/xarray#5375).
- Add test_resample_loffset.patch to fix test_resample_loffset
test (gh#pydata/xarray#5364).
* Thu May 20 2021 Sebastian Wagner <sebix+novell.com@sebix.at>
- update to version 0.18.2:
- This release reverts a regression in xarray's unstacking of dask-backed arrays.:
- remove fix_test_resample_loffset.patch, doesn't work
* Wed May 19 2021 Sebastian Wagner <sebix+novell.com@sebix.at>
- add fix_test_resample_loffset.patch to fix test fail on i586
https://github.com/pydata/xarray/issues/5341
* Wed May 19 2021 Sebastian Wagner <sebix+novell.com@sebix.at>
- update to version 0.18.1:
- This release is intended as a small patch release to be compatible with the new:
2021.5.0 ``dask.distributed`` release. It also includes a new
``drop_duplicates`` method, some documentation improvements, the beginnings of
- our internal Index refactoring, and some bug fixes.:
- Thank you to all 16 contributors!:
- Anderson Banihirwe, Andrew, Benoit Bovy, Brewster Malevich, Giacomo Caria,:
- Illviljan, James Bourbeau, Keewis, Maximilian Roos, Ravin Kumar, Stephan Hoyer,:
- Thomas Nicholas, Tom Nicholas, Zachary Moon.:
- New Features:
- Implement :py:meth:`DataArray.drop_duplicates`
to remove duplicate dimension values (:pull:`5239`).
By `Andrew Huang <https://github.com/ahuang11>`_.
- Allow passing ``combine_attrs`` strategy names to the ``keep_attrs`` parameter of
:py:func:`apply_ufunc` (:pull:`5041`)
By `Justus Magin <https://github.com/keewis>`_.
- :py:meth:`Dataset.interp` now allows interpolation with non-numerical datatypes,
such as booleans, instead of dropping them. (:issue:`4761` :pull:`5008`).
By `Jimmy Westling <https://github.com/illviljan>`_.
- Raise more informative error when decoding time variables with invalid reference dates.
(:issue:`5199`, :pull:`5288`). By `Giacomo Caria <https://github.com/gcaria>`_.
- Bug fixes:
- Opening netCDF files from a path that doesn't end in ``.nc`` without supplying
an explicit ``engine`` works again (:issue:`5295`), fixing a bug introduced in
0.18.0.
By `Stephan Hoyer <https://github.com/shoyer>`_
- Documentation:
- Clean up and enhance docstrings for the :py:class:`DataArray.plot` and ``Dataset.plot.*``
families of methods (:pull:`5285`).
By `Zach Moon <https://github.com/zmoon>`_.
- Explanation of deprecation cycles and how to implement them added to contributors
guide. (:pull:`5289`)
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Internal Changes:
- Explicit indexes refactor: add an ``xarray.Index`` base class and
``Dataset.xindexes`` / ``DataArray.xindexes`` properties. Also rename
``PandasIndexAdapter`` to ``PandasIndex``, which now inherits from
``xarray.Index`` (:pull:`5102`).
By `Benoit Bovy <https://github.com/benbovy>`_.
- Updated the release guide for developers. Now accounts for actions that are automated via github
actions. (:pull:`5274`).
By `Tom Nicholas <https://github.com/TomNicholas>`_.
* Sun May 09 2021 Sebastian Wagner <sebix+novell.com@sebix.at>
- update to version 0.18.0:
- This release brings a few important performance improvements, a wide range of:
- usability upgrades, lots of bug fixes, and some new features. These include:
- a plugin API to add backend engines, a new theme for the documentation,:
- curve fitting methods, and several new plotting functions.:
- Many thanks to the 38 contributors to this release: Aaron Spring, Alessandro Amici,:
- Alex Marandon, Alistair Miles, Ana Paula Krelling, Anderson Banihirwe, Aureliana Barghini,:
- Baudouin Raoult, Benoit Bovy, Blair Bonnett, David Trémouilles, Deepak Cherian,:
- Gabriel Medeiros Abrahão, Giacomo Caria, Hauke Schulz, Illviljan, Mathias Hauser, Matthias Bussonnier,:
- Mattia Almansi, Maximilian Roos, Ray Bell, Richard Kleijn, Ryan Abernathey, Sam Levang, Spencer Clark,:
- Spencer Jones, Tammas Loughran, Tobias Kölling, Todd, Tom Nicholas, Tom White, Victor Negîrneac,:
- Xianxiang Li, Zeb Nicholls, crusaderky, dschwoerer, johnomotani, keewis:
- New Features:
- apply ``combine_attrs`` on data variables and coordinate variables when concatenating
and merging datasets and dataarrays (:pull:`4902`).
By `Justus Magin <https://github.com/keewis>`_.
- Add :py:meth:`Dataset.to_pandas` (:pull:`5247`)
By `Giacomo Caria <https://github.com/gcaria>`_.
- Add :py:meth:`DataArray.plot.surface` which wraps matplotlib's `plot_surface` to make
surface plots (:issue:`2235` :issue:`5084` :pull:`5101`).
By `John Omotani <https://github.com/johnomotani>`_.
- Allow passing multiple arrays to :py:meth:`Dataset.__setitem__` (:pull:`5216`).
By `Giacomo Caria <https://github.com/gcaria>`_.
- Add 'cumulative' option to :py:meth:`Dataset.integrate` and
:py:meth:`DataArray.integrate` so that result is a cumulative integral, like
:py:func:`scipy.integrate.cumulative_trapezoidal` (:pull:`5153`).
By `John Omotani <https://github.com/johnomotani>`_.
- Add ``safe_chunks`` option to :py:meth:`Dataset.to_zarr` which allows overriding
checks made to ensure Dask and Zarr chunk compatibility (:issue:`5056`).
By `Ryan Abernathey <https://github.com/rabernat>`_
- Add :py:meth:`Dataset.query` and :py:meth:`DataArray.query` which enable indexing
of datasets and data arrays by evaluating query expressions against the values of the
data variables (:pull:`4984`).
By `Alistair Miles <https://github.com/alimanfoo>`_.
- Allow passing ``combine_attrs`` to :py:meth:`Dataset.merge` (:pull:`4895`).
By `Justus Magin <https://github.com/keewis>`_.
- Support for `dask.graph_manipulation
<https://docs.dask.org/en/latest/graph_manipulation.html>`_ (requires dask >=2021.3)
By `Guido Imperiale <https://github.com/crusaderky>`_
- Add :py:meth:`Dataset.plot.streamplot` for streamplot plots with :py:class:`Dataset`
variables (:pull:`5003`).
By `John Omotani <https://github.com/johnomotani>`_.
- Many of the arguments for the :py:attr:`DataArray.str` methods now support
providing an array-like input. In this case, the array provided to the
arguments is broadcast against the original array and applied elementwise.
- :py:attr:`DataArray.str` now supports ``+``, ``*``, and ``%`` operators. These
behave the same as they do for :py:class:`str`, except that they follow
array broadcasting rules.
- A large number of new :py:attr:`DataArray.str` methods were implemented,
:py:meth:`DataArray.str.casefold`, :py:meth:`DataArray.str.cat`,
:py:meth:`DataArray.str.extract`, :py:meth:`DataArray.str.extractall`,
:py:meth:`DataArray.str.findall`, :py:meth:`DataArray.str.format`,
:py:meth:`DataArray.str.get_dummies`, :py:meth:`DataArray.str.islower`,
:py:meth:`DataArray.str.join`, :py:meth:`DataArray.str.normalize`,
:py:meth:`DataArray.str.partition`, :py:meth:`DataArray.str.rpartition`,
:py:meth:`DataArray.str.rsplit`, and :py:meth:`DataArray.str.split`.
A number of these methods allow for splitting or joining the strings in an
array. (:issue:`4622`)
By `Todd Jennings <https://github.com/toddrjen>`_
- Thanks to the new pluggable backend infrastructure external packages may now
use the ``xarray.backends`` entry point to register additional engines to be used in
:py:func:`open_dataset`, see the documentation in :ref:`add_a_backend`
(:issue:`4309`, :issue:`4803`, :pull:`4989`, :pull:`4810` and many others).
The backend refactor has been sponsored with the "Essential Open Source Software for Science"
grant from the `Chan Zuckerberg Initiative <https://chanzuckerberg.com>`_ and
developed by `B-Open <https://www.bopen.eu>`_.
By `Aureliana Barghini <https://github.com/aurghs>`_ and `Alessandro Amici <https://github.com/alexamici>`_.
- :py:attr:`~core.accessor_dt.DatetimeAccessor.date` added (:issue:`4983`, :pull:`4994`).
By `Hauke Schulz <https://github.com/observingClouds>`_.
- Implement ``__getitem__`` for both :py:class:`~core.groupby.DatasetGroupBy` and
:py:class:`~core.groupby.DataArrayGroupBy`, inspired by pandas'
:py:meth:`~pandas.core.groupby.GroupBy.get_group`.
By `Deepak Cherian <https://github.com/dcherian>`_.
- Switch the tutorial functions to use `pooch <https://github.com/fatiando/pooch>`_
(which is now a optional dependency) and add :py:func:`tutorial.open_rasterio` as a
way to open example rasterio files (:issue:`3986`, :pull:`4102`, :pull:`5074`).
By `Justus Magin <https://github.com/keewis>`_.
- Add typing information to unary and binary arithmetic operators operating on
:py:class:`Dataset`, :py:class:`DataArray`, :py:class:`Variable`,
:py:class:`~core.groupby.DatasetGroupBy` or
:py:class:`~core.groupby.DataArrayGroupBy` (:pull:`4904`).
By `Richard Kleijn <https://github.com/rhkleijn>`_.
- Add a ``combine_attrs`` parameter to :py:func:`open_mfdataset` (:pull:`4971`).
By `Justus Magin <https://github.com/keewis>`_.
- Enable passing arrays with a subset of dimensions to
:py:meth:`DataArray.clip` & :py:meth:`Dataset.clip`; these methods now use
:py:func:`xarray.apply_ufunc`; (:pull:`5184`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Disable the `cfgrib` backend if the `eccodes` library is not installed (:pull:`5083`).
By `Baudouin Raoult <https://github.com/b8raoult>`_.
- Added :py:meth:`DataArray.curvefit` and :py:meth:`Dataset.curvefit` for general curve fitting applications. (:issue:`4300`, :pull:`4849`)
By `Sam Levang <https://github.com/slevang>`_.
- Add options to control expand/collapse of sections in display of Dataset and
DataArray. The function :py:func:`set_options` now takes keyword aguments
``display_expand_attrs``, ``display_expand_coords``, ``display_expand_data``,
``display_expand_data_vars``, all of which can be one of ``True`` to always
expand, ``False`` to always collapse, or ``default`` to expand unless over a
pre-defined limit (:pull:`5126`).
By `Tom White <https://github.com/tomwhite>`_.
- Significant speedups in :py:meth:`Dataset.interp` and :py:meth:`DataArray.interp`.
(:issue:`4739`, :pull:`4740`).
By `Deepak Cherian <https://github.com/dcherian>`_.
- Prevent passing `concat_dim` to :py:func:`xarray.open_mfdataset` when
`combine='by_coords'` is specified, which should never have been possible (as
:py:func:`xarray.combine_by_coords` has no `concat_dim` argument to pass to).
Also removes unneeded internal reordering of datasets in
:py:func:`xarray.open_mfdataset` when `combine='by_coords'` is specified.
Fixes (:issue:`5230`).
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Implement ``__setitem__`` for ``xarray.core.indexing.DaskIndexingAdapter`` if
dask version supports item assignment. (:issue:`5171`, :pull:`5174`)
By `Tammas Loughran <https://github.com/tammasloughran>`_.
- Breaking changes:
- The minimum versions of some dependencies were changed:
============ ====== ====
Package Old New
============ ====== ====
boto3 1.12 1.13
cftime 1.0 1.1
dask 2.11 2.15
distributed 2.11 2.15
matplotlib 3.1 3.2
numba 0.48 0.49
============ ====== ====
- :py:func:`open_dataset` and :py:func:`open_dataarray` now accept only the first argument
as positional, all others need to be passed are keyword arguments. This is part of the
refactor to support external backends (:issue:`4309`, :pull:`4989`).
By `Alessandro Amici <https://github.com/alexamici>`_.
- Functions that are identities for 0d data return the unchanged data
if axis is empty. This ensures that Datasets where some variables do
not have the averaged dimensions are not accidentially changed
(:issue:`4885`, :pull:`5207`).
By `David Schwörer <https://github.com/dschwoerer>`_.
- :py:attr:`DataArray.coarsen` and :py:attr:`Dataset.coarsen` no longer support passing ``keep_attrs``
via its constructor. Pass ``keep_attrs`` via the applied function, i.e. use
``ds.coarsen(...).mean(keep_attrs=False)`` instead of ``ds.coarsen(..., keep_attrs=False).mean()``.
Further, coarsen now keeps attributes per default (:pull:`5227`).
By `Mathias Hauser <https://github.com/mathause>`_.
- switch the default of the :py:func:`merge` ``combine_attrs`` parameter to
``"override"``. This will keep the current behavior for merging the ``attrs`` of
variables but stop dropping the ``attrs`` of the main objects (:pull:`4902`).
By `Justus Magin <https://github.com/keewis>`_.
- Deprecations:
- Warn when passing `concat_dim` to :py:func:`xarray.open_mfdataset` when
`combine='by_coords'` is specified, which should never have been possible (as
:py:func:`xarray.combine_by_coords` has no `concat_dim` argument to pass to).
Also removes unneeded internal reordering of datasets in
:py:func:`xarray.open_mfdataset` when `combine='by_coords'` is specified.
Fixes (:issue:`5230`), via (:pull:`5231`, :pull:`5255`).
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- The `lock` keyword argument to :py:func:`open_dataset` and :py:func:`open_dataarray` is now
a backend specific option. It will give a warning if passed to a backend that doesn't support it
instead of being silently ignored. From the next version it will raise an error.
This is part of the refactor to support external backends (:issue:`5073`).
By `Tom Nicholas <https://github.com/TomNicholas>`_ and `Alessandro Amici <https://github.com/alexamici>`_.
- Bug fixes:
- Properly support :py:meth:`DataArray.ffill`, :py:meth:`DataArray.bfill`, :py:meth:`Dataset.ffill`, :py:meth:`Dataset.bfill` along chunked dimensions.
(:issue:`2699`).
By `Deepak Cherian <https://github.com/dcherian>`_.
- Fix 2d plot failure for certain combinations of dimensions when `x` is 1d and `y` is
2d (:issue:`5097`, :pull:`5099`).
By `John Omotani <https://github.com/johnomotani>`_.
- Ensure standard calendar times encoded with large values (i.e. greater than
approximately 292 years), can be decoded correctly without silently overflowing
(:pull:`5050`). This was a regression in xarray 0.17.0.
By `Zeb Nicholls <https://github.com/znicholls>`_.
- Added support for `numpy.bool_` attributes in roundtrips using `h5netcdf` engine with `invalid_netcdf=True` [which casts `bool`s to `numpy.bool_`] (:issue:`4981`, :pull:`4986`).
By `Victor Negîrneac <https://github.com/caenrigen>`_.
- Don't allow passing ``axis`` to :py:meth:`Dataset.reduce` methods (:issue:`3510`, :pull:`4940`).
By `Justus Magin <https://github.com/keewis>`_.
- Decode values as signed if attribute `_Unsigned = "false"` (:issue:`4954`)
By `Tobias Kölling <https://github.com/d70-t>`_.
- Keep coords attributes when interpolating when the indexer is not a Variable. (:issue:`4239`, :issue:`4839` :pull:`5031`)
By `Jimmy Westling <https://github.com/illviljan>`_.
- Ensure standard calendar dates encoded with a calendar attribute with some or
all uppercase letters can be decoded or encoded to or from
``np.datetime64[ns]`` dates with or without ``cftime`` installed
(:issue:`5093`, :pull:`5180`). By `Spencer Clark
<https://github.com/spencerkclark>`_.
- Warn on passing ``keep_attrs`` to ``resample`` and ``rolling_exp`` as they are ignored, pass ``keep_attrs``
to the applied function instead (:pull:`5265`). By `Mathias Hauser <https://github.com/mathause>`_.
(:issue:`5093`, :pull:`5180`).
By `Spencer Clark <https://github.com/spencerkclark>`_.
- Documentation:
- New section on :ref:`add_a_backend` in the "Internals" chapter aimed to backend developers
(:issue:`4803`, :pull:`4810`).
By `Aureliana Barghini <https://github.com/aurghs>`_.
- Add :py:meth:`Dataset.polyfit` and :py:meth:`DataArray.polyfit` under "See also" in
the docstrings of :py:meth:`Dataset.polyfit` and :py:meth:`DataArray.polyfit`
(:issue:`5016`, :pull:`5020`).
By `Aaron Spring <https://github.com/aaronspring>`_.
- New sphinx theme & rearrangement of the docs (:pull:`4835`).
By `Anderson Banihirwe <https://github.com/andersy005>`_.
- Internal Changes:
- Enable displaying mypy error codes and ignore only specific error codes using
``# type: ignore[error-code]`` (:pull:`5096`).
By `Mathias Hauser <https://github.com/mathause>`_.
- Replace uses of ``raises_regex`` with the more standard
``pytest.raises(Exception, match="foo")``;
(:pull:`5188`), (:pull:`5191`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
* Sat Feb 27 2021 Sebastian Wagner <sebix+novell.com@sebix.at>
- update to version 0.17.0:
- This release brings a few important performance improvements, a wide range of:
- usability upgrades, lots of bug fixes, and some new features. These include:
- better ``cftime`` support, a new quiver plot, better ``unstack`` performance,:
- more efficient memory use in rolling operations, and some python packaging:
- improvements. We also have a few documentation improvements (and more planned!).:
- Many thanks to the 36 contributors to this release: Alessandro Amici, Anderson:
- Banihirwe, Aureliana Barghini, Ayrton Bourn, Benjamin Bean, Blair Bonnett, Chun:
- Ho Chow, DWesl, Daniel Mesejo-León, Deepak Cherian, Eric Keenan, Illviljan, Jens:
- Hedegaard Nielsen, Jody Klymak, Julien Seguinot, Julius Busecke, Kai Mühlbauer,:
- Leif Denby, Martin Durant, Mathias Hauser, Maximilian Roos, Michael Mann, Ray:
- Bell, RichardScottOZ, Spencer Clark, Tim Gates, Tom Nicholas, Yunus Sevinchan,:
- alexamici, aurghs, crusaderky, dcherian, ghislainp, keewis, rhkleijn:
- Breaking changes:
- xarray no longer supports python 3.6
The minimum version policy was changed to also apply to projects with irregular
releases. As a result, the minimum versions of some dependencies have changed:
============ ====== ====
Package Old New
============ ====== ====
Python 3.6 3.7
setuptools 38.4 40.4
numpy 1.15 1.17
pandas 0.25 1.0
dask 2.9 2.11
distributed 2.9 2.11
bottleneck 1.2 1.3
h5netcdf 0.7 0.8
iris 2.2 2.4
netcdf4 1.4 1.5
pseudonetcdf 3.0 3.1
rasterio 1.0 1.1
scipy 1.3 1.4
seaborn 0.9 0.10
zarr 2.3 2.4
============ ====== ====
(:issue:`4688`, :pull:`4720`, :pull:`4907`, :pull:`4942`)
- As a result of :pull:`4684` the default units encoding for
datetime-like values (``np.datetime64[ns]`` or ``cftime.datetime``) will now
always be set such that ``int64`` values can be used. In the past, no units
finer than "seconds" were chosen, which would sometimes mean that ``float64``
values were required, which would lead to inaccurate I/O round-trips.
- Variables referred to in attributes like ``bounds`` and ``grid_mapping``
can be set as coordinate variables. These attributes are moved to
:py:attr:`DataArray.encoding` from :py:attr:`DataArray.attrs`. This behaviour
is controlled by the ``decode_coords`` kwarg to :py:func:`open_dataset` and
:py:func:`open_mfdataset`. The full list of decoded attributes is in
:ref:`weather-climate` (:pull:`2844`, :issue:`3689`)
- As a result of :pull:`4911` the output from calling :py:meth:`DataArray.sum`
or :py:meth:`DataArray.prod` on an integer array with ``skipna=True`` and a
non-None value for ``min_count`` will now be a float array rather than an
integer array.
- Deprecations:
- ``dim`` argument to :py:meth:`DataArray.integrate` is being deprecated in
favour of a ``coord`` argument, for consistency with :py:meth:`Dataset.integrate`.
For now using ``dim`` issues a ``FutureWarning``. It will be removed in
version 0.19.0 (:pull:`3993`).
By `Tom Nicholas <https://github.com/TomNicholas>`_.
- Deprecated ``autoclose`` kwargs from :py:func:`open_dataset` are removed (:pull:`4725`).
By `Aureliana Barghini <https://github.com/aurghs>`_.
- the return value of :py:meth:`Dataset.update` is being deprecated to make it work more
like :py:meth:`dict.update`. It will be removed in version 0.19.0 (:pull:`4932`).
By `Justus Magin <https://github.com/keewis>`_.
- New Features:
- :py:meth:`~xarray.cftime_range` and :py:meth:`DataArray.resample` now support
millisecond (``"L"`` or ``"ms"``) and microsecond (``"U"`` or ``"us"``) frequencies
for ``cftime.datetime`` coordinates (:issue:`4097`, :pull:`4758`).
By `Spencer Clark <https://github.com/spencerkclark>`_.
- Significantly higher ``unstack`` performance on numpy-backed arrays which
contain missing values; 8x faster than previous versions in our benchmark, and
now 2x faster than pandas (:pull:`4746`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Add :py:meth:`Dataset.plot.quiver` for quiver plots with :py:class:`Dataset` variables.
By `Deepak Cherian <https://github.com/dcherian>`_.
- Add ``"drop_conflicts"`` to the strategies supported by the ``combine_attrs`` kwarg
(:issue:`4749`, :pull:`4827`).
By `Justus Magin <https://github.com/keewis>`_.
- Allow installing from git archives (:pull:`4897`).
By `Justus Magin <https://github.com/keewis>`_.
- :py:class:`DataArrayCoarsen` and :py:class:`DatasetCoarsen` now implement a
``reduce`` method, enabling coarsening operations with custom reduction
functions (:issue:`3741`, :pull:`4939`). By `Spencer Clark
<https://github.com/spencerkclark>`_.
- Most rolling operations use significantly less memory. (:issue:`4325`).
By `Deepak Cherian <https://github.com/dcherian>`_.
- Add :py:meth:`Dataset.drop_isel` and :py:meth:`DataArray.drop_isel`
(:issue:`4658`, :pull:`4819`).
By `Daniel Mesejo <https://github.com/mesejo>`_.
- Xarray now leverages updates as of cftime version 1.4.1, which enable exact I/O
roundtripping of ``cftime.datetime`` objects (:pull:`4758`).
By `Spencer Clark <https://github.com/spencerkclark>`_.
- :py:func:`open_dataset` and :py:func:`open_mfdataset` now accept ``fsspec`` URLs
(including globs for the latter) for ``engine="zarr"``, and so allow reading from
many remote and other file systems (:pull:`4461`)
By `Martin Durant <https://github.com/martindurant>`_
- :py:meth:`DataArray.swap_dims` & :py:meth:`Dataset.swap_dims` now accept dims
in the form of kwargs as well as a dict, like most similar methods.
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Bug fixes:
- Use specific type checks in
:py:func:`~xarray.core.variable.as_compatible_data` instead of blanket
access to ``values`` attribute (:issue:`2097`)
By `Yunus Sevinchan <https://github.com/blsqr>`_.
- :py:meth:`DataArray.resample` and :py:meth:`Dataset.resample` do not trigger
computations anymore if :py:meth:`Dataset.weighted` or
:py:meth:`DataArray.weighted` are applied (:issue:`4625`, :pull:`4668`). By
`Julius Busecke <https://github.com/jbusecke>`_.
- :py:func:`merge` with ``combine_attrs='override'`` makes a copy of the attrs
(:issue:`4627`).
- By default, when possible, xarray will now always use values of
type ``int64`` when encoding and decoding ``numpy.datetime64[ns]`` datetimes. This
ensures that maximum precision and accuracy are maintained in the round-tripping
process (:issue:`4045`, :pull:`4684`). It also enables encoding and decoding standard
calendar dates with time units of nanoseconds (:pull:`4400`).
By `Spencer Clark <https://github.com/spencerkclark>`_ and `Mark Harfouche
<http://github.com/hmaarrfk>`_.
- :py:meth:`DataArray.astype`, :py:meth:`Dataset.astype` and :py:meth:`Variable.astype` support
the ``order`` and ``subok`` parameters again. This fixes a regression introduced in version 0.16.1
(:issue:`4644`, :pull:`4683`).
By `Richard Kleijn <https://github.com/rhkleijn>`_ .
- Remove dictionary unpacking when using ``.loc`` to avoid collision with ``.sel`` parameters (:pull:`4695`).
By `Anderson Banihirwe <https://github.com/andersy005>`_.
- Fix the legend created by :py:meth:`Dataset.plot.scatter` (:issue:`4641`, :pull:`4723`).
By `Justus Magin <https://github.com/keewis>`_.
- Fix a crash in orthogonal indexing on geographic coordinates with ``engine='cfgrib'``
(:issue:`4733` :pull:`4737`).
By `Alessandro Amici <https://github.com/alexamici>`_.
- Coordinates with dtype ``str`` or ``bytes`` now retain their dtype on many operations,
e.g. ``reindex``, ``align``, ``concat``, ``assign``, previously they were cast to an object dtype
(:issue:`2658` and :issue:`4543`).
By `Mathias Hauser <https://github.com/mathause>`_.
- Limit number of data rows when printing large datasets. (:issue:`4736`, :pull:`4750`).
By `Jimmy Westling <https://github.com/illviljan>`_.
- Add ``missing_dims`` parameter to transpose (:issue:`4647`, :pull:`4767`).
By `Daniel Mesejo <https://github.com/mesejo>`_.
- Resolve intervals before appending other metadata to labels when plotting (:issue:`4322`, :pull:`4794`).
By `Justus Magin <https://github.com/keewis>`_.
- Fix regression when decoding a variable with a ``scale_factor`` and ``add_offset`` given
as a list of length one (:issue:`4631`) by `Mathias Hauser <https://github.com/mathause>`_.
- Expand user directory paths (e.g. ``~/``) in :py:func:`open_mfdataset` and
:py:meth:`Dataset.to_zarr` (:issue:`4783`, :pull:`4795`).
By `Julien Seguinot <https://github.com/juseg>`_.
- Raise DeprecationWarning when trying to typecast a tuple containing a :py:class:`DataArray`.
User now prompted to first call `.data` on it (:issue:`4483`).
By `Chun Ho Chow <https://github.com/chunhochow>`_.
- Ensure that :py:meth:`Dataset.interp` raises ``ValueError`` when interpolating
outside coordinate range and ``bounds_error=True`` (:issue:`4854`,
:pull:`4855`).
By `Leif Denby <https://github.com/leifdenby>`_.
- Fix time encoding bug associated with using cftime versions greater than
1.4.0 with xarray (:issue:`4870`, :pull:`4871`). By `Spencer Clark <https://github.com/spencerkclark>`_.
- Stop :py:meth:`DataArray.sum` and :py:meth:`DataArray.prod` computing lazy
arrays when called with a ``min_count`` parameter (:issue:`4898`, :pull:`4911`).
By `Blair Bonnett <https://github.com/bcbnz>`_.
- Fix bug preventing the ``min_count`` parameter to :py:meth:`DataArray.sum` and
:py:meth:`DataArray.prod` working correctly when calculating over all axes of
a float64 array (:issue:`4898`, :pull:`4911`). By `Blair Bonnett <https://github.com/bcbnz>`_.
- Fix decoding of vlen strings using h5py versions greater than 3.0.0 with h5netcdf backend (:issue:`4570`, :pull:`4893`).
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
- Allow converting :py:class:`Dataset` or :py:class:`DataArray` objects with a ``MultiIndex``
and at least one other dimension to a ``pandas`` object (:issue:`3008`, :pull:`4442`).
By `ghislainp <https://github.com/ghislainp>`_.
- Documentation:
- Add information about requirements for accessor classes (:issue:`2788`, :pull:`4657`).
By `Justus Magin <https://github.com/keewis>`_.
- Start a list of external I/O integrating with ``xarray`` (:issue:`683`, :pull:`4566`).
By `Justus Magin <https://github.com/keewis>`_.
- Add concat examples and improve combining documentation (:issue:`4620`, :pull:`4645`).
By `Ray Bell <https://github.com/raybellwaves>`_ and
`Justus Magin <https://github.com/keewis>`_.
- explicitly mention that :py:meth:`Dataset.update` updates inplace (:issue:`2951`, :pull:`4932`).
By `Justus Magin <https://github.com/keewis>`_.
- Added docs on vectorized indexing (:pull:`4711`).
By `Eric Keenan <https://github.com/EricKeenan>`_.
- Internal Changes:
- Speed up of the continuous integration tests on azure.
- Switched to mamba and use matplotlib-base for a faster installation of all dependencies (:pull:`4672`).
- Use ``pytest.mark.skip`` instead of ``pytest.mark.xfail`` for some tests that can currently not
succeed (:pull:`4685`).
- Run the tests in parallel using pytest-xdist (:pull:`4694`).
By `Justus Magin <https://github.com/keewis>`_ and `Mathias Hauser <https://github.com/mathause>`_.
- Use ``pyproject.toml`` instead of the ``setup_requires`` option for
``setuptools`` (:pull:`4897`).
By `Justus Magin <https://github.com/keewis>`_.
- Replace all usages of ``assert x.identical(y)`` with ``assert_identical(x, y)``
for clearer error messages (:pull:`4752`).
By `Maximilian Roos <https://github.com/max-sixty>`_.
- Speed up attribute style access (e.g. ``ds.somevar`` instead of ``ds["somevar"]``) and
tab completion in IPython (:issue:`4741`, :pull:`4742`).
By `Richard Kleijn <https://github.com/rhkleijn>`_.
- Added the ``set_close`` method to ``Dataset`` and ``DataArray`` for backends
to specify how to voluntary release all resources. (:pull:`#4809`)
By `Alessandro Amici <https://github.com/alexamici>`_.
- Update type hints to work with numpy v1.20 (:pull:`4878`).
By `Mathias Hauser <https://github.com/mathause>`_.
- Ensure warnings cannot be turned into exceptions in :py:func:`testing.assert_equal` and
the other ``assert_*`` functions (:pull:`4864`).
By `Mathias Hauser <https://github.com/mathause>`_.
- Performance improvement when constructing DataArrays. Significantly speeds up
repr for Datasets with large number of variables.
By `Deepak Cherian <https://github.com/dcherian>`_.
- remove xarray-pr4884-dask2021.patch, was never applied and is included upstream.
* Mon Feb 15 2021 Ben Greiner <code@bnavigator.de>
- Disable python36 build: python36-numpy is no longer in Tumbleweed
xarray will follow to drop Python 3.6 support on next release.
(NEP 29)
- Add xarray-pr4884-dask2021.patch gh#pydata/xarray#4884
- Enable parralel testing with pytest-xdist
- Recommend/Suggest the extras
/usr/share/doc/packages/python311-xarray-parallel /usr/share/doc/packages/python311-xarray-parallel/README.md /usr/share/licenses/python311-xarray-parallel /usr/share/licenses/python311-xarray-parallel/LICENSE
Generated by rpm2html 1.8.1
Fabrice Bellet, Sun Jun 9 12:20:07 2024