Metadata-Version: 2.0
Name: colour-science
Version: 0.3.10
Summary: Colour Science for Python
Home-page: http://github.com/colour-science/colour
Author: Colour Developers
Author-email: colour-science@googlegroups.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Dist: scipy (>=0.16.0)
Requires-Dist: six (>=1.10.0)
Provides-Extra: docs
Requires-Dist: sphinx (>=1.2.2); extra == 'docs'
Provides-Extra: optional
Requires-Dist: yapf; extra == 'optional'
Provides-Extra: plotting
Requires-Dist: matplotlib (>=1.3.1); extra == 'plotting'
Provides-Extra: tests
Requires-Dist: coverage (>=3.7.1); extra == 'tests'
Requires-Dist: flake8 (>=2.1.0); extra == 'tests'
Requires-Dist: nose (>=1.3.4); extra == 'tests'

Colour Science for Python
=========================

..  image:: https://raw.githubusercontent.com/colour-science/colour-branding/master/images/Colour_Logo_Medium_001.png

.. start-badges

.. list-table::
    :stub-columns: 1

    * - Social
      - |gitter|
    * - Status
      - |waffle| |travis| |coveralls| |scrutinizer| |landscape| |gemnasium|
    * - Package
      - |version|
    * - Citation
      - |zenodo|

.. |gitter| image:: https://img.shields.io/gitter/room/colour-science/colour.svg
    :target: https://gitter.im/colour-science/colour/
    :alt: Gitter
.. |waffle| image:: https://badge.waffle.io/colour-science/colour.svg?label=ready&title=Ready
    :target: https://github.com/colour-science/colour/issues
    :alt: Issues Ready
.. |travis| image:: https://img.shields.io/travis/colour-science/colour/develop.svg
    :target: https://travis-ci.org/colour-science/colour
    :alt: Develop Build Status
.. |coveralls| image:: http://img.shields.io/coveralls/colour-science/colour/develop.svg
    :target: https://coveralls.io/r/colour-science/colour
    :alt: Coverage Status
.. |scrutinizer| image:: https://img.shields.io/scrutinizer/g/colour-science/colour/develop.svg
    :target: https://scrutinizer-ci.com/g/colour-science/colour/
    :alt: Code Quality
.. |landscape| image:: https://landscape.io/github/colour-science/colour/master/landscape.png
    :target: https://landscape.io/github/colour-science/colour
    :alt: Code Quality
.. |gemnasium| image:: https://img.shields.io/gemnasium/colour-science/colour.svg
    :target: https://gemnasium.com/colour-science/colour
    :alt: Dependencies Status
.. |version| image:: https://badge.fury.io/py/colour-science.svg
    :target: https://pypi.python.org/pypi/colour-science
    :alt: Package Version
.. |zenodo| image:: https://zenodo.org/badge/doi/10.5281/zenodo.821825.png
    :target: http://dx.doi.org/10.5281/zenodo.821825
    :alt: DOI

.. end-badges

`Colour <https://github.com/colour-science/colour>`_ is a
`Python <https://www.python.org/>`_ colour science package implementing a
comprehensive number of colour theory transformations and algorithms.

It is open source and freely available under the
`New BSD License <http://opensource.org/licenses/BSD-3-Clause>`_ terms.

Features
--------

`Colour <https://github.com/colour-science/colour>`_ features a rich dataset
and collection of objects, please see the
`features <http://colour-science.org/features/>`_ page for more information.

Installation
------------

The detailed installation procedure is described in the
`Installation Guide <http://colour-science.org/installation-guide/>`_.

`Anaconda <https://www.continuum.io/downloads>`_ 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.

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

..  image:: https://raw.githubusercontent.com/colour-science/colour-branding/master/screencasts/Colour_Conda_Installation.gif

Usage
-----

At its most basic, `Colour <https://github.com/colour-science/colour>`_ only requires
to be imported:

..  image:: https://raw.githubusercontent.com/colour-science/colour-branding/master/screencasts/Colour_Science_for_Python.gif

The two main references for `Colour <https://github.com/colour-science/colour>`_
usage are the complete Sphinx `API Reference <http://colour.readthedocs.io/en/latest/>`_
and the `Jupyter Notebooks <http://nbviewer.jupyter.org/github/colour-science/colour-notebooks/blob/master/notebooks/colour.ipynb>`_
with detailed historical and theoretical context and images:

-   `API Reference <http://colour.readthedocs.io/en/latest/>`_
-   `Jupyter Notebooks <http://nbviewer.jupyter.org/github/colour-science/colour-notebooks/blob/master/notebooks/colour.ipynb>`_

Contributing
------------

If you would like to contribute to `Colour <https://github.com/colour-science/colour>`_,
please refer to the following `Contributing <http://colour-science.org/contributing/>`_ guide.

Changes
-------

The changes are viewable on the `Releases <https://github.com/colour-science/colour/releases>`_ page.

Bibliography
------------

The bibliography is available on the `Bibliography <http://colour-science.org/bibliography/>`_ page.

It is also viewable directly from the repository in either
`BibTeX <https://github.com/colour-science/colour/blob/develop/BIBLIOGRAPHY.bib>`_
format or `reStructuredText <https://github.com/colour-science/colour/blob/develop/BIBLIOGRAPHY.rst>`_.

About
-----

| **Colour** by Colour Developers - 2013-2017
| Copyright © 2013-2017 – Colour Developers – `colour-science@googlegroups.com <colour-science@googlegroups.com>`_
| This software is released under terms of New BSD License: http://opensource.org/licenses/BSD-3-Clause
| `http://github.com/colour-science/colour <http://github.com/colour-science/colour>`_


