=============
Documentation
=============

PyLipID is a Python library and can be used through python or ipython. See Tutorials for
examples and getting started. The package contains 4 modules:

The ``api`` module provides the outer layer functions and classes for calculation:

.. toctree::
   :maxdepth: 1

   index_LipidInteraction

The ``func`` module contains functions that do the heavy-lifting:

.. toctree::
   :maxdepth: 1

   index_func

The ``plot`` module contains plotting functions for aiding in the scientific analysis:

.. toctree::
   :maxdepth: 1

   index_plot

The ``util`` module contains other assisting functions:

.. toctree::
   :maxdepth: 1

   index_util