xarray
This page provides an auto-generated summary of xarray's API. For more details and examples, refer to the relevant chapters in the main part of the documentation.
apply_ufunc align broadcast concat merge where set_options full_like zeros_like ones_like dot
Dataset decode_cf
Dataset.dims Dataset.sizes Dataset.data_vars Dataset.coords Dataset.attrs Dataset.encoding Dataset.indexes Dataset.get_index Dataset.chunks Dataset.nbytes
Datasets implement the mapping interface with keys given by variable names and values given by DataArray objects.
Dataset.__getitem__ Dataset.__setitem__ Dataset.__delitem__ Dataset.update Dataset.items Dataset.values
Dataset.copy Dataset.assign Dataset.assign_coords Dataset.assign_attrs Dataset.pipe Dataset.merge Dataset.rename Dataset.swap_dims Dataset.expand_dims Dataset.drop Dataset.drop_dims Dataset.set_coords Dataset.reset_coords
Dataset.equals Dataset.identical Dataset.broadcast_equals
Dataset.loc Dataset.isel Dataset.sel Dataset.squeeze Dataset.interp Dataset.interp_like Dataset.reindex Dataset.reindex_like Dataset.set_index Dataset.reset_index Dataset.reorder_levels
Dataset.isnull Dataset.notnull Dataset.combine_first Dataset.count Dataset.dropna Dataset.fillna Dataset.ffill Dataset.bfill Dataset.interpolate_na Dataset.where Dataset.isin
Dataset.apply Dataset.reduce Dataset.groupby Dataset.groupby_bins Dataset.rolling Dataset.coarsen Dataset.resample Dataset.diff Dataset.quantile Dataset.differentiate Dataset.integrate
Aggregation: :py~Dataset.all :py~Dataset.any :py~Dataset.argmax :py~Dataset.argmin :py~Dataset.max :py~Dataset.mean :py~Dataset.median :py~Dataset.min :py~Dataset.prod :py~Dataset.sum :py~Dataset.std :py~Dataset.var
ndarray methods: :py~Dataset.astype :py~Dataset.argsort :py~Dataset.clip :py~Dataset.conj :py~Dataset.conjugate :py~Dataset.imag :py~Dataset.round :py~Dataset.real :py~Dataset.cumsum :py~Dataset.cumprod :py~Dataset.rank
Grouped operations: :py~core.groupby.DatasetGroupBy.assign :py~core.groupby.DatasetGroupBy.assign_coords :py~core.groupby.DatasetGroupBy.first :py~core.groupby.DatasetGroupBy.last :py~core.groupby.DatasetGroupBy.fillna :py~core.groupby.DatasetGroupBy.where
Dataset.transpose Dataset.stack Dataset.unstack Dataset.shift Dataset.roll Dataset.sortby
DataArray
DataArray.values DataArray.data DataArray.coords DataArray.dims DataArray.sizes DataArray.name DataArray.attrs DataArray.encoding DataArray.indexes DataArray.get_index
ndarray attributes: :py~DataArray.ndim :py~DataArray.shape :py~DataArray.size :py~DataArray.dtype :py~DataArray.nbytes :py~DataArray.chunks
DataArray.assign_coords DataArray.assign_attrs DataArray.pipe DataArray.rename DataArray.swap_dims DataArray.expand_dims DataArray.drop DataArray.reset_coords DataArray.copy
ndarray methods: :py~DataArray.astype :py~DataArray.item
DataArray.__getitem__ DataArray.__setitem__ DataArray.loc DataArray.isel DataArray.sel DataArray.squeeze DataArray.interp DataArray.interp_like DataArray.reindex DataArray.reindex_like DataArray.set_index DataArray.reset_index DataArray.reorder_levels
DataArray.isnull DataArray.notnull DataArray.combine_first DataArray.count DataArray.dropna DataArray.fillna DataArray.ffill DataArray.bfill DataArray.interpolate_na DataArray.where DataArray.isin
DataArray.equals DataArray.identical DataArray.broadcast_equals
DataArray.reduce DataArray.groupby DataArray.groupby_bins DataArray.rolling DataArray.coarsen DataArray.dt DataArray.resample DataArray.get_axis_num DataArray.diff DataArray.dot DataArray.quantile DataArray.differentiate DataArray.integrate
Aggregation: :py~DataArray.all :py~DataArray.any :py~DataArray.argmax :py~DataArray.argmin :py~DataArray.max :py~DataArray.mean :py~DataArray.median :py~DataArray.min :py~DataArray.prod :py~DataArray.sum :py~DataArray.std :py~DataArray.var
ndarray methods: :py~DataArray.argsort :py~DataArray.clip :py~DataArray.conj :py~DataArray.conjugate :py~DataArray.imag :py~DataArray.searchsorted :py~DataArray.round :py~DataArray.real :py~DataArray.T :py~DataArray.cumsum :py~DataArray.cumprod :py~DataArray.rank
Grouped operations: :py~core.groupby.DataArrayGroupBy.assign_coords :py~core.groupby.DataArrayGroupBy.first :py~core.groupby.DataArrayGroupBy.last :py~core.groupby.DataArrayGroupBy.fillna :py~core.groupby.DataArrayGroupBy.where
DataArray.transpose DataArray.stack DataArray.unstack DataArray.shift DataArray.roll DataArray.sortby
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 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.
This functions are copied from NumPy, but extended to work on NumPy arrays, dask arrays and all xarray objects. You can find them in the xarray.ufuncs module:
:py~ufuncs.angle :py~ufuncs.arccos :py~ufuncs.arccosh :py~ufuncs.arcsin :py~ufuncs.arcsinh :py~ufuncs.arctan :py~ufuncs.arctan2 :py~ufuncs.arctanh :py~ufuncs.ceil :py~ufuncs.conj :py~ufuncs.copysign :py~ufuncs.cos :py~ufuncs.cosh :py~ufuncs.deg2rad :py~ufuncs.degrees :py~ufuncs.exp :py~ufuncs.expm1 :py~ufuncs.fabs :py~ufuncs.fix :py~ufuncs.floor :py~ufuncs.fmax :py~ufuncs.fmin :py~ufuncs.fmod :py~ufuncs.fmod :py~ufuncs.frexp :py~ufuncs.hypot :py~ufuncs.imag :py~ufuncs.iscomplex :py~ufuncs.isfinite :py~ufuncs.isinf :py~ufuncs.isnan :py~ufuncs.isreal :py~ufuncs.ldexp :py~ufuncs.log :py~ufuncs.log10 :py~ufuncs.log1p :py~ufuncs.log2 :py~ufuncs.logaddexp :py~ufuncs.logaddexp2 :py~ufuncs.logical_and :py~ufuncs.logical_not :py~ufuncs.logical_or :py~ufuncs.logical_xor :py~ufuncs.maximum :py~ufuncs.minimum :py~ufuncs.nextafter :py~ufuncs.rad2deg :py~ufuncs.radians :py~ufuncs.real :py~ufuncs.rint :py~ufuncs.sign :py~ufuncs.signbit :py~ufuncs.sin :py~ufuncs.sinh :py~ufuncs.sqrt :py~ufuncs.square :py~ufuncs.tan :py~ufuncs.tanh :py~ufuncs.trunc
open_dataset open_mfdataset open_rasterio open_zarr Dataset.to_netcdf Dataset.to_zarr save_mfdataset Dataset.to_array Dataset.to_dataframe Dataset.to_dask_dataframe Dataset.to_dict Dataset.from_dataframe Dataset.from_dict Dataset.close Dataset.compute Dataset.persist Dataset.load Dataset.chunk Dataset.filter_by_attrs Dataset.info
open_dataarray DataArray.to_dataset DataArray.to_netcdf DataArray.to_pandas DataArray.to_series DataArray.to_dataframe DataArray.to_index DataArray.to_masked_array DataArray.to_cdms2 DataArray.to_iris DataArray.from_iris DataArray.to_dict DataArray.from_series DataArray.from_cdms2 DataArray.from_dict DataArray.close DataArray.compute DataArray.persist DataArray.load DataArray.chunk
core.groupby.DataArrayGroupBy core.groupby.DataArrayGroupBy.apply core.groupby.DataArrayGroupBy.reduce core.groupby.DatasetGroupBy core.groupby.DatasetGroupBy.apply core.groupby.DatasetGroupBy.reduce
core.rolling.DataArrayRolling core.rolling.DataArrayRolling.construct core.rolling.DataArrayRolling.reduce core.rolling.DatasetRolling core.rolling.DatasetRolling.construct core.rolling.DatasetRolling.reduce
Resample objects also implement the GroupBy interface (methods like apply(), reduce(), mean(), sum(), etc.).
core.resample.DataArrayResample core.resample.DataArrayResample.asfreq core.resample.DataArrayResample.backfill core.resample.DataArrayResample.interpolate core.resample.DataArrayResample.nearest core.resample.DataArrayResample.pad core.resample.DatasetResample core.resample.DatasetResample.asfreq core.resample.DatasetResample.backfill core.resample.DatasetResample.interpolate core.resample.DatasetResample.nearest core.resample.DatasetResample.pad
CFTimeIndex
cftime_range
DataArray.plot plot.plot plot.contourf plot.contour plot.hist plot.imshow plot.line plot.pcolormesh plot.FacetGrid
testing.assert_equal testing.assert_identical testing.assert_allclose
MergeError SerializationWarning
Dataset.variables DataArray.variable Variable IndexVariable as_variable register_dataset_accessor register_dataarray_accessor
These backends provide a low-level interface for lazily loading data from external file-formats or protocols, and can be manually invoked to create arguments for the from_store and dump_to_store Dataset methods:
backends.NetCDF4DataStore backends.H5NetCDFStore backends.PydapDataStore backends.ScipyDataStore backends.FileManager backends.CachingFileManager backends.DummyFileManager