.. currentmodule:: yam
.. automodule:: yam

API Documentation
=================

Yam consists of the following modules:

.. toctree::
   :maxdepth: 2

.. autosummary::
   ~yam.correlate
   ~yam.stack
   ~yam.stretch
   ~yam.imaging
   ~yam.main
   ~yam.commands
   ~yam.util


:mod:`!correlate` Module
------------------------

.. automodule:: yam.correlate

:mod:`!stack` Module
--------------------

.. automodule:: yam.stack

:mod:`!stretch` Module
----------------------

.. automodule:: yam.stretch

:mod:`!imaging` Module
----------------------

.. automodule:: yam.imaging


:mod:`!main` Module
-------------------

.. automodule:: yam.main


:mod:`!commands` Module
-----------------------

.. automodule:: yam.commands

:mod:`!util` Module
-------------------

.. automodule:: yam.util

.. _`config_label`:

Example Configuration File
==========================

.. literalinclude:: ../yam/conf_example.json
   :linenos: