Skip to main content

Opinionated xarray accessor for choosing colormaps

Project description

xcmocean

Build Status Code Coverage License:MIT Documentation Status Code Style Status

xarray accessor for automating choosing colormaps, aimed at geosciences. Documentation at: https://xcmocean.readthedocs.io.

Also optional dependence on cf-xarray.


<small>Project based on the cookiecutter science project template.</small>

Installation:

You can pip install direct from this github repo. This is probably the easiest way to do install at the moment.

pip install git+git://github.com/pangeo-data/xcmocean

It is also now available on PyPI so you can simply pip install xcmocean.

Example usage:

import xcmocean

ds.salt.cmo.contourf(x='lon', y='lat')

which would make a contourf plot of the ds.salt data using the cmocean haline colormap. More examples in the docs.

Dev installation for local work

Clone the repo:

$ git clone https://github.com/pangeo-data/xcmocean.git

In the xcmocean directory, install conda environment:

$ conda env create -f environment.yml

To also develop this package, install additional packages with:

$ conda install --file requirements-dev.txt

To then check code before committing and pushing it to github, locally run

$ pre-commit run --all-files

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for xcmocean, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size xcmocean-0.2.1.tar.gz (495.9 kB) File type Source Python version None Upload date Hashes View
Filename, size xcmocean-0.2.1-py3-none-any.whl (6.0 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page