.. _user-guide:

User Guide
==========

This user guide is intended to provide a comprehensive overview of the
OpenQuake engine, its capabilities and how to use it. It is divided into
several sections, each of which is intended to provide a detailed description
of a specific aspect of the engine. 

The first section, :ref:`workflows`, describes the various calculation workflows 
that are curently supported by the OpenQuake engine. 

The second section, :ref:`input-models`, describes the input models that are required
to run various OpenQuake engine calculations and their file formats. 

The third section, :ref:`configuration-file`, describes the configuration file
that is used to specify the calculation settings and we provide the list of
available calculation parameters for each calculation workflow.

The fourth section, :ref:`outputs`, describes the output files that are
generated by the OpenQuake engine following successful calculations 
and their file formats.

The fifth section, :ref:`special-features`, describes the special features of
the OpenQuake engine, such as the ability to run sensitivity analyses.

The sixth section, :ref:`advanced-calculations`, is intended as a guide for
advanced users who wish to run calculations that are more complex and require
more detailed knowledge of the OpenQuake engine.

The seventh section, :ref:`useful-oq-commands`, provides a list of useful
oq commands.


.. toctree::
   :maxdepth: 1

   workflows/index
   inputs/index
   configuration-file/index
   outputs/index
   special-features
   advanced-calculations
   working-with-the-dstore
   useful-oq-commands
   faq
   extras/index