Skip to main content

Scientific colormaps for python, without dependencies

Project description

cmap

License PyPI Conda Python Version CI codecov Documentation Status

Scientific colormaps for python, with no dependencies beyond numpy.

With cmap, you can use any of the colormaps from matplotlib, cmocean, colorbrewer, crameri, seaborn, and a host of other collections in your python code, without having to install matplotlib or any other dependencies beyond numpy.

:book: See the complete catalog

There are a number of python libraries that provide or require colormaps or basic color support, but they all either depend on matplotlib, provide a specialized set of colormaps intended to extend those provided by matplotlib, or roll their own colormap solution that vendors/duplicates other libraries.

cmap is a lightweight, library that provides a large collection of colormaps with no dependencies beyond numpy. It provides exports to a number of known third-party colormap objects, allowing it to be used across a wide range of python visualization libraries. The intention is to provide a library that can be used by any python library that needs colormaps, without forcing the user to install matplotlib (while still being compatible with matplotlib and other libraries that use matplotlib colormaps).

cmap is strictly typed and fully tested, with a focus on good developer experience.

Install

pip install cmap
conda install -c conda-forge cmap

Usage

See Documentation for full details.

cmap.Color

The cmap.Color object is a simple wrapper around a tuple of RGBA scalars, with a few convenience methods for converting to other color objects.

from cmap import Color

red = Color("red")  # or a variety of other "color like" inputs

cmap.Colormap

The cmap.Colormap object is a callable that can map a scalar value (or numpy array of values) to an RGBA color (or a numpy array of RGBA colors). API is intended to mimic the behavior of a matplotlib.colors.Colormap object (without requiring matplotlib)

In [1]: import cmap

# or a variety of other "colormap like" inputs
In [2]: cmap1 = cmap.Colormap(["red", "green", "blue"])

In [3]: cmap1(np.linspace(0,1,5))
Out[3]:
array([[1.        , 0.        , 0.        , 1.        ],
       [0.50393701, 0.24900417, 0.        , 1.        ],
       [0.        , 0.50196078, 0.        , 1.        ],
       [0.        , 0.24900417, 0.50393701, 1.        ],
       [0.        , 0.        , 1.        , 1.        ]])

Note that the input array must be normalized from 0-1, so if you're applying a colormap to an integer array (like an image) you must apply any contrast limits and rescale to 0-1 before passing it to a Colormap.

Third Party Library Support

The cmap.Colormap object has convenience methods that export it to a number of known third-party colormap objects, including:

See documentation for details.

If you would like to see support added for a particular library, please open an issue or PR.

Alternatives

Other libraries providing colormaps:

References and Further reading

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

cmap-0.3.0.tar.gz (591.0 kB view details)

Uploaded Source

Built Distribution

cmap-0.3.0-py3-none-any.whl (634.6 kB view details)

Uploaded Python 3

File details

Details for the file cmap-0.3.0.tar.gz.

File metadata

  • Download URL: cmap-0.3.0.tar.gz
  • Upload date:
  • Size: 591.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for cmap-0.3.0.tar.gz
Algorithm Hash digest
SHA256 01ddd3f7b3abc42c3c126d2a590e8c03615a32be2b184ba68a69a2798f4fe460
MD5 79a84179d34a35fe765091fc9bfeaf75
BLAKE2b-256 1d9754edd701b113984bebb583df87c43f511c9fc27ba37ac95f5c5fe06a38c9

See more details on using hashes here.

File details

Details for the file cmap-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: cmap-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 634.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for cmap-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1cafd3085c7635ab04c958b2421442c3306340f48cc8ad491087cd5fe12ddbc3
MD5 4a162a9f38f94990104eed57467f78ae
BLAKE2b-256 b590e438d76f99df7894c0bc2810ccc563e4e403364ea2efa324562ef5c2072e

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