.. pypet documentation master file, created by
   sphinx-quickstart on Wed Sep  4 12:12:59 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

==================================
Welcome to *pypet*'s documentation
==================================

.. image:: https://travis-ci.org/SmokinCaterpillar/pypet.svg?branch=master
   :target: https://travis-ci.org/SmokinCaterpillar/pypet
.. image:: https://ci.appveyor.com/api/projects/status/9amhj3iyf105xa2y/branch/master?svg=true
   :target: https://ci.appveyor.com/project/SmokinCaterpillar/pypet/branch/master
.. image:: https://coveralls.io/repos/github/SmokinCaterpillar/pypet/badge.svg?branch=master
   :target: https://coveralls.io/github/SmokinCaterpillar/pypet?branch=master
.. image:: https://api.codacy.com/project/badge/grade/86268960751442799fcf6192b36e386f
   :target: https://www.codacy.com/app/robert-meyer/pypet
.. image:: http://depsy.org/api/package/pypi/pypet/badge.svg
   :target: http://depsy.org/package/python/pypet

The new python parameter exploration toolkit:
*pypet* manages exploration of the parameter space
of any numerical simulation in python,
thereby storing your data into HDF5_ files for you.
Moreover, *pypet* offers a new data container which
lets you access all your parameters and results
from a single source. Data I/O of your simulations and
analyses become a piece of cake!

Latest version:

.. image:: https://badge.fury.io/py/pypet.svg
    :target: https://badge.fury.io/py/pypet

.. _HDF5: http://www.hdfgroup.org/HDF5/


---------
IMPORTANT
---------

This version **no** longer supports **Python 2**. If you are still using
**Python 2** please download `pypet 0.3.0`_.

.. _`pypet 0.3.0`: https://pypi.python.org/pypi/pypet/0.3.0


-------------
Documentation
-------------

.. toctree::
   :maxdepth: 2

   manual/manual_toc
   manual/misc_toc
   manual/code_toc


The documentation is also available for `download in PDF format`_.

.. _download in PDF format: https://media.readthedocs.org/pdf/pypet/latest/pypet.pdf


--------
Feedback
--------

Please feel free to give feedback,
suggestions, and report bugs.
Use **github** (https://github.com/SmokinCaterpillar/pypet) issues or
write to the `pypet Google Group`_.

Thanks!

.. _`pypet Google Group`: https://groups.google.com/forum/?hl=de#!forum/pypet

.. include:: contact_license.rst


-----
Index
-----

* :ref:`genindex`