vis.rst

The vis visualization submodule
===============================

General empyre.vis docu here!

Note that the y-axis of all image plots is flipped in comparison to ``matplotlib.pyplot.imshow``, i.e. that the
origin is `'lower'` in this case instead of `'upper'`.

Please note that 3D plots only work in your Jupyter notebook after first installing and then enabling the corresponding
mayavi extension:

.. code-block:: bash

      $ jupyter nbextension install --py mayavi --user
      $ jupyter nbextension enable mayavi --user --py

For more information and a quick introduction visit the `mayavi tips & tricks section <https://docs.enthought.com/mayavi/mayavi/tips.html>`_.


The plot2d module
-----------------

.. automodule:: empyre.vis.plot2d
   :members:
   :show-inheritance:


The decorators module
---------------------

.. automodule:: empyre.vis.decorators
   :members:
   :show-inheritance:


The colors module
-----------------

.. automodule:: empyre.vis.colors
   :members:
   :show-inheritance:


The tools module
----------------

.. automodule:: empyre.vis.tools
   :members:
   :show-inheritance: