API
=====================
   
Welcome to the API. The main packages and modules are available in the 'Quick access' below.

All functions are defined in details further down the page.

Quick access
------------

.. autosummary::
   :toctree: stub
   :recursive:

   unravel

unravel
-------------------

analysis
^^^^^^^^^^^^^^^^^^^

.. automodule:: unravel.analysis
   :members:
   :undoc-members:
   :show-inheritance:

core
^^^^^^^^^^^^^^^^^^^

.. automodule:: unravel.core
   :members:
   :undoc-members:
   :show-inheritance:

stream
^^^^^^^^^^^^^^^^^^^

.. automodule:: unravel.stream
   :members:
   :undoc-members:
   :show-inheritance:

utils
^^^^^^^^^^^^^^^^^^^

.. automodule:: unravel.utils
   :members:
   :undoc-members:
   :show-inheritance:

viz
^^^^^^^^^^^^^^^^^^^

.. automodule:: unravel.viz
   :members:
   :undoc-members:
   :show-inheritance: