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

PyGLImER - A workflow to create a global database for Ps and Sp receiver functions in Python
============================================================================================

This is the documentation for the PyGLImER repository, available at:
`PyGLImER <https://github.com/PeterMakus/PyGLImER>`_


**Package Introduction**

.. toctree::
   :maxdepth: 2

   chapters/introduction/introduction
   chapters/introduction/installation
   tutorials/index

**Waveform Download, Preprocessing, and Receiver Function Creation** *Tools to
get from 0 to Receiver-Function-Hero.*

.. toctree::
   :maxdepth: 2

   chapters/creation/index

**Handling of Receiver Functions** *Overview of capabilities of the Receiver
Function class and associated classes.*

.. toctree::
   :maxdepth: 2

   chapters/receiver_functions/index

**Common Conversion Point Stacking** *Tool to create Common Conversion Point
Stack from your computed Receiver Functions.*

.. toctree::
   :maxdepth: 2

   chapters/ccp/index

**Plotting Routines** *Summary of available plotting routines.*

.. toctree::
   :maxdepth: 2

   chapters/plotting/index

**Function Library**

.. toctree::
   :maxdepth: 2

   chapters/api/index



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

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