.. MToolkit documentation master file, created by
   sphinx-quickstart on Wed Dec 28 10:36:50 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Modeller's Toolkit's documentation
===============================================================================

Release v\ |version|. (:ref:`Installation <installation>`)

Modeller's Toolkit (MToolkit) is a `Python`_ tool for seismic hazard 
model preparation. MToolkit allows users to create inputs needed for the
calculations within OpenQuake_, it works also as a means for prototyping model
development. MToolkit is written by GEM Foundation and licensed under
`LGPL3 license`_.


Architecture
===============================================================================
.. toctree::
   :maxdepth: 2

   dev/architecture.rst

User Guide
===============================================================================
.. toctree::
   :maxdepth: 3
    
   user/installation.rst
   user/configuration.rst
   user/catalogue.rst
   user/completeness_table.rst
   user/area_source.rst

Developer Guide
===============================================================================
.. toctree::
   :maxdepth: 2

   dev/contribute.rst

Getting Help
===============================================================================

.. toctree::
   :maxdepth: 2

   user/help.rst

Scientific modules API
===============================================================================
.. toctree::
   :maxdepth: 2

   scientific_api.rst

.. Links
.. _Python: http://www.python.org
.. _OpenQuake: http://www.openquake.org/
.. _LGPL3 license: http://www.gnu.org/licenses/lgpl.html

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

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