.. -*- mode: rst; coding: utf-8 -*-
.. gridDataFormats documentation master file, created by
   sphinx-quickstart on Tue Jun 30 13:16:50 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

GridDataFormats: Handling volumetric data in Python
===================================================

:Release: |release|
:Date: |today|
:Citation: |zenodo|
       
The :mod:`gridData` module contains a simple class
:class:`~gridData.core.Grid` that makes it easier to work with data on
a regular grid. A limited number of commonly used formats can be read
and written as described in :ref:`supported-file-formats`.

The code is available under the `Lesser GNU General Public License,
version 3`_ (see also the files ``COPYING`` and ``COPYING.LESSER`` in
the source distribution). Releases are available from the Python
Package index under GridDataFormats_ and source code is available from
the GitHub repository
https://github.com/MDAnalysis/GridDataFormats.

.. rubric:: Participating

Ask questions on the `mdnalysis-discussion mailing list`_ and join the
discussion.

Please report problems and enhancement requests through the `issue
tracker`_.

GridDataFormats is open source and welcomes your contributions. Fork
the `GridDataFormats repository on GitHub`_ and submit a pull request. Participate on the
`developer mailing list`_.



.. _`Lesser GNU General Public License, version 3`: 
   https://www.gnu.org/licenses/lgpl-3.0.en.html
.. _GridDataFormats: https://pypi.python.org/pypi/GridDataFormats/
.. _issue tracker: https://github.com/MDAnalysis/GridDataFormats/issues
.. _mdnalysis-discussion mailing list:
   https://groups.google.com/group/mdnalysis-discussion
.. _developer mailing list:
   https://groups.google.com/group/mdnalysis-devel
.. _GridDataFormats repository on GitHub:
   https://github.com/MDAnalysis/GridDataFormats
   
.. |zenodo| image:: https://zenodo.org/badge/13219/MDAnalysis/GridDataFormats.svg
    :alt: Zenodo DOI
    :target: https://zenodo.org/badge/latestdoi/13219/MDAnalysis/GridDataFormats


.. Contents (sidebar)

.. toctree::
   :maxdepth: 4
   :hidden:

   installation	      
   gridData/overview
   gridData/basic
   gridData/formats
   gridData/core


.. rubric:: Indices and tables

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

