.. PyPR documentation master file, created by
   sphinx-quickstart on Mon Nov 29 10:28:29 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PyPR's documentation!
================================

.. figure::  figures/pypr.*
   :align:   right
PyPR is an abbreviation for Python Pattern Recognition. The implementation of PyPR was done as part of an Ph. D. project, "Mining of Ship Operation Data for Energy Conservation", which purpose was to develop statistical models for analyzing the dynamics of ocean-going vessels, especially with regard to modelling fuel effciency.
However many of the methods used can be used in a wide range of application, and have therefore been collected in this freely available library (GNU GPL licence).
The Ph. D. project was funded by "Føroyagrunnurin frá 1971", which is administered by `Faroese Research Counsil <http://www.gransking.fo>`_.
I am enrolled at `DTU Informatics <http://www.imm.dtu.dk>`_, so the code has been heavily inspired by them, and by the company that I work at, `Decision3 <http://www.decision3.com>`_.

The code is still under constant development, and it might change considerably over time. If you use parts of this code in your project, you might just want to copy the code or files. Please add a reference to this project :)


Contents:

.. toctree::
   :maxdepth: 2

   getting_pypr
   preprocessing
   clustering
   ann
   gp
   optimization
   helpers
   stattest
   examples
   auto/modules

..
    auto/modules are generated with:
    https://bitbucket.org/etienned/sphinx-autopackage-script/src

Indices and tables
==================

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