lavavu module
=============

LavaVu python interface: viewer utils & wrapper

This module provides an interface to the LavaVu library allowing
loading of data, rendering of static images, animation and interactive visualisation

To create an instance of the LavaVu rendering engine, use the Viewer() class, e.g.

>>> import lavavu
>>> lv = lavavu.Viewer()

See the :any:`lavavu.Viewer` class documentation for more information.



Module Summary
--------------
functions:
~~~~~~~~~~

.. autosummary::
    :nosignatures:

    lavavu.download
    lavavu.grid2d
    lavavu.grid3d
    lavavu.cubehelix
    lavavu.loadCPT
    lavavu.matplotlib_colourmap
    lavavu.printH5
    lavavu.lerp
    lavavu.player
    lavavu.inject
    lavavu.hidecode
    lavavu.style
    lavavu.cellstyle
    lavavu.cellwidth
    lavavu.is_ipython
    lavavu.is_notebook
    lavavu.getname

classes:
~~~~~~~~

.. autosummary::
    :nosignatures:

    lavavu.Viewer
    lavavu.Object
    lavavu.Properties
    lavavu.ColourMap
    lavavu.DrawData
    lavavu.Figure
    lavavu.Geometry
    lavavu.Image
    lavavu.Video

Module Details
--------------
functions:
~~~~~~~~~~
.. autofunction:: lavavu.download
.. autofunction:: lavavu.grid2d
.. autofunction:: lavavu.grid3d
.. autofunction:: lavavu.cubehelix
.. autofunction:: lavavu.loadCPT
.. autofunction:: lavavu.matplotlib_colourmap
.. autofunction:: lavavu.printH5
.. autofunction:: lavavu.lerp
.. autofunction:: lavavu.player
.. autofunction:: lavavu.inject
.. autofunction:: lavavu.hidecode
.. autofunction:: lavavu.style
.. autofunction:: lavavu.cellstyle
.. autofunction:: lavavu.cellwidth
.. autofunction:: lavavu.is_ipython
.. autofunction:: lavavu.is_notebook
.. autofunction:: lavavu.getname

classes:
~~~~~~~~
.. autoclass:: lavavu.Viewer
    :members:
    :show-inheritance:
.. autoclass:: lavavu.Object
    :members:
    :show-inheritance:
.. autoclass:: lavavu.Properties
    :members:
    :show-inheritance:
.. autoclass:: lavavu.ColourMap
    :members:
    :show-inheritance:
.. autoclass:: lavavu.DrawData
    :members:
    :show-inheritance:
.. autoclass:: lavavu.Figure
    :members:
    :show-inheritance:
.. autoclass:: lavavu.Geometry
    :members:
    :show-inheritance:
.. autoclass:: lavavu.Image
    :members:
    :show-inheritance:
.. autoclass:: lavavu.Video
    :members:
    :show-inheritance: