Skip to main content

A lightweight package for generating visually distinct colours.

Project description

distinctipy logo

tests build codecov DOI Documentation Status

distinctipy is a lightweight python package providing functions to generate colours that are visually distinct from one another.

Commonly available qualitative colormaps provided by the likes of matplotlib generally have no more than 20 colours, but for some applications it is useful to have many more colours that are clearly different from one another. distinctipy can generate lists of colours of any length, with each new colour added to the list being as visually distinct from the pre-existing colours in the list as possible.

Installation

distinctipy is designed for Python 3 and can be installed with pip by running:

pip install distinctipy

Alternatively clone the repo and install it locally:

git clone https://github.com/alan-turing-institute/distinctipy.git
cd distinctipy
pip install .

Optional Dependencies

Starting in version 1.2.1 distinctipy no longer bundles matplotlib, pandas or dev dependencies in the default installation. If you wish to view colours (e.g. with distinctipy.color_swatch) or examples you will need matplotlib and pandas installed. To do this, either install distinctipy with the optional flag:

pip install distinctipy[optional]

Or install them separately:

pip install matplotlib pandas

For developers, to install the stack needed to run tests, generate docs etc. use the [all] flag:

pip install distinctipy[all]

Usage and Examples

distinctipy can:

  • Generate N visually distinct colours: distinctipy.get_colors(N)
  • Generate colours that are distinct from an existing list of colours: distinctipy.get_colors(N, existing_colors)
  • Generate pastel colours: distinctipy.get_colors(N, pastel_factor=0.7)
  • Select black or white as the best font colour for any background colour: distinctipy.get_text_color(background_color)
  • Convert lists of colours into matplotlib colormaps: distinctipy.get_colormap(colors)
  • Invert colours: distinctipy.invert_colors(colors)
  • Nicely display generated colours: distinctipy.color_swatch(colors)
  • Compare distinctipy colours to other common colormaps: examples.compare_clusters() and examples.compare_colors()
  • Simulate how colours look for someone with colourblindness: colorblind.simulate_colors(colors, colorblind_type='Deuteranomaly')
  • Attempt to generate colours as distinct as possible for someone with colourblindness distinctipy.get_colors(N, existing_colors, colorblind_type="Deuteranomaly")

For example, to create and then display N = 36 visually distinct colours:

from distinctipy import distinctipy

# number of colours to generate
N = 36

# generate N visually distinct colours
colors = distinctipy.get_colors(N)

# display the colours
distinctipy.color_swatch(colors)

More detailed usage and example output can be found in the notebook examples.ipynb and examples gallery.

References

distinctipy was heavily influenced and inspired by several web sources and stack overflow answers. In particular:

Citing distinctipy

If you would like to cite distinctipy, please refer to the upload of the package on Zenodo: https://doi.org/10.5281/zenodo.3985191

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

distinctipy-1.2.2.tar.gz (27.7 kB view hashes)

Uploaded source

Built Distribution

distinctipy-1.2.2-py3-none-any.whl (25.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page