Merge branch 'main' into explicit-indexes-variables

Author: benbovy

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
       - id: isort
   # https://github.com/python/black#version-control-integration
   - repo: https://github.com/psf/black
-    rev: 21.7b0
+    rev: 21.8b0
     hooks:
       - id: black
   - repo: https://github.com/keewis/blackdoc

README.rst

@@ -105,7 +105,7 @@ to support our efforts.
 History
 -------
 
-xarray is an evolution of an internal tool developed at `The Climate
+Xarray is an evolution of an internal tool developed at `The Climate
 Corporation`__. It was originally written by Climate Corp researchers Stephan
 Hoyer, Alex Kleeman and Eugene Brevdo and was released as open source in
 May 2014. The project was renamed from "xray" in January 2016. Xarray became a
@@ -131,16 +131,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 
-xarray bundles portions of pandas, NumPy and Seaborn, all of which are available
+Xarray bundles portions of pandas, NumPy and Seaborn, all of which are available
 under a "3-clause BSD" license:
 - pandas: setup.py, xarray/util/print_versions.py
 - NumPy: xarray/core/npcompat.py
 - Seaborn: _determine_cmap_params in xarray/core/plot/utils.py
 
-xarray also bundles portions of CPython, which is available under the "Python
+Xarray also bundles portions of CPython, which is available under the "Python
 Software Foundation License" in xarray/core/pycompat.py.
 
-xarray uses icons from the icomoon package (free version), which is
+Xarray uses icons from the icomoon package (free version), which is
 available under the "CC BY 4.0" license.
 
 The full text of these licenses are included in the licenses directory.

doc/api.rst

@@ -35,6 +35,7 @@ Top-level functions
    map_blocks
    show_versions
    set_options
+   get_options
    unify_chunks
 
 Dataset
@@ -598,8 +599,8 @@ Universal functions
 
 .. warning::
 
-   With recent versions of numpy, dask and xarray, NumPy ufuncs are now
-   supported directly on all xarray and dask objects. This obviates the need
+   With recent versions of NumPy, Dask and xarray, NumPy ufuncs are now
+   supported directly on all xarray and Dask objects. This obviates the need
    for the ``xarray.ufuncs`` module, which should not be used for new code
    unless compatibility with versions of NumPy prior to v1.13 is
    required. They will be removed once support for NumPy prior to

doc/contributing.rst

@@ -257,7 +257,7 @@ Some other important things to know about the docs:
   tutorial-like overviews per topic together with some other information
   (what's new, installation, etc).
 
-- The docstrings follow the **Numpy Docstring Standard**, which is used widely
+- The docstrings follow the **NumPy Docstring Standard**, which is used widely
   in the Scientific Python community. This standard specifies the format of
   the different sections of the docstring. See `this document
   <https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard>`_

doc/examples/ERA5-GRIB-example.ipynb

@@ -11,7 +11,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "GRIB format is commonly used to disseminate atmospheric model data. With Xarray and the cfgrib engine, GRIB data can easily be analyzed and visualized."
+    "GRIB format is commonly used to disseminate atmospheric model data. With xarray and the cfgrib engine, GRIB data can easily be analyzed and visualized."
    ]
   },
   {

doc/examples/multidimensional-coords.ipynb

@@ -184,7 +184,7 @@
    "source": [
     "The resulting coordinate for the `groupby_bins` operation got the `_bins` suffix appended: `xc_bins`. This help us distinguish it from the original multidimensional variable `xc`.\n",
     "\n",
-    "**Note**: This group-by-latitude approach does not take into account the finite-size geometry of grid cells. It simply bins each value according to the coordinates at the cell center. Xarray has no understanding of grid cells and their geometry. More precise geographic regridding for Xarray data is available via the [xesmf](https://xesmf.readthedocs.io) package."
+    "**Note**: This group-by-latitude approach does not take into account the finite-size geometry of grid cells. It simply bins each value according to the coordinates at the cell center. Xarray has no understanding of grid cells and their geometry. More precise geographic regridding for xarray data is available via the [xesmf](https://xesmf.readthedocs.io) package."
    ]
   },
   {

doc/examples/visualization_gallery.ipynb

@@ -6,7 +6,7 @@
    "source": [
     "# Visualization Gallery\n",
     "\n",
-    "This notebook shows common visualization issues encountered in Xarray."
+    "This notebook shows common visualization issues encountered in xarray."
    ]
   },
   {

doc/getting-started-guide/faq.rst

@@ -55,9 +55,9 @@ rows) shouldn't really matter. For example, the images of a movie can be
 natively represented as an array with four dimensions: time, row, column and
 color.
 
-Pandas has historically supported N-dimensional panels, but deprecated them in
-version 0.20 in favor of Xarray data structures. There are now built-in methods
-on both sides to convert between pandas and Xarray, allowing for more focused
+pandas has historically supported N-dimensional panels, but deprecated them in
+version 0.20 in favor of xarray data structures. There are now built-in methods
+on both sides to convert between pandas and xarray, allowing for more focused
 development effort. Xarray objects have a much richer model of dimensionality -
 if you were using Panels:
 
@@ -72,8 +72,8 @@ if you were using Panels:
   In contrast, this sort of data structure fits very naturally in an
   xarray ``Dataset``.
 
-You can :ref:`read about switching from Panels to Xarray here <panel transition>`.
-Pandas gets a lot of things right, but many science, engineering and complex
+You can :ref:`read about switching from Panels to xarray here <panel transition>`.
+pandas gets a lot of things right, but many science, engineering and complex
 analytics use cases need fully multi-dimensional data structures.
 
 How do xarray data structures differ from those found in pandas?
@@ -92,7 +92,7 @@ of the "time" dimension. You never need to reshape arrays (e.g., with
 Why don't aggregations return Python scalars?
 ---------------------------------------------
 
-xarray tries hard to be self-consistent: operations on a ``DataArray`` (resp.
+Xarray tries hard to be self-consistent: operations on a ``DataArray`` (resp.
 ``Dataset``) return another ``DataArray`` (resp. ``Dataset``) object. In
 particular, operations returning scalar values (e.g. indexing or aggregations
 like ``mean`` or ``sum`` applied to all axes) will also return xarray objects.
@@ -152,7 +152,7 @@ What other netCDF related Python libraries should I know about?
 
 `netCDF4-python`__ provides a lower level interface for working with
 netCDF and OpenDAP datasets in Python. We use netCDF4-python internally in
-xarray, and have contributed a number of improvements and fixes upstream. xarray
+xarray, and have contributed a number of improvements and fixes upstream. Xarray
 does not yet support all of netCDF4-python's features, such as modifying files
 on-disk.
 
@@ -161,7 +161,7 @@ __ https://github.com/Unidata/netcdf4-python
 Iris_ (supported by the UK Met office) provides similar tools for in-
 memory manipulation of labeled arrays, aimed specifically at weather and
 climate data needs. Indeed, the Iris :py:class:`~iris.cube.Cube` was direct
-inspiration for xarray's :py:class:`~xarray.DataArray`. xarray and Iris take very
+inspiration for xarray's :py:class:`~xarray.DataArray`. Xarray and Iris take very
 different approaches to handling metadata: Iris strictly interprets
 `CF conventions`_. Iris particularly shines at mapping, thanks to its
 integration with Cartopy_.

doc/getting-started-guide/installing.rst

@@ -87,7 +87,7 @@ Alternative data containers
 
 Minimum dependency versions
 ---------------------------
-xarray adopts a rolling policy regarding the minimum supported version of its
+Xarray adopts a rolling policy regarding the minimum supported version of its
 dependencies:
 
 - **Python:** 24 months
@@ -110,7 +110,7 @@ You can see the actual minimum tested versions:
 Instructions
 ------------
 
-xarray itself is a pure Python package, but its dependencies are not. The
+Xarray itself is a pure Python package, but its dependencies are not. The
 easiest way to get everything installed is to use conda_. To install xarray
 with its recommended dependencies using the conda command line tool::
 

doc/getting-started-guide/quick-overview.rst

@@ -46,7 +46,7 @@ Here are the key properties for a ``DataArray``:
 Indexing
 --------
 
-xarray supports four kinds of indexing. Since we have assigned coordinate labels to the x dimension we can use label-based indexing along that dimension just like pandas. The four examples below all yield the same result (the value at `x=10`) but at varying levels of convenience and intuitiveness.
+Xarray supports four kinds of indexing. Since we have assigned coordinate labels to the x dimension we can use label-based indexing along that dimension just like pandas. The four examples below all yield the same result (the value at `x=10`) but at varying levels of convenience and intuitiveness.
 
 .. ipython:: python
 
@@ -133,7 +133,7 @@ For more, see :ref:`comput`.
 GroupBy
 -------
 
-xarray supports grouped operations using a very similar API to pandas (see :ref:`groupby`):
+Xarray supports grouped operations using a very similar API to pandas (see :ref:`groupby`):
 
 .. ipython:: python
 
@@ -225,4 +225,4 @@ You can directly read and write xarray objects to disk using :py:meth:`~xarray.D
     os.remove("example.nc")
 
 
-It is common for datasets to be distributed across multiple files (commonly one file per timestep). xarray supports this use-case by providing the :py:meth:`~xarray.open_mfdataset` and the :py:meth:`~xarray.save_mfdataset` methods. For more, see :ref:`io`.
+It is common for datasets to be distributed across multiple files (commonly one file per timestep). Xarray supports this use-case by providing the :py:meth:`~xarray.open_mfdataset` and the :py:meth:`~xarray.save_mfdataset` methods. For more, see :ref:`io`.