Skip to main content

Opinionated xarray accessor for choosing colormaps

Project description

xcmocean

Build Status Code Coverage License:MIT Documentation Status Code Style Status Conda Version Python Package Index

xarray accessor for automating choosing colormaps, aimed at geosciences.

Also optional dependence on cf-xarray.


Project based on the cookiecutter science project template.

Installation:

You can pip install from PyPI:

pip install xcmocean

or install from conda-forge with

conda install -c conda-forge 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.

Source Distribution

xcmocean-0.3.2.tar.gz (495.9 kB view hashes)

Uploaded Source

Built Distribution

xcmocean-0.3.2-py3-none-any.whl (5.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page