.. Leap Accelerate documentation master file, created by
.. sphinx-quickstart on Mon Feb  8 17:21:19 2021.
.. You can adapt this file completely to your liking, but it should at least
.. contain the root `toctree` directive.

###############
Leap Accelerate
###############

.. image:: https://img.shields.io/badge/license-BSD--3--Clause-blue
	:alt: Project License: BSD-3-Clause
	:target: https://img.shields.io/badge/license-BSD--3--Clause-blue

Leap Accelerate is a calibration tool implementing Low-frequency Excision of the Atmosphere in Parallel (`LEAP <https://arxiv.org/abs/1807.04685>`_) for low-frequency radio antenna arrays.
Leap utilizes GPGPU acceleration for parallel computation across baselines,
channels and polarizations and is freely available on `GitLab <https://gitlab.com/ska-telescope/icrar-leap-accelerate>`_ under the GPLv2+ License.

Leap Accelerate consists of:

* :ref:`api`: a shared library for accelerated direction centering and phase calibration.
* :ref:`cli`: a CLI interface for I/O datastream or plasma data access.

.. toctree::
    :caption: Library Documentation
    :maxdepth: 2

    api.rst
    cli.rst
    api/library_root.rst

.. toctree::
    :caption: Installation
    :maxdepth: 2
    :glob:

    md/Build
    md/Docker
    md/Submodules

.. toctree::
    :caption: Usage
    :maxdepth: 2
    :glob:

    md/LeapAccelerateCLI

.. toctree::
    :caption: Contributing
    :maxdepth: 2
    :glob:

    md/specs/CMakeStyleGuide
    md/specs/CPlusPlusStyleGuide
    md/specs/CudaStyleGuide

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

* :ref:`genindex`