colour.utilities.describe_environment

colour.utilities.describe_environment(runtime_packages=True, development_packages=False, extras_packages=False, print_environment=True, **kwargs)[source]

Describes Colour running environment, i.e. interpreter, runtime and development packages.

Parameters
  • runtime_packages (bool, optional) – Whether to return the runtime packages versions.

  • development_packages (bool, optional) – Whether to return the development packages versions.

  • extras_packages (bool, optional) – Whether to return the extras packages versions.

  • print_environment (bool, optional) – Whether to print the environment.

Other Parameters
Returns

Environment.

Return type

defaultdict

Examples

>>> environment = describe_environment(width=75)  
===========================================================================
*                                                                         *
*   Interpreter :                                                         *
*       python : 3.7.4 (default, Sep  7 2019, 18:27:02)                   *
*                [Clang 10.0.1 (clang-1001.0.46.4)]                       *
*                                                                         *
*   colour-science.org :                                                  *
*       colour : v0.3.13-293-gecf1dc8a                                    *
*                                                                         *
*   Runtime :                                                             *
*       imageio : 2.6.1                                                   *
*       numpy : 1.17.2                                                    *
*       scipy : 1.3.1                                                     *
*       six : 1.12.0                                                      *
*       pandas : 0.24.2                                                   *
*       matplotlib : 3.0.3                                                *
*       networkx : 2.3                                                    *
*       pygraphviz : 1.5                                                  *
*                                                                         *
===========================================================================
>>> environment = describe_environment(True, True, True, width=75)
... 
===========================================================================
*                                                                         *
*   Interpreter :                                                         *
*       python : 3.7.4 (default, Sep  7 2019, 18:27:02)                   *
*                [Clang 10.0.1 (clang-1001.0.46.4)]                       *
*                                                                         *
*   colour-science.org :                                                  *
*       colour : v0.3.13-293-gecf1dc8a                                    *
*                                                                         *
*   Runtime :                                                             *
*       imageio : 2.6.1                                                   *
*       numpy : 1.17.2                                                    *
*       scipy : 1.3.1                                                     *
*       six : 1.12.0                                                      *
*       pandas : 0.24.2                                                   *
*       matplotlib : 3.0.3                                                *
*       networkx : 2.3                                                    *
*       pygraphviz : 1.5                                                  *
*                                                                         *
*   Development :                                                         *
*       biblib-simple : 0.1.1                                             *
*       coverage : 4.5.4                                                  *
*       coveralls : 1.8.2                                                 *
*       flake8 : 3.7.8                                                    *
*       invoke : 1.3.0                                                    *
*       jupyter : 1.0.0                                                   *
*       mock : 3.0.5                                                      *
*       nose : 1.3.7                                                      *
*       pre-commit : 1.18.3                                               *
*       pytest : 5.2.1                                                    *
*       restructuredtext-lint : 1.3.0                                     *
*       sphinx : 2.2.0                                                    *
*       sphinx_rtd_theme : 0.4.3                                          *
*       sphinxcontrib-bibtex : 1.0.0                                      *
*       toml : 0.10.0                                                     *
*       twine : 1.15.0                                                    *
*       yapf : 0.23.0                                                     *
*                                                                         *
*   Extras :                                                              *
*       ipywidgets : 7.5.1                                                *
*       notebook : 6.0.1                                                  *
*                                                                         *
===========================================================================