.. SHERLOCK PIPEline documentation master file, created by
   sphinx-quickstart on Thu Jul  8 08:43:51 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to SHERLOCK PIPEline's documentation!
=============================================

.. image:: _static/sherlock2.png
   :width: 300px
   :align: center
   :height: 300px
   :alt: SHERLOCK PIPEline Logo

The SHERLOCK (Searching for Hints of Exoplanets fRom Lightcurves Of spaCe-based seeKers) PIPEline is a user-friendly pipeline, which
minimizes the interaction of the user to the minimum when using data coming from *Kepler* or *TESS* missions. **SHERLOCK** makes use of previous well-known and well-tested codes which allow the exoplanets community to explore the public data from space-based missions without need of a deep knowledge of how the data are built and stored.
In most of cases the user only needs to provide with a ``KIC-ID``, ``EPIC-ID``, ``TIC-ID`` or coordinates of the host star where wants to search for exoplanets.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   the-pipeline
   api
   fit-module
   vet-module
   stability-module
   plan-module
   tutorials
   about-us




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

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