.. AvaFrame documentation master file, created by
   sphinx-quickstart on Mon Jul  6 16:11:23 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

The Open Avalanche Framework
============================

.. include:: introduction.rst

General
=======

.. only:: html

    * :doc:`introduction`
    * :doc:`installation`
    * :doc:`connector`
    * :doc:`advancedUsage`
    * :doc:`testing`
    * :doc:`Visualisation`
    * :doc:`FAQ`
    * :doc:`releaseNotes`
    * :doc:`api`
    * :doc:`develop`

.. toctree::
   :maxdepth: 4
   :hidden:
   :caption: General

   introduction.rst
   installation.rst
   connector.rst
   advancedUsage.rst
   testing.rst
   Visualisation.rst
   FAQ.rst
   releaseNotes.rst
   api.rst
   develop.rst


Computational modules
=====================

.. only:: html

    * :doc:`moduleCom1DFA`
    * :doc:`moduleCom1DFAOrig`
    * :doc:`moduleCom2AB`
    * :doc:`moduleCom3Hybrid`
    * :doc:`moduleCom4FlowPy`
    * :doc:`moduleCom5SnowSlide`
    * :doc:`moduleCom6RockAvalanche`

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: Computational modules

   moduleCom1DFA.rst
   moduleCom1DFAOrig.rst
   moduleCom2AB.rst
   moduleCom3Hybrid.rst
   moduleCom4FlowPy.rst
   moduleCom5SnowSlide.rst
   moduleCom6RockAvalanche.rst

Input/transformation modules
============================

.. only:: html

    * :doc:`moduleIn1Data`
    * :doc:`moduleIn2Trans`
    * :doc:`moduleIn3Utils`

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: Input/transformation modules

   moduleIn1Data.rst
   moduleIn2Trans.rst
   moduleIn3Utils.rst

Analysis/helper modules
=======================

.. only:: html

    * :doc:`moduleAna1Tests`
    * :doc:`moduleAna3AIMEC`
    * :doc:`moduleAna4Stats`
    * :doc:`moduleAna5Utils`
    * :doc:`moduleOut1Peak`
    * :doc:`moduleOut3Plot`
    * :doc:`moduleLog2Report`

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: Analysis/helper Modules

   moduleAna1Tests.rst
   moduleAna3AIMEC.rst
   moduleAna4Stats.rst
   moduleAna5Utils.rst
   moduleOut1Peak.rst
   moduleOut3Plot.rst
   moduleLog2Report.rst


Theory
======

.. only:: html

    * :doc:`theoryCom1DFA`
    * :doc:`DFAnumerics`
    * :doc:`com1DFAAlgorithm`
    * :doc:`theoryCom4FlowPy`

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: Theory

   theoryCom1DFA.rst
   DFAnumerics.rst
   com1DFAAlgorithm.rst
   theoryCom4FlowPy.rst

.. only:: html

References
==========

    * :doc:`zreferences`
    * :doc:`dataSources`
    * :doc:`glossary`

.. toctree::
    :maxdepth: 0
    :hidden:
    :caption: References

    zreferences.rst
    dataSources.rst
    glossary.rst