.. BootsOff documentation master file.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Documentation
^^^^^^^^^^^^^
.. raw:: html

    <div class="banner">
        <h2>BootsOff is a collection of tools for geophysical survey preparation, data processing, interpretation and reporting.</h2>
        <a href="./examples/index.html"><img src="_static/banner_small.png" alt="BootsOff" width="100%"/></a>
    </div>

.. |GPLv3| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
   :target: https://www.gnu.org/licenses/gpl-3.0

.. |rtd| image:: https://readthedocs.org/projects/BootsOff/badge/?version=latest
   :target: https://BootsOff.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status


+----------------------+------------------------+
| Documentation        | |rtd|                  |
+----------------------+------------------------+
| License              | |GPLv3|                |
+----------------------+------------------------+

.. warning:: This version of the documentation is not yet up-to-date!


About
"""""

BootsOff is a collection of tools for geophysical survey preparation, data processing, interpretation and reporting.
It is still in a very early stage and many features are expected to evolve.

* {@@@ Include main descriptors of BootsOff here}
* {@@@ For example what it does}
* {@@@ Based on which principles}
* {@@@ And for with kind of applications}

BootsOff is {...} that {...}.
This package provides a Pythonic, well-documented interface exposing
{...} to facilitate {...}.

This package can be used for {...}.

Author
""""""
O. KAUFMANN  

Contributors
""""""""""""
Be the first one...  

.. toctree::
   :maxdepth: 1
   :caption: General Introduction
   
   Description<description.rst>


.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   Installation<installation.rst>
   First Steps<first_steps.rst>

.. toctree::
   :maxdepth: 1
   :caption: Examples
   
   Examples<auto_examples/index.rst>


.. toctree::
   :maxdepth: 1
   :caption: API Reference

   modules<modules.rst>
   uml<uml_diagrams.rst>

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

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