.. pyblip documentation master file, created by
   sphinx-quickstart on Wed Mar 23 17:52:56 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

==================================
Welcome to pyblip's documentation!
==================================

``pyblip`` is a python implementation of BLiP (Bayesian Linear Programming), a method to jointly localize and detect signals. Given nearly any Bayesian model, ``pyblip`` is designed so that BLiP can wrap on top of the Bayesian model in only one or two lines of code to enhance its power. Check out the Tutorials section for more examples!

.. toctree::
   :maxdepth: 4
   :caption: Contents:
        
   installation
   usage
   apiref
   pyblip source <https://github.com/amspector100/pyblip>
   blipr source <https://github.com/amspector100/blipr>
   BLiP paper (arXiv) <https://arxiv.org/abs/2203.17208>

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

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