.. vlf4ions documentation master file, created by
   sphinx-quickstart on Wed Apr 23 17:28:00 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

vlf4ions documentation
======================

This project contains the functions and procedures necessary to detect solar flares in real-time with an AWESOME antenna. It also contains useful functions to analyse the data in post-processing.

.. note::
   This project is under active development

Contents
--------------

.. toctree::
   :caption: First steps
   :maxdepth: 2

   usage/installation
   usage/quickstart
   usage/class_definition

.. toctree::
   :caption: Reading the data
   :maxdepth: 2

   data/reading_files
   data/amplitude_calibration
   data/phase_correction
   data/flag

.. toctree::
   :caption: Flare detection
   :maxdepth: 2

   detection/detection_breakpoints
   detection/analyse_breakpoints

.. toctree::
   :caption: Ionosphere estimates
   :maxdepth: 0

   estimates/flux_estimate
   estimates/LMP
   estimates/plots

.. toctree::
   :caption: Additional information
   :maxdepth: 0

   code/citations
   code/source_code
   usage/limits

Add your content using ``reStructuredText`` syntax. See the
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
documentation for details.