Installation Guide

Primary Dependencies

• python >= 3.9, < 3.12

• imageio >= 2, < 3

• numpy >= 1.20, < 2

• scipy >= 1.7, < 2

Optional, Meshing and Plotting Dependencies

• graphviz >= 2, < 3

• matplotlib >= 3.4, != 3.5.0, != 3.5.1

• networkx >= 2.6, < 3

• opencolorio >= 2, < 3

• openimageio >= 2, < 3

• pandas >= 1.3, < 2

• pygraphviz >= 1, < 2

• tqdm >= 4, < 5

• trimesh >= 3, < 4

Development Dependencies

• biblib-simple

• black

• blackdoc

• coverage

• coveralls

• flake8

• flynt

• invoke

• jupyter

• mypy

• pre-commit

• pydata-sphinx-theme

• pydocstyle

• pytest

• pytest-cov

• pyupgrade

• restructuredtext-lint

• sphinx

• sphinxcontrib-bibtex

• toml

• twine

Pypi

Colour can be easily installed from the Python Package Index by issuing this command in a shell:

pip install --user colour-science

This asciicast demonstrates how to generate a pristine Python VirtualEnv environment for Colour:

The optional features dependencies are installed as follows:

pip install --user 'colour-science[optional]'

The development dependencies are installed as follows:

pip install --user 'colour-science[development]'

The figure plotting dependencies are installed as follows:

pip install --user 'colour-science[graphviz, plotting]'

The meshing dependencies for gamut computations are installed as follows:

pip install --user 'colour-science[meshing]'

If you wish to read OpenEXR files, you will need to install the FreeImage plugin for Imageio as follows:

python -c "import imageio;imageio.plugins.freeimage.download()"

Continuum Analytics Anaconda

Colour is also available for Anaconda from Continuum Analytics via conda-forge:

conda install -c conda-forge colour-science

This asciicast demonstrates how to generate a pristine Python conda environment for Colour:

Github

Alternatively, you can also install directly from Github source repository:

git clone git://github.com/colour-science/colour.git
cd colour
pip install --user .

Poetry

Colour adopts Poetry to help managing its dependencies, this is the recommended way to get started with Colour development.

Assuming python >= 3.8, < 3.11 is available on your system, the development dependencies are installed with Poetry as follows:

git clone git://github.com/colour-science/colour.git
cd colour
poetry install --extras "meshing optional plotting"

If Graphviz is available on your system, you might issue the following commands instead of the aforementioned ones:

git clone git://github.com/colour-science/colour.git
cd colour
poetry install --extras "graphviz meshing optional plotting"

Those commands will create a Virtual Environment in which all the required python packages will be installed.

Tools can then be run as follows:

poetry run invoke -l

or alternatively:

source $(poetry env info -p)/bin/activate
invoke -l

Vagrant

An easy way to get all the pre-requisites at once is to use our colour-vagrant environment for Vagrant.

Please refer to the dedicated blog post for more details about its deployment: PyCharm, Vagrant, Ansible & Poetry