Metadata-Version: 2.1
Name: cmcrameri
Version: 1.3
Summary: Perceptually uniform colourmaps
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_01.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 colour maps

http://www.fabiocrameri.ch/colourmaps.php

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

This version is based on Scientific Colourmaps Version 7.0 (02.02.2021)

### Install

With pip:

`pip install cmcrameri`

With conda:

```
conda config --add channels conda-forge
conda install cmcrameri
```
### Usage example

```python
from cmcrameri import cm
import matplotlib.pyplot as plt
import numpy as np
x = np.linspace(0, 100, 100)[None, :]  
plt.imshow(x, aspect='auto', cmap=cm.batlow) # or any of the other colourmaps made by Fabio Crameri
plt.axis('off')
plt.show()
```
### Extra instructions
You can access all the core colourmaps from Fabio Crameri's list by `cm.<colormapname>`

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

For a reversed colourmap, append `_r` to the colourmap name

Categorical colormaps have the suffix `S`

For an image of all the available colourmaps without leaving the comfort of your Python session

```python
from cmcrameri.cm import show_cmaps 
show_cmaps()
```

To make the underlying RGB values available, the original text files are shipped as part of the package. Find them on your system with:
```python
from cmcrameri import cm
cm.paths
```

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



