.. pygplates documentation master file, created by
	sphinx-quickstart on Sat Aug 31 23:24:37 2013.
	You can adapt this file completely to your liking, but it should at least
	contain the root `toctree` directive.

.. _pygplates_index:

PyGPlates |version| documentation
=================================

PyGPlates enables access to `GPlates <http://www.gplates.org>`_
functionality via the `Python <http://www.python.org>`_ programming language.


This documentation includes:

* :ref:`pygplates_introduction` - introduces pyGPlates and covers some advantages over GPlates,
* :ref:`pygplates_getting_started` - installation of pyGPlates and a tutorial to get you started using pyGPlates,
* :ref:`pygplates_primer` - covers the main areas of pyGPlates functionality and some plate tectonic foundations,
* :ref:`pygplates_sample_code` - documented sample code solving common plate tectonic problems using pyGPlates,
* :ref:`pygplates_reference` - a detailed reference of pyGPlates functions and classes.


Contents
========

.. toctree::
   :maxdepth: 3

   pygplates_introduction
   pygplates_getting_started
   pygplates_primer
   pygplates_sample_code
   pygplates_reference

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

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