Skip to content
forked from pydata/xarray

Commit d40a88d

Browse files
committed
Merge branch 'master' of github.com:pydata/xarray into chunk-unique-token
* 'master' of github.com:pydata/xarray: Add nanmedian for dask arrays (pydata#3604) added pyinterp to related projects (pydata#3655) Allow incomplete hypercubes in combine_by_coords (pydata#3649) concat keeps attrs from first variable. (pydata#3637) Extend DatetimeAccessor properties and support `.dt` accessor for Timedelta (pydata#3612) update readthedocs.yml (pydata#3639) silence sphinx warnings round 3 (pydata#3602) Fix/quantile wrong errmsg (pydata#3635) Provide shape info in shape mismatch error. (pydata#3619) Minor doc fixes (pydata#3615) Respect user-specified coordinates attribute. (pydata#3487) Add Facetgrid.row_labels & Facetgrid.col_labels (pydata#3597) Fix pint integration tests (pydata#3600) Minor fix to combine_by_coords to allow for the combination of CFTimeIndexes separated by large time intervals (pydata#3543)
2 parents 50e3f2c + b3d3b44 commit d40a88d

37 files changed

+2655
-1290
lines changed

doc/api-hidden.rst

+652-1
Large diffs are not rendered by default.

doc/api.rst

+55-1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Top-level functions
3131
ones_like
3232
dot
3333
map_blocks
34+
show_versions
35+
set_options
3436

3537
Dataset
3638
=======
@@ -74,7 +76,9 @@ and values given by ``DataArray`` objects.
7476
Dataset.__setitem__
7577
Dataset.__delitem__
7678
Dataset.update
79+
Dataset.get
7780
Dataset.items
81+
Dataset.keys
7882
Dataset.values
7983

8084
Dataset contents
@@ -537,6 +541,15 @@ DataArray methods
537541
DataArray.unify_chunks
538542
DataArray.map_blocks
539543

544+
Coordinates objects
545+
===================
546+
547+
.. autosummary::
548+
:toctree: generated/
549+
550+
core.coordinates.DataArrayCoordinates
551+
core.coordinates.DatasetCoordinates
552+
540553
GroupBy objects
541554
===============
542555

@@ -564,6 +577,16 @@ Rolling objects
564577
core.rolling.DatasetRolling.reduce
565578
core.rolling_exp.RollingExp
566579

580+
Coarsen objects
581+
===============
582+
583+
.. autosummary::
584+
:toctree: generated/
585+
586+
core.rolling.DataArrayCoarsen
587+
core.rolling.DatasetCoarsen
588+
589+
567590
Resample objects
568591
================
569592

@@ -593,6 +616,7 @@ Accessors
593616
:toctree: generated/
594617

595618
core.accessor_dt.DatetimeAccessor
619+
core.accessor_dt.TimedeltaAccessor
596620
core.accessor_str.StringAccessor
597621

598622
Custom Indexes
@@ -627,6 +651,33 @@ Plotting
627651
plot.pcolormesh
628652
plot.FacetGrid
629653

654+
Faceting
655+
--------
656+
.. autosummary::
657+
:toctree: generated/
658+
659+
plot.FacetGrid
660+
plot.FacetGrid.add_colorbar
661+
plot.FacetGrid.add_legend
662+
plot.FacetGrid.map
663+
plot.FacetGrid.map_dataarray
664+
plot.FacetGrid.map_dataarray_line
665+
plot.FacetGrid.map_dataset
666+
plot.FacetGrid.set_axis_labels
667+
plot.FacetGrid.set_ticks
668+
plot.FacetGrid.set_titles
669+
plot.FacetGrid.set_xlabels
670+
plot.FacetGrid.set_ylabels
671+
672+
Tutorial
673+
========
674+
675+
.. autosummary::
676+
:toctree: generated/
677+
678+
tutorial.open_dataset
679+
tutorial.load_dataset
680+
630681
Testing
631682
=======
632683

@@ -663,7 +714,7 @@ Advanced API
663714

664715
These backends provide a low-level interface for lazily loading data from
665716
external file-formats or protocols, and can be manually invoked to create
666-
arguments for the ``from_store`` and ``dump_to_store`` Dataset methods:
717+
arguments for the ``load_store`` and ``dump_to_store`` Dataset methods:
667718

668719
.. autosummary::
669720
:toctree: generated/
@@ -679,6 +730,9 @@ arguments for the ``from_store`` and ``dump_to_store`` Dataset methods:
679730
Deprecated / Pending Deprecation
680731
================================
681732

733+
.. autosummary::
734+
:toctree: generated/
735+
682736
Dataset.drop
683737
DataArray.drop
684738
Dataset.apply

doc/groupby.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Apply
9494
~~~~~
9595

9696
To apply a function to each group, you can use the flexible
97-
:py:meth:`~xarray.DatasetGroupBy.map` method. The resulting objects are automatically
97+
:py:meth:`~xarray.core.groupby.DatasetGroupBy.map` method. The resulting objects are automatically
9898
concatenated back together along the group axis:
9999

100100
.. ipython:: python
@@ -104,8 +104,8 @@ concatenated back together along the group axis:
104104
105105
arr.groupby('letters').map(standardize)
106106
107-
GroupBy objects also have a :py:meth:`~xarray.DatasetGroupBy.reduce` method and
108-
methods like :py:meth:`~xarray.DatasetGroupBy.mean` as shortcuts for applying an
107+
GroupBy objects also have a :py:meth:`~xarray.core.groupby.DatasetGroupBy.reduce` method and
108+
methods like :py:meth:`~xarray.core.groupby.DatasetGroupBy.mean` as shortcuts for applying an
109109
aggregation function:
110110

111111
.. ipython:: python

doc/howdoi.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ How do I ...
2222
* - change the order of dimensions
2323
- :py:meth:`DataArray.transpose`, :py:meth:`Dataset.transpose`
2424
* - remove a variable from my object
25-
- :py:meth:`Dataset.drop`, :py:meth:`DataArray.drop`
25+
- :py:meth:`Dataset.drop_vars`, :py:meth:`DataArray.drop_vars`
2626
* - remove dimensions of length 1 or 0
2727
- :py:meth:`DataArray.squeeze`, :py:meth:`Dataset.squeeze`
2828
* - remove all variables with a particular dimension
@@ -48,7 +48,7 @@ How do I ...
4848
* - write xarray objects with complex values to a netCDF file
4949
- :py:func:`Dataset.to_netcdf`, :py:func:`DataArray.to_netcdf` specifying ``engine="h5netcdf", invalid_netcdf=True``
5050
* - make xarray objects look like other xarray objects
51-
- :py:func:`~xarray.ones_like`, :py:func:`~xarray.zeros_like`, :py:func:`~xarray.full_like`, :py:meth:`Dataset.reindex_like`, :py:meth:`Dataset.interpolate_like`, :py:meth:`Dataset.broadcast_like`, :py:meth:`DataArray.reindex_like`, :py:meth:`DataArray.interpolate_like`, :py:meth:`DataArray.broadcast_like`
51+
- :py:func:`~xarray.ones_like`, :py:func:`~xarray.zeros_like`, :py:func:`~xarray.full_like`, :py:meth:`Dataset.reindex_like`, :py:meth:`Dataset.interp_like`, :py:meth:`Dataset.broadcast_like`, :py:meth:`DataArray.reindex_like`, :py:meth:`DataArray.interp_like`, :py:meth:`DataArray.broadcast_like`
5252
* - replace NaNs with other values
5353
- :py:meth:`Dataset.fillna`, :py:meth:`Dataset.ffill`, :py:meth:`Dataset.bfill`, :py:meth:`Dataset.interpolate_na`, :py:meth:`DataArray.fillna`, :py:meth:`DataArray.ffill`, :py:meth:`DataArray.bfill`, :py:meth:`DataArray.interpolate_na`
5454
* - extract the year, month, day or similar from a DataArray of time values

doc/indexing.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ use them explicitly to slice data. There are two ways to do this:
132132
133133
The arguments to these methods can be any objects that could index the array
134134
along the dimension given by the keyword, e.g., labels for an individual value,
135-
Python :py:func:`slice` objects or 1-dimensional arrays.
135+
Python :py:class:`slice` objects or 1-dimensional arrays.
136136

137137
.. note::
138138

doc/interpolation.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ array-like, which gives the interpolated result as an array.
4848
# interpolation
4949
da.interp(time=[2.5, 3.5])
5050
51-
To interpolate data with a :py:func:`numpy.datetime64` coordinate you can pass a string.
51+
To interpolate data with a :py:doc:`numpy.datetime64 <reference/arrays.datetime>` coordinate you can pass a string.
5252

5353
.. ipython:: python
5454
@@ -128,7 +128,7 @@ It is now possible to safely compute the difference ``other - interpolated``.
128128
Interpolation methods
129129
---------------------
130130

131-
We use :py:func:`scipy.interpolate.interp1d` for 1-dimensional interpolation and
131+
We use :py:class:`scipy.interpolate.interp1d` for 1-dimensional interpolation and
132132
:py:func:`scipy.interpolate.interpn` for multi-dimensional interpolation.
133133

134134
The interpolation method can be specified by the optional ``method`` argument.

0 commit comments

Comments
 (0)