API reference

This page contains a auto-generated summary of pint-xarray’s API.

pint_xarray.unit_registry	A wrapper class used to distribute changes to the application registry.
pint_xarray.setup_registry(registry)	set up the given registry for use with pint_xarray

Dataset

xarray.Dataset.pint.loc

Unit-aware attribute for indexing

xarray.Dataset.pint.quantify([units, ...])	Attach units to the variables of the Dataset.
xarray.Dataset.pint.dequantify([format])	Convert units from the Dataset to string attributes.
xarray.Dataset.pint.interp([coords, method, ...])	unit-aware version of interp
xarray.Dataset.pint.interp_like(other[, ...])	unit-aware version of interp_like
xarray.Dataset.pint.reindex([indexers, ...])	unit-aware version of reindex
xarray.Dataset.pint.reindex_like(other[, ...])	unit-aware version of reindex_like
xarray.Dataset.pint.drop_sel([labels, errors])	unit-aware version of drop_sel
xarray.Dataset.pint.sel([indexers, method, ...])	unit-aware version of sel
xarray.Dataset.pint.to([units])	convert the quantities in a Dataset
xarray.Dataset.pint.chunk(chunks[, ...])	unit-aware version of chunk
xarray.Dataset.pint.ffill(dim[, limit])	unit-aware version of ffill
xarray.Dataset.pint.bfill(dim[, limit])	unit-aware version of bfill
xarray.Dataset.pint.interpolate_na([dim, ...])	unit-aware version of interpolate_na

DataArray

xarray.DataArray.pint.loc	Unit-aware attribute for indexing
xarray.DataArray.pint.magnitude	the magnitude of the data or the data itself if not a quantity.
xarray.DataArray.pint.units	the units of the data or None if not a quantity.
xarray.DataArray.pint.dimensionality	get the dimensionality of the data or None if not a quantity.
xarray.DataArray.pint.registry

xarray.DataArray.pint.quantify([units, ...])	Attach units to the DataArray.
xarray.DataArray.pint.dequantify([format])	Convert the units of the DataArray to string attributes.
xarray.DataArray.pint.interp([coords, ...])	unit-aware version of interp
xarray.DataArray.pint.interp_like(other[, ...])	unit-aware version of interp_like
xarray.DataArray.pint.reindex([indexers, ...])	unit-aware version of reindex
xarray.DataArray.pint.reindex_like(other[, ...])	unit-aware version of reindex_like
xarray.DataArray.pint.drop_sel([labels, errors])	unit-aware version of drop_sel
xarray.DataArray.pint.sel([indexers, ...])	unit-aware version of sel
xarray.DataArray.pint.to([units])	convert the quantities in a DataArray
xarray.DataArray.pint.chunk(chunks[, ...])	unit-aware version of chunk
xarray.DataArray.pint.ffill(dim[, limit])	unit-aware version of ffill
xarray.DataArray.pint.bfill(dim[, limit])	unit-aware version of bfill
xarray.DataArray.pint.interpolate_na([dim, ...])	unit-aware version of interpolate_na

Testing

pint_xarray.testing.assert_units_equal(a, b)

assert that the units of two xarray objects are equal