Metadata-Version: 2.1
Name: colour-hdri
Version: 0.1.5
Summary: Colour - HDRI
Home-page: http://github.com/colour-science/colour-hdri
Author: Colour Developers
Author-email: colour-science@googlegroups.com
License: New BSD License - http://opensource.org/licenses/BSD-3-Clause
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: colour-science (>=0.3.12)
Requires-Dist: recordclass (>=0.4)
Provides-Extra: development
Requires-Dist: sphinx (>=1.6.6) ; extra == 'development'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'development'
Requires-Dist: sphinx-rtd-theme ; extra == 'development'
Requires-Dist: coverage (>=3.7.1) ; extra == 'development'
Requires-Dist: flake8 (>=2.1.0) ; extra == 'development'
Requires-Dist: nose (>=1.3.4) ; extra == 'development'
Requires-Dist: invoke ; extra == 'development'
Requires-Dist: restructuredtext-lint ; extra == 'development'
Requires-Dist: twine ; extra == 'development'
Requires-Dist: yapf (==0.23.0) ; extra == 'development'
Requires-Dist: biblib-simple ; extra == 'development'
Provides-Extra: docs
Requires-Dist: sphinx (>=1.6.6) ; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: optional
Requires-Dist: rawpy (>=0.5.0) ; 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 - HDRI
=============

..  image:: https://raw.githubusercontent.com/colour-science/colour-hdri/master/docs/_static/Radiance_001.png

.. start-badges

|travis| |coveralls| |codacy| |version|

.. |travis| image:: https://img.shields.io/travis/colour-science/colour-hdri/develop.svg?style=flat-square
    :target: https://travis-ci.org/colour-science/colour-hdri
    :alt: Develop Build Status
.. |coveralls| image:: http://img.shields.io/coveralls/colour-science/colour-hdri/develop.svg?style=flat-square
    :target: https://coveralls.io/r/colour-science/colour-hdri
    :alt: Coverage Status
.. |codacy| image:: https://img.shields.io/codacy/grade/290ad2c23b0749b99a1d548ca47d9062/develop.svg?style=flat-square
    :target: https://www.codacy.com/app/colour-science/colour-hdri
    :alt: Code Grade
.. |version| image:: https://img.shields.io/pypi/v/colour-hdri.svg?style=flat-square
    :target: https://pypi.python.org/pypi/colour-hdri
    :alt: Package Version

.. end-badges

A `Python <https://www.python.org/>`_ package implementing various
HDRI / Radiance image processing algorithms.

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

Features
--------

The following features are available:

-   HDRI / Radiance Image Generation
-   Debevec (1997) Camera Response Function Computation
-   Grossberg (2003) Histogram Based Image Sampling
-   Variance Minimization Light Probe Sampling
-   Global Tonemapping Operators
-   Adobe DNG SDK Colour Processing
-   Absolute Luminance Calibration
-   Raw Processing Helpers

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

Because of their size, the resources dependencies needed to run the various
examples and unit tests are not provided within the Pypi package. They are
separately available as
`Git Submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`_
when cloning the
`repository <https://github.com/colour-science/colour-hdri>`_.

Primary Dependencies
^^^^^^^^^^^^^^^^^^^^

**Colour - HDRI** requires various dependencies in order to run:

-  `Python 2.7 <https://www.python.org/download/releases/>`_ or
   `Python 3.5 <https://www.python.org/download/releases/>`_
-  `Colour Science <https://www.colour-science.org>`_
-  `NumPy <http://www.numpy.org/>`_
-  `OpenImageIO <https://github.com/OpenImageIO/oiio>`_

Optional Features Dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

-   `colour-demosaicing <https://github.com/colour-science/colour-demosaicing>`_
-   `Adobe DNG Converter <https://www.adobe.com/support/downloads/product.jsp?product=106&platform=Mac>`_
-   `dcraw <https://www.cybercom.net/~dcoffin/dcraw/>`_
-   `ExifTool <http://www.sno.phy.queensu.ca/~phil/exiftool/>`_
-   `rawpy <https://github.com/neothemachine/rawpy>`_

Pypi
^^^^

Once the dependencies satisfied, **Colour - HDRI** can be installed from
the `Python Package Index <http://pypi.python.org/pypi/colour-hdri>`_ by
issuing this command in a shell::

	pip install colour-hdri

The optional features dependencies are installed as follows::

    pip install 'colour-hdri[optional]'

The figures plotting dependencies are installed as follows::

    pip install 'colour-hdri[plotting]'

The tests suite dependencies are installed as follows::

    pip install 'colour-hdri[tests]'

The documentation building dependencies are installed as follows::

    pip install 'colour-hdri[docs]'

The overall development dependencies are installed as follows::

    pip install 'colour-hdri[development]'

Usage
-----

API
^^^

The main reference for `Colour - HDRI <https://github.com/colour-science/colour-hdri>`_
is the Sphinx `API Reference <https://colour-hdri.readthedocs.io/en/latest/api.html>`_.

Examples
^^^^^^^^

Various usage examples are available from the
`examples directory <https://github.com/colour-science/colour-hdri/tree/master/colour_hdri/examples>`_.

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

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

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

The bibliography is available in the repository in
`BibTeX <https://github.com/colour-science/colour-hdri/blob/develop/BIBLIOGRAPHY.bib>`_
format.

About
-----

| **Colour - HDRI** by Colour Developers
| Copyright © 2015-2019 – 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-hdri <http://github.com/colour-science/colour-hdri>`_


