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

Examples

Using the :class`~colormap.colors.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. colors