Documentation
=============

**PETGEM** comes with extensive documentation that can be grouped into
following categories:

* `Installation`_
* `Tutorial`_
* `Manual`_

.. _Installation:

Installation 
------------
**Platforms**

   **PETGEM** is known to run on various flavors of Linux clusters.

**Requeriments**
   
   `Python <https://www.python.org/>`_ packages for using **PETGEM**:
 
   * `Scipy <http://www.scipy.org/>`_ for numerical operations
   * `petsc4py <https://bitbucket.org/petsc/petsc4py>`_ and `mpi4py <https://bitbucket.org/mpi4py/mpi4py>`_ for parallel computations and using parallel solvers from `PETSc <http://www.mcs.anl.gov/petsc/>`_.
   * `pymetis <http://mathema.tician.de/software/pymetis>`_ for mesh partitioning using Metis.
   
   On Linux, consult the package manager of your preference. **PETGEM** can be used without any installation by running the scripts from the top-level directory of the distribution.


.. _Tutorial:

Tutorial
--------

The **PETGEM** tutorial contains a collection of programs which demostrate various aspects of the **PETGEM** workflow.



Manual section

.. _Manual:

Manual
------

Manual section

.. automodule:: packages.initparams
   :members:
