Installation Guide

Dependencies

Colour requires various dependencies in order to run. Depending your usage you may not need to install all of them.

Optional Figures Plotting Dependencies

Documentation Building Dependencies

Unit Tests Dependencies

Optional Dependencies

Continuum Analytics Anaconda

Anaconda from Continuum Analytics is the Python distribution we use to develop Colour: it ships all the scientific dependencies we require and is easily deployed cross-platform.

Colour is available on conda and can be installed as follows:

conda install -c conda-forge colour-science

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

Pypi

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

Note

Because of the non deterministic order in which pip installs dependencies, SciPy will require NumPy to be installed first which can be performed as follows: pip install numpy
pip install 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 'colour-science[optional]'

The figures plotting dependencies are installed as follows:

pip install 'colour-science[plotting]'

The tests suite dependencies are installed as follows:

pip install 'colour-science[tests]'

The documentation building dependencies are installed as follows:

pip install 'colour-science[docs]'

Github

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

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

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, Fabric & Anaconda