===============
Getting Started
===============
::

    ================================================
          ____  _                                 
         / __ \(_)___  ____ ____  ____  ___  _____
        / / / / / __ \/ __ `/ _ \/ __ \/ _ \/ ___/
       / /_/ / / /_/ / /_/ /  __/ / / /  __(__  ) 
      /_____/_/\____/\__, /\___/_/ /_/\___/____/  
                    /____/                        

    ================================================


------------
Introduction
------------

Diogenes is a a Python library and workflow templet for machine learning.
Principally it wraps sklearn providing enhanced functionality and simplified 
interface of often used workflows. 

-------
Example
-------

.. include:: notebooks/README.rst


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

.. code:: bash

    pip install git+git://github.com/dssg/diogenes.git

Required Packages
=================

Python packages
---------------
- `Python 2.7 <https://www.python.org/>`_
- `Numpy 1.10.1 <http://www.numpy.org/>`_
- `scikit-learn <http://scikit-learn.org/stable/>`_
- `pandas <http://pandas.pydata.org/>`_
- `SQLAlchemy <http://www.sqlalchemy.org/>`_
- `pdfkit <https://github.com/pdfkit/pdfkit>`_
- `plotlib <http://matplotlib.org/>`_

Other packages
--------------

- `wkhtmltopdf <http://wkhtmltopdf.org/>`_

----------
Next Steps
----------

Our code is available: `here <https://github.com/dssg/diogenes>`_

To dig deaper, look at our :doc:`User Guide <user_guide/index>`