https://github.com/xarray-contrib/pint-xarray

Interface for using pint with xarray, providing convenience accessors
https://github.com/xarray-contrib/pint-xarray

accessor pint xarray

Last synced: 9 days ago
JSON representation

Interface for using pint with xarray, providing convenience accessors

• Host: GitHub
• URL: https://github.com/xarray-contrib/pint-xarray
• Owner: xarray-contrib
• License: apache-2.0
• Created: 2020-04-07T10:21:19.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T20:48:25.000Z (about 2 months ago)
• Last Synced: 2024-09-17T02:14:49.468Z (about 2 months ago)
• Topics: accessor, pint, xarray
• Language: Python
• Homepage: https://pint-xarray.readthedocs.io/en/latest/
• Size: 310 KB
• Stars: 101
• Watchers: 8
• Forks: 12
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-meteo - pint-xarray

README

        
[![CI](https://github.com/xarray-contrib/pint-xarray/workflows/CI/badge.svg?branch=main)](https://github.com/xarray-contrib/pint-xarray/actions?query=branch%3Amain)

[![code coverage](https://codecov.io/gh/xarray-contrib/pint-xarray/branch/main/graph/badge.svg)](https://codecov.io/gh/xarray-contrib/pint-xarray)

[![docs](https://readthedocs.org/projects/pint-xarray/badge/?version=latest)](https://pint-xarray.readthedocs.io)

[![PyPI version](https://img.shields.io/pypi/v/pint-xarray.svg)](https://pypi.org/project/pint-xarray)

[![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)

[![conda-forge](https://img.shields.io/conda/vn/conda-forge/pint-xarray)](https://github.com/conda-forge/pint-xarray-feedstock)

# pint-xarray

A convenience wrapper for using [pint](https://pint.readthedocs.io) with

[xarray](https://xarray.pydata.org).

## Usage

To convert the variables of a `Dataset` to quantities:

```python

In [1]: import pint_xarray

   ...: import xarray as xr

In [2]: ds = xr.Dataset({"a": ("x", [0, 1, 2]), "b": ("y", [-3, 5, 1], {"units": "m"})})

   ...: ds

Out[2]:

Dimensions:  (x: 3, y: 3)

Dimensions without coordinates: x, y

Data variables:

    a        (x) int64 0 1 2

    b        (y) int64 -3 5 1

In [3]: q = ds.pint.quantify(a="s")

   ...: q

Out[3]:

Dimensions:  (x: 3, y: 3)

Dimensions without coordinates: x, y

Data variables:

    a        (x) int64 [s] 0 1 2

    b        (y) int64 [m] -3 5 1

```

to convert to different units:

```python

In [4]: c = q.pint.to({"a": "ms", "b": "km"})

   ...: c

Out[4]:

Dimensions:  (x: 3, y: 3)

Dimensions without coordinates: x, y

Data variables:

    a        (x) float64 [ms] 0.0 1e+03 2e+03

    b        (y) float64 [km] -0.003 0.005 0.001

```

to convert back to non-quantities:

```python

In [5]: d = c.pint.dequantify()

   ...: d

Out[5]:

Dimensions:  (x: 3, y: 3)

Dimensions without coordinates: x, y

Data variables:

    a        (x) float64 0.0 1e+03 2e+03

    b        (y) float64 -0.003 0.005 0.001

```

For more, see the [documentation](https://pint-xarray.readthedocs.io)