.. _ref:

Reference Guide
===============

.. module:: best
    :synopsis: The main module of BEST.

There are two kinds of documentation for BEST. The reference guide you
are reading right now and the docstrings of the actual Python code. In
this reference guide, we have omitted the details of the various objects
or functions. We only describe how the should be used. For the complete
details you are advised to look at the code itself.

The main module of BEST is (of course) called :mod:`best`.

The BEST package is split in several submodules:

.. toctree::
   :maxdepth: 2

   core
   basic
   misc
   linalg
   serialization
   maps
   cov
   domain
   random
   gpc
   glm
   rvm
   gp
   design
   inverse