underworld.visualisation module
===============================

This module provides visualisation tools for Underworld. 

Visualisation data is generated in parallel, with each processes generating the 
necessary data for its part of the domain. Rendering is performed in serial using the 
LavaVu rendering engine.

Users may choose to render outputs to raster images, or save a database file for 
later rendering. For those working in the Jupyter environment, results may be 
displayed inline.

The following environment variables are available for the tuning of rendering 
configuration:

Parameters
----------
UW_USE_XVFB: bool
    Set this flag to true to use Xvfb for off-screen rendering. Xvfb will need to be 
    installed, as will pyvirtualdisplay.   
UW_VIS_PORT: int
    Set which port to use for rendering server. Set to zero to disable server. 


Submodules
~~~~~~~~~~~

.. toctree::
    :titlesonly: 
    :hidden: 

    underworld.visualisation.objects.rst

.. autosummary::
    :nosignatures:

    underworld.visualisation.objects

.. module:: underworld.visualisation

Classes
~~~~~~~

.. autosummary::
    :nosignatures:

    underworld.visualisation.Figure
    underworld.visualisation.Store
    underworld.visualisation.Viewer

.. autoclass:: underworld.visualisation.Figure
    :members:
    :show-inheritance:
.. autoclass:: underworld.visualisation.Store
    :members:
    :show-inheritance:
.. autoclass:: underworld.visualisation.Viewer
    :members:
    :show-inheritance: