.. QuakeLabeler documentation master file, created by
   sphinx-quickstart on Wed May 26 09:01:10 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: /Images/QuakeLabeler.png
 :align: center

Welcome to QuakeLabeler's documentation!
============================================

Quake Labeler (QL) Python package enables you to label ground truth for various
seismic machine learning applications. Current functionalities include
retrieving raw waveforms from online data centers, customizing automation modules,
processing and augmenting data, annotating by online reviewed catalog, and
visualizing data distribution. The code helps all levels of AI developers and
researchers for building their own machine learning earthquake datasets. Currently
Quake Labeler runs on an interactive command-line interface so that you can create
dataset with little knowledge of programming.

.. toctree::
   :maxdepth: 1
   :caption: Quick Links

   links

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

   quakelabeler

.. toctree::
   :maxdepth: 2
   :caption: API DOCUMENTATION

   api

.. toctree::
  :maxdepth: 1
  :caption: Tutorials

  tutorials



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

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