Colormap

version:Python 2.7, 3.3, 3.4, 3.5, 3.6 contributions:Please join https://github.com/cokelaer/colormap issues:Please use https://github.com/cokelaer/colormap/issues notebook:Please see https://github.com/cokelaer/colormap/tree/master/notebooks

What is it ?

colormap package provides simple utilities to convert colors between RGB, HEX, HLS, HUV and a class to easily build colormaps for matplotlib. All matplotlib colormaps and some R colormaps are available altogether. The plot_colormap method (see below) is handy to quickly pick up a colormaps and the test_colormap function is useful to see/test a new colormap.

Installation

Prerequisites

You will need to install Python (linux and mac users should have it installed already). We recommend also to install ipython, which provides a more flexible shell alternative to the python shell itself. colormap requires matplotlib and easydev, which are available on pypi and installed automatically with this package.

Installation

Since colormap is available on PyPi, the following command should install the package and its dependencies automatically:

pip install colormap

colormap is also available on Conda (conda-forge):

conda install colormap

Examples

Using the Colormap class

Create your own colormap from red to green colors with intermediate color as whitish (diverging map from red to green):

from colormap import Colormap
c = Colormap()
mycmap = c.cmap_linear('red', 'white', 'green(w3c)')
c.test_colormap(mycmap)

(Source code, png, hires.png, pdf)

Using the aliases

Without creating an instance of Colormap, you can use these functions:

from colormap import cmap_builder, test_cmap
mycm = cmap_builder('red', 'black', 'yellow')
test_cmap(mycm)

(Source code, png, hires.png, pdf)

Visualise set of colormap

Another convenient feature is to look at a set of colormaps altogether:

c = Colormap()
c.plot_colormap('diverging')

Other set names are:

• sequentials2,
• misc
• diverging
• diverging_black
• qualitative

See user guide for details.

User Guide

• 1. Conventions
  • 1.1. hexadecimal
  • 1.2. normalisation
• 2. Codecs
  • 2.1. list
  • 2.2. format
• 3. Color class
• 4. colormap
  • 4.1. visualise colormaps
  • 4.2. Create a linear colormap
  • 4.3. Create a general colormap

Reference Guide

• 1. Reference guide
  • 1.1. colors
  • 1.2. cmap module
  • 1.3. xfree86 module