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.4.0.tar.gz (891.8 kB view details)

Uploaded Source

Built Distribution

cmap-0.4.0-py3-none-any.whl (937.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cmap-0.4.0.tar.gz
Algorithm Hash digest
SHA256 6d93e8d01502f507ca8a83b76156d52b26f737f488a89154498429cad57ac1fb
MD5 245ffd1c7d6448a11ece2c11503f761e
BLAKE2b-256 d850d1286f03f8afd169800e79310c89014ba4f281b008c1f71cb62d1d909204

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cmap-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e54d87aa13181ad6bd2372d2930b8b0851776619077d9989fe42e3255f938f17
MD5 30517343825b61a0e3b5d73e32abdeea
BLAKE2b-256 be66dafbc534cec8b4a16bd2d19e37a83ccffb7c68cc73bc684f2dd3777bed5f

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