.. PPM documentation master file, created by
   sphinx-quickstart on Thu Oct 26 18:54:36 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PyPPM
===============================

Tools for accessing and visualising PPMstar data.

PyPPM has been developed, and is maintained and supported by the NuGrid collaboration. Feedback and input from the community is welcome. Examples of PyPPM in action can be tried out on the `astrohub <https://astrohub.uvic.ca/>`_ server. PyPPM uses the future package so that it can be used with both python 2 and 3.

These modules were written with an interactive work mode in mind, in particular taking advantage of the interactive ipython session or inside an jupyter notebook.


.. toctree::
   :maxdepth: 1
   :caption: Contents:

   installation

Documentation:
----------------------------
.. autosummary::
   :toctree: _autosummary

   ppmpy.ppm

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