.. vim: set fileencoding=utf-8 :
.. Laurent El Shafey <Laurent.El-Shafey@idiap.ch>
.. Sat Mar 26 12:16:11 2011 +0100
.. Roy Wallace
.. 28 Mar 2012
..
.. Copyright (C) 2011-2013 Idiap Research Institute, Martigny, Switzerland
..
.. This program is free software: you can redistribute it and/or modify
.. it under the terms of the GNU General Public License as published by
.. the Free Software Foundation, version 3 of the License.
..
.. This program is distributed in the hope that it will be useful,
.. but WITHOUT ANY WARRANTY; without even the implied warranty of
.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.. GNU General Public License for more details.
..
.. You should have received a copy of the GNU General Public License
.. along with this program.  If not, see <http://www.gnu.org/licenses/>.

.. Master file, created by sphinx-quickstart on Mon Mar 21 18:07:34 2011.  You
   can adapt this file completely to your liking, but it should at least contain
   the root `toctree` directive.

=======================
 The |project| Project
=======================

|project| is a free signal-processing and machine learning toolbox
originally developed by the Biometrics group at `Idiap`_ Research Institute,
Switzerland. The toolbox is written in a mix of `Python`_ and `C++`_ and is
designed to be both efficient and reduce development time.

* To learn about this project's motivations and history, visit :doc:`Motivation`.

* For a brief summary of what you can do with |project|, have a look at :doc:`Overview`.

* To just get started using |project|, skip ahead to :doc:`Installation`.

* If you make use of |project| or any `Satellite Packages`_, we would
  appreciate if you cited one of our publications as described in
  :doc:`Overview`.

* For more detailed information, scroll down to the User's Guide, Developer's Guide or Reference manual.

We believe in free software and development standards. |project| is a freely
available library, licensed under the terms of the GPL v3. For more information
on licensing, please visit our :doc:`Licensing`.

Enjoy!

.. todolist::

Overview
--------

.. toctree::
   :maxdepth: 2

   Overview

Installation
------------

.. toctree::
   :maxdepth: 2

   Installation

User's Guide
------------

.. toctree::
   :maxdepth: 2

   TutorialsIntro
   TutorialsArrays
   TutorialsIO
   TutorialsIP
   TutorialsAP
   TutorialsMachine
   TutorialsTrainer
   TutorialsDatabase
   TutorialsPerformance
   IrisExample
   OrganizeYourCode
   TicketReporting

Developer's Guide
-----------------

.. toctree::
   :maxdepth: 2

   Community
   Motivation
   CodeBaseOverview
   Dependencies
   Compilation
   Development
   Contributing
   Optimizing
   UsingVideos
   TicketReportingDev

Reference
---------

.. toctree::
   :maxdepth: 2

   PythonIntroduction
   core/index
   math/index
   io/index
   sp/index
   ip/index
   ap/index
   machine/index
   trainer/index
   db/index
   measure/index

History
-------

.. toctree::
   :maxdepth: 2

   History

Licensing
---------

.. toctree::
   :maxdepth: 2

   Licensing


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. include:: links.rst
