Merge branch 'main' into 0.20-whats-new

Author: TomNicholas

.github/workflows/upstream-dev-ci.yaml

@@ -122,7 +122,7 @@ jobs:
           shopt -s globstar
           python .github/workflows/parse_logs.py logs/**/*-log
       - name: Report failures
-        uses: actions/github-script@v4.1
+        uses: actions/github-script@v5
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
@@ -158,15 +158,15 @@ jobs:
             // If no issue is open, create a new issue,
             // else update the body of the existing issue.
             if (result.repository.issues.edges.length === 0) {
-                github.issues.create({
+                github.rest.issues.create({
                     owner: variables.owner,
                     repo: variables.name,
                     body: issue_body,
                     title: title,
                     labels: [variables.label]
                 })
             } else {
-                github.issues.update({
+                github.rest.issues.update({
                     owner: variables.owner,
                     repo: variables.name,
                     issue_number: result.repository.issues.edges[0].node.number,

ci/min_deps_check.py

@@ -20,24 +20,16 @@
     "isort",
     "mypy",
     "pip",
+    "setuptools",
     "pytest",
     "pytest-cov",
     "pytest-env",
     "pytest-xdist",
 }
 
-POLICY_MONTHS = {"python": 24, "numpy": 18, "setuptools": 42}
+POLICY_MONTHS = {"python": 24, "numpy": 18}
 POLICY_MONTHS_DEFAULT = 12
-POLICY_OVERRIDE = {
-    # setuptools-scm doesn't work with setuptools < 36.7 (Nov 2017).
-    # The conda metadata is malformed for setuptools < 38.4 (Jan 2018)
-    # (it's missing a timestamp which prevents this tool from working).
-    # setuptools < 40.4 (Sep 2018) from conda-forge cannot be installed into a py37
-    # environment
-    # TODO remove this special case and the matching note in installing.rst
-    #      after March 2022.
-    "setuptools": (40, 4),
-}
+POLICY_OVERRIDE: Dict[str, Tuple[int, int]] = {}
 has_errors = False
 
 

ci/requirements/environment-windows.yml

@@ -39,6 +39,7 @@ dependencies:
   - setuptools
   - sparse
   - toolz
+  - typing_extensions
   - zarr
   - pip:
     - numbagg

ci/requirements/environment.yml

@@ -43,6 +43,7 @@ dependencies:
   - setuptools
   - sparse
   - toolz
+  - typing_extensions
   - zarr
   - pip:
     - numbagg

ci/requirements/py37-bare-minimum.yml

@@ -10,6 +10,6 @@ dependencies:
   - pytest-cov
   - pytest-env
   - pytest-xdist
-  - numpy=1.17
-  - pandas=1.0
-  - setuptools=40.4
+  - numpy=1.18
+  - pandas=1.1
+  - typing_extensions=3.7

ci/requirements/py37-min-all-deps.yml

@@ -10,29 +10,31 @@ dependencies:
   - python=3.7
   - boto3=1.13
   - bottleneck=1.3
+  # cartopy 0.18 conflicts with pynio
   - cartopy=0.17
   - cdms2=3.1
   - cfgrib=0.9
-  - cftime=1.1
+  - cftime=1.2
   - coveralls
-  - dask=2.24
-  - distributed=2.24
+  - dask=2.30
+  - distributed=2.30
   - h5netcdf=0.8
   - h5py=2.10
+  # hdf5 1.12 conflicts with h5py=2.10
   - hdf5=1.10
   - hypothesis
   - iris=2.4
-  - lxml=4.5  # Optional dep of pydap
-  - matplotlib-base=3.2
+  - lxml=4.6  # Optional dep of pydap
+  - matplotlib-base=3.3
   - nc-time-axis=1.2
   # netcdf follows a 1.major.minor[.patch] convention
   # (see https://github.com/Unidata/netcdf4-python/issues/1090)
   # bumping the netCDF4 version is currently blocked by #4491
   - netcdf4=1.5.3
-  - numba=0.49
-  - numpy=1.17
-  - pandas=1.0
-  - pint=0.15
+  - numba=0.51
+  - numpy=1.18
+  - pandas=1.1
+  - pint=0.16
   - pip
   - pseudonetcdf=3.1
   - pydap=3.2
@@ -42,11 +44,11 @@ dependencies:
   - pytest-env
   - pytest-xdist
   - rasterio=1.1
-  - scipy=1.4
-  - seaborn=0.10
-  - setuptools=40.4
-  - sparse=0.8
-  - toolz=0.10
-  - zarr=2.4
+  - scipy=1.5
+  - seaborn=0.11
+  - sparse=0.11
+  - toolz=0.11
+  - typing_extensions=3.7
+  - zarr=2.5
   - pip:
     - numbagg==0.1

ci/requirements/py38-all-but-dask.yml

@@ -39,6 +39,7 @@ dependencies:
   - setuptools
   - sparse
   - toolz
+  - typing_extensions
   - zarr
   - pip:
     - numbagg

doc/api.rst

@@ -65,6 +65,7 @@ Attributes
    Dataset.indexes
    Dataset.get_index
    Dataset.chunks
+   Dataset.chunksizes
    Dataset.nbytes
 
 Dictionary interface
@@ -271,6 +272,7 @@ Attributes
    DataArray.encoding
    DataArray.indexes
    DataArray.get_index
+   DataArray.chunksizes
 
 **ndarray attributes**:
 :py:attr:`~DataArray.ndim`
@@ -779,12 +781,18 @@ Weighted objects
 
    core.weighted.DataArrayWeighted
    core.weighted.DataArrayWeighted.mean
+   core.weighted.DataArrayWeighted.std
    core.weighted.DataArrayWeighted.sum
+   core.weighted.DataArrayWeighted.sum_of_squares
    core.weighted.DataArrayWeighted.sum_of_weights
+   core.weighted.DataArrayWeighted.var
    core.weighted.DatasetWeighted
    core.weighted.DatasetWeighted.mean
+   core.weighted.DatasetWeighted.std
    core.weighted.DatasetWeighted.sum
+   core.weighted.DatasetWeighted.sum_of_squares
    core.weighted.DatasetWeighted.sum_of_weights
+   core.weighted.DatasetWeighted.var
 
 
 Coarsen objects

doc/conf.py

@@ -147,14 +147,18 @@
     "matplotlib colormap name": ":doc:`matplotlib colormap name <matplotlib:gallery/color/colormap_reference>`",
     "matplotlib axes object": ":py:class:`matplotlib axes object <matplotlib.axes.Axes>`",
     "colormap": ":py:class:`colormap <matplotlib.colors.Colormap>`",
-    # objects without namespace
+    # objects without namespace: xarray
     "DataArray": "~xarray.DataArray",
     "Dataset": "~xarray.Dataset",
     "Variable": "~xarray.Variable",
+    "DatasetGroupBy": "~xarray.core.groupby.DatasetGroupBy",
+    "DataArrayGroupBy": "~xarray.core.groupby.DataArrayGroupBy",
+    # objects without namespace: numpy
     "ndarray": "~numpy.ndarray",
     "MaskedArray": "~numpy.ma.MaskedArray",
     "dtype": "~numpy.dtype",
     "ComplexWarning": "~numpy.ComplexWarning",
+    # objects without namespace: pandas
     "Index": "~pandas.Index",
     "MultiIndex": "~pandas.MultiIndex",
     "CategoricalIndex": "~pandas.CategoricalIndex",

doc/ecosystem.rst

@@ -37,6 +37,7 @@ Geosciences
 - `Spyfit <https://spyfit.readthedocs.io/en/master/>`_: FTIR spectroscopy of the atmosphere
 - `windspharm <https://ajdawson.github.io/windspharm/index.html>`_: Spherical
   harmonic wind analysis in Python.
+- `wradlib <https://wradlib.org/>`_: An Open Source Library for Weather Radar Data Processing.
 - `wrf-python <https://wrf-python.readthedocs.io/>`_: A collection of diagnostic and interpolation routines for use with output of the Weather Research and Forecasting (WRF-ARW) Model.
 - `xarray-simlab <https://xarray-simlab.readthedocs.io>`_: xarray extension for computer model simulations.
 - `xarray-spatial <https://makepath.github.io/xarray-spatial>`_: Numba-accelerated raster-based spatial processing tools (NDVI, curvature, zonal-statistics, proximity, hillshading, viewshed, etc.)

doc/getting-started-guide/installing.rst

@@ -7,7 +7,8 @@ Required dependencies
 ---------------------
 
 - Python (3.7 or later)
-- setuptools (40.4 or later)
+- `importlib_metadata <https://importlib_metadata.readthedocs.io/>`__ (1.4 or later, Python 3.7 only)
+- ``typing_extensions`` (3.7 or later, Python 3.7 only)
 - `numpy <http://www.numpy.org/>`__ (1.17 or later)
 - `pandas <http://pandas.pydata.org/>`__ (1.0 or later)
 
@@ -92,7 +93,6 @@ dependencies:
 
 - **Python:** 24 months
   (`NEP-29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_)
-- **setuptools:** 42 months (but no older than 40.4)
 - **numpy:** 18 months
   (`NEP-29 <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_)
 - **all other libraries:** 12 months

doc/user-guide/computation.rst

@@ -263,7 +263,7 @@ Weighted array reductions
 
 :py:class:`DataArray` and :py:class:`Dataset` objects include :py:meth:`DataArray.weighted`
 and :py:meth:`Dataset.weighted` array reduction methods. They currently
-support weighted ``sum`` and weighted ``mean``.
+support weighted ``sum``, ``mean``, ``std`` and ``var``.
 
 .. ipython:: python
 
@@ -298,13 +298,27 @@ The weighted sum corresponds to:
     weighted_sum = (prec * weights).sum()
     weighted_sum
 
-and the weighted mean to:
+the weighted mean to:
 
 .. ipython:: python
 
     weighted_mean = weighted_sum / weights.sum()
     weighted_mean
 
+the weighted variance to:
+
+.. ipython:: python
+
+    weighted_var = weighted_prec.sum_of_squares() / weights.sum()
+    weighted_var
+
+and the weighted standard deviation to:
+
+.. ipython:: python
+
+    weighted_std = np.sqrt(weighted_var)
+    weighted_std
+
 However, the functions also take missing values in the data into account:
 
 .. ipython:: python
@@ -327,7 +341,7 @@ If the weights add up to to 0, ``sum`` returns 0:
 
     data.weighted(weights).sum()
 
-and ``mean`` returns ``NaN``:
+and ``mean``, ``std`` and ``var`` return ``NaN``:
 
 .. ipython:: python
 

doc/whats-new.rst

@@ -38,17 +38,35 @@ New Features
   `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
-  ============ ====== ====
-  dask         2.15   2.24
-  distributed  2.15   2.24
-  ============ ====== ====
+  =============== ====== ====
+  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
@@ -76,17 +94,23 @@ Bug fixes
 - 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
 ~~~~~~~~~~~~~
@@ -122,6 +146,10 @@ Internal Changes
   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>`_.
+
 
 .. _whats-new.0.19.0:
 

requirements.txt

@@ -5,4 +5,4 @@
 numpy >= 1.17
 pandas >= 1.0
 setuptools >= 40.4
-typing-extensions >= 3.10
+typing-extensions >= 3.7

setup.cfg

@@ -76,9 +76,10 @@ zip_safe = False  # https://mypy.readthedocs.io/en/latest/installed_packages.htm
 include_package_data = True
 python_requires = >=3.7
 install_requires =
-    numpy >= 1.17
-    pandas >= 1.0
-    setuptools >= 40.4  # For pkg_resources
+    numpy >= 1.18
+    pandas >= 1.1
+    importlib-metadata; python_version < '3.8'
+    typing_extensions >= 3.7; python_version < '3.8'
 
 [options.extras_require]
 io =

xarray/__init__.py

@@ -1,5 +1,3 @@
-import pkg_resources
-
 from . import testing, tutorial, ufuncs
 from .backends.api import (
     load_dataarray,
@@ -30,7 +28,13 @@
 from .util.print_versions import show_versions
 
 try:
-    __version__ = pkg_resources.get_distribution("xarray").version
+    from importlib.metadata import version as _version
+except ImportError:
+    # if the fallback library is missing, we are doomed.
+    from importlib_metadata import version as _version  # type: ignore[no-redef]
+
+try:
+    __version__ = _version("xarray")
 except Exception:
     # Local copy or not installed with setuptools.
     # Disable minimum version checks on downstream libraries.