Metadata-Version: 2.1
Name: cmcrameri
Version: 1.4
Summary: Perceptually uniform colormaps by Fabio Crameri
Home-page: https://github.com/callumrollo/cmcrameri
Author: Callum Rollo
Author-email: c.rollo@outlook.com
License: MIT
Download-URL: https://github.com/callumrollo/cmcrameri/v_1.4.tar.gz
Keywords: colormaps,oceanography,plotting,visualization
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

![Python package](https://github.com/callumrollo/cmcrameri/workflows/Python%20package/badge.svg)

[![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)]()
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)]()
[![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg)]()
[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)]()

[![Downloads](https://pepy.tech/badge/cmcrameri)](https://pepy.tech/project/cmcrameri)     (PyPI)

[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/cmcrameri.svg)](https://anaconda.org/conda-forge/cmcrameri) (conda-forge)

# cmcrameri

This is a Python wrapper around Fabio Crameri's perceptually uniform colormaps.

<https://www.fabiocrameri.ch/colourmaps/>

All credit for creating the colormaps to Fabio.
Any errors in the Python implementation of colormaps are my own.

This version is based on *Scientific colour maps* [version 7.0](https://zenodo.org/record/4491293) (02.02.2021).

### Install

With `pip`:
```
pip install cmcrameri
```

With `conda`:
```
conda install -c conda-forge cmcrameri
```

### Usage example

```python
import cmcrameri.cm as cmc
import matplotlib.pyplot as plt
import numpy as np

x = np.linspace(0, 1, 100)[np.newaxis, :]

plt.imshow(x, aspect='auto', cmap=cmc.batlow)
plt.axis('off')
plt.show()
```
Alternatively, the registered name string can be used.
```python
import cmrameri  # required in order to register the colormaps with Matplotlib
...
plt.imshow(x, aspect='auto', cmap='cmc.batlow')
```

### Extra instructions

You can access all the core colormaps from Fabio Crameri's list by `cmcrameri.cm.<colormapname>`.

You can use tab autocompletion on `cmcrameri.cm` if your editor supports it.

For a reversed colormap, append `_r` to the colormap name.

Categorical colormaps have the suffix `S`.

For an image of all the available colormaps without leaving the comfort of your Python session:
```python
from cmcrameri import show_cmaps

show_cmaps()
```
![Figure demonstrating the colormaps](cmcrameri/colormaps.png)

The original colormap text files are shipped as part of the package.
Find them on your system with:
```python
from cmcrameri.cm import paths

paths
```

### License
This work is licensed under an [MIT license](https://mit-license.org/).


