Skip to main content

Scientific colormaps for making accessible, informative and 'cmashing' plots

Project description

PyPI - Latest Release PyPI - Python Versions Travis CI - Build Status AppVeyor - Build Status ReadTheDocs - Build Status CodeCov - Coverage Status JOSS - Submission Status

CMasher: Scientific colormaps for making accessible, informative and cmashing plots

The CMasher package provides a collection of scientific colormaps to be used by different Python packages and projects, mainly in combination with matplotlib, showcased in the online documentation. The colormaps in CMasher are all designed to be perceptually uniform sequential using the viscm package; most of them are color-vision deficiency friendly; and they cover a wide range of different color combinations to accommodate for most applications. It offers several alternatives to commonly used colormaps, like chroma and rainforest for jet; sunburst for hot; neutral for binary; and fusion and redshift for coolwarm. If you cannot find your ideal colormap, then please open an issue, provide the colors and/or style you want, and I will try to create one to your liking! Let’s get rid of all bad colormaps in the world together!

If you use CMasher for your work, then please star the repo, such that I can keep track of how many users it has and more easily raise awareness of bad colormaps. Additionally, if you use CMasher as part of your workflow in a scientific publication, please consider citing the CMasher paper (BibTeX: cmr.get_bibtex).

Colormap overview

Below is an overview of all the colormaps that are currently in CMasher (made with the cmr.create_cmap_overview() function). For more information, see the online documentation.

CMasher Colormap Overview

Installation & Use

How to install

CMasher can be easily installed by either cloning the repository and installing it manually:

$ git clone https://github.com/1313e/CMasher
$ cd CMasher
$ pip install .

or by installing it directly from PyPI with:

$ pip install cmasher

CMasher can now be imported as a package with import cmasher as cmr.

Example use

The colormaps shown above can be accessed by simply importing CMasher. This makes them available in the cmasher module, in addition to registering them in matplotlib’s cm module (with added 'cmr.' prefix to avoid name clashes). So, for example, if one were to use the rainforest colormap, this could be done with:

# Import CMasher to register colormaps
import cmasher as cmr

# Import packages for plotting
import matplotlib.pyplot as plt
import numpy as np

# Access rainforest colormap through CMasher or MPL
cmap = cmr.rainforest                   # CMasher
cmap = plt.get_cmap('cmr.rainforest')   # MPL

# Generate some data to plot
x = np.random.rand(100)
y = np.random.rand(100)
z = x**2+y**2

# Make scatter plot of data with colormap
plt.scatter(x, y, c=z, cmap=cmap, s=300)
plt.show()

For other use-cases, see the online documentation.

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

cmasher-1.4.1.tar.gz (274.8 kB view details)

Uploaded Source

Built Distributions

cmasher-1.4.1-py3-none-any.whl (281.3 kB view details)

Uploaded Python 3

cmasher-1.4.1-py2-none-any.whl (281.3 kB view details)

Uploaded Python 2

File details

Details for the file cmasher-1.4.1.tar.gz.

File metadata

  • Download URL: cmasher-1.4.1.tar.gz
  • Upload date:
  • Size: 274.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/2.7.15

File hashes

Hashes for cmasher-1.4.1.tar.gz
Algorithm Hash digest
SHA256 a1f9725b8432aa486a625a3e419af659df9ef78f558a92378a9048ff09e1a2bf
MD5 223ffbbe52ea6696ba06f480a7787cfe
BLAKE2b-256 3840d7b600272abaf215f8014189a7db9a52da2dcd740636b583ea6d6758a2eb

See more details on using hashes here.

File details

Details for the file cmasher-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: cmasher-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 281.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.8+

File hashes

Hashes for cmasher-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3cd9d407a0148021217cdf25f96aa3959e38b6a4fd878d16ff6343f95f002ad4
MD5 3ea6b5c53918b83729146bda7f0d9a37
BLAKE2b-256 2ffeaa0c7ff1660f2159c345310972779104492e06ad8058f559347ae395d412

See more details on using hashes here.

File details

Details for the file cmasher-1.4.1-py2-none-any.whl.

File metadata

  • Download URL: cmasher-1.4.1-py2-none-any.whl
  • Upload date:
  • Size: 281.3 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/2.7.15

File hashes

Hashes for cmasher-1.4.1-py2-none-any.whl
Algorithm Hash digest
SHA256 3e3a55f4f6d9d3362ea6810180f6c02fc01e27f11641507c0f9741ab1faef75c
MD5 fc1c70927a0b0a0d3b1341b066508915
BLAKE2b-256 d1d508ecc78988d21037585d64cfe15e29d1cab837b77ecf588efe6f70d645b9

See more details on using hashes here.

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