Drop in wrapper for gsw which adds CF standard name and units attributes to xarray results
Project description
gsw-xarray is a wrapper for gsw python that will add CF attributes to xarray.DataArray outputs. It is meant to be a drop in wrapper for the upstream GSW-Python library and will only add these attributes if one argument to a function is an xarray.DataArray.
You can find the documentation on gsw-xarray.readthedocs.io.
Usage
import gsw_xarray as gsw
# Create a xarray.Dataset
import numpy as np
import xarray as xr
ds = xr.Dataset()
id = np.arange(3)
ds['id'] = xr.DataArray(id, coords={'id':id})
ds['CT'] = ds['id'] * 10
ds['CT'].attrs = {'standard_name':'sea_water_conservative_temperature'}
ds['SA'] = ds['id'] * 0.1 + 34
ds['SA'].attrs = {'standard_name':'sea_water_absolute_salinity'}
# Apply gsw functions
sigma0 = gsw.sigma0(SA=ds['SA'], CT=ds['CT'])
print(sigma0.attrs)Outputs
{'standard_name': 'sea_water_sigma_t', 'units': 'kg/m^3'}
Don’t worry about usage with non xarray array objects, just use in all places you would the upstream library:
sigma0 = gsw.sigma0(id * 10, id * 0.1 + 34)
print(type(sigma0), sigma0)Outputs
<class 'numpy.ndarray'> [-5.08964499 2.1101098 9.28348219]
Installation
Pip
pip install gsw_xarrayConda
For the moment gsw-xarray is not released in conda-forge, so you’ll need to install via pip: activate your conda environment, and then use pip install gsw_xarray.
Pipenv
Inside a pipenv environment: pipenv install gsw_xarray.
Contributor guide
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. If you notice a bug or are missing a feature, fell free to open an issue in the GitHub issues page.
In order to contribute to gsw-xarray, please fork the repository and submit a pull request. A good step by step tutorial for starting with git can be found in the xarray contributor guide. A main difference is that we do not use conda as python environment, but poetry.
Set up the environment
You will first need to install poetry. Then go to your local clone of gsw-xarray and launch installation:
cd /path/to/your/gsw-xarray
poetry installYou can then activate the environment by launching a shell within the virtual environment:
poetry shellYou can check that the tests pass locally:
pytest gsw_xarray/testsRelease (for maintainers only)
TODO…
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gsw_xarray-0.2.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d72202fb8b3df73b6581fada5a9e31f4201d2495bef9e5fd01d44eeb6cae681d |
|
| MD5 | 22e3d51e223d6dc302f9e587fc5e8b73 |
|
| BLAKE2b-256 | 68e21ac0bf44e5ec300108af799c9199fbfac9f96a8fb3707c8b3ed9247aa992 |
