.. figure:: ../obstools/examples/picture/obstools_logo.png
   :align: center

Documentation
=============

OBStools is a package containing Python tools for processing broadband
ocean-bottom seismic (OBS) data. Current functionalities include removing
vertical component noise from tilt and compliance effects, and calculating
compliance functions from vertical displacement and pressure data. The code uses 
the ``StDb`` package for querying and building a station database and
can be used through command-line scripts.

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4281480.svg
   :target: https://doi.org/10.5281/zenodo.4281480
.. image:: https://github.com/nfsi-canada/OBStools/workflows/Build/badge.svg
   :target: https://github.com/nfsi-canada/OBStools/actions
.. image:: https://codecov.io/gh/nfsi-canada/OBStools/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/nfsi-canada/OBStools

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

   links

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

   obstools

.. toctree::
   :maxdepth: 2
   :caption: Modules

   atacr
   comply