Welcome to kookaburra's documentation!
======================================

This is the documentation for the :code:`kookaburra` package used for analysis
of radio-pulsar flux. The source code can be found `here
<https://github.com/GregoryAshton/kookaburra>`_.

Installation
------------

.. tabs::

   .. tab:: source

      .. code-block:: console

          $ git clone git@github.com:GregoryAshton/kookaburra.git
          $ cd kookaburra
          $ pip install .

      Supported python versions: 3.6+.

   .. tab:: pip

      .. code-block:: console

          $ pip install kookaburra

      Supported python versions: 3.6+.



Command line tools:
-------------------

.. toctree::
   :maxdepth: 2

   kb_single_pulse
   kb_create_database



Python API:
-----------

.. toctree::
   :maxdepth: 2

   data
   flux-models