xarray-quantity

xarray extension which supports astropy quantities.

Features

This library provides:

• xarray DataArray and Dataset with units.

Installation

pip install xarray-quantity

Usage

QuantityArray

To create a DataArray with units, use QuantityArray class. The arguments are compatible with DataArray, except the keyword argument unit.

>>> qa = QuantityArray([1, 2, 3, 4, 5], unit="km")
>>> qa.data
[1, 2, 3, 4, 5] km
>>> qa.unit
km

QuantitySet

To create a Dataset with units, use QuantitySet class. This class also has compatibility with xarray's Dataset.

>>> arrays = {
...     "qa1": QuantityArray([1, 2, 3, 4, 5], unit="km/s"),
...     "qa2": QuantityArray([11, 12, 13, 14, 15]),
...     "da3": xr.DataArray([111, 112, 113, 114, 115])
... }
>>> qs = QuantitySet(arrays)
>>> qs.qa1.data
[1, 2, 3, 4, 5] km / s
>>> qs.qa2
xarray.QuantityArray 'qa2' (dim_0: 5)
<Quantity [11., 12., 13., 14., 15.] km / s>
Coordinates: (0)
Attributes: (0)

This library is using Semantic Versioning.