.. -*- mode: rst -*-
.. ex: set sts=4 ts=4 sw=4 et tw=79:

.. _modref:

****************
Module Reference
****************

This module reference extends the manual with a comprehensive overview of the
currently available functionality, that is built into PyMVPA. However, instead
of a full list including every single line of the PyMVPA code base, this
reference limits itself to the relevant pieces of the application programming
interface (API) that are of particular interest to users of this framework.

Each module in the package is documented by a general summary of its
purpose and the list of classes and functions it provides.

For developers, more detailed (technical) information is available in the
`API reference`_.

.. _API Reference: api/index.html


Global Facilities
=================

.. toctree::

  modref/mvpa


Datasets: Input, Output, Storage and Preprocessing
==================================================

.. toctree::
  :glob:

  modref/mvpa.datasets*


Mappers: Data Transformations
=============================

.. toctree::
  :glob:

  modref/mvpa.mappers*


Classifiers and Errors
======================

.. toctree::
  :glob:

  modref/mvpa.clfs*


Measures: Searchlights and Sensitivties
=======================================

.. toctree::
  :glob:

  modref/mvpa.measures*


Feature Selection
=================

.. toctree::
  :glob:

  modref/mvpa.featsel*


Additional Algorithms
=====================

.. toctree::
  :glob:

  modref/mvpa.algorithms*


Common Facilities
=================

.. toctree::
  :glob:

  modref/mvpa.base*


Miscellaneous
=============

.. toctree::
  :glob:

  modref/mvpa.misc*
