*****************
API documentation
*****************

Core BLIP logic
===============

``run_blip`` module
-------------------

.. automodule:: blip.run_blip
   :members:
   :undoc-members:
   :show-inheritance:

``submodel`` module
-------------------

.. automodule:: blip.src.submodel
   :members:
   :undoc-members:
   :show-inheritance:

``models`` module
-----------------

.. automodule:: blip.src.models
   :members:
   :undoc-members:
   :show-inheritance:

LISA instrument and SGWB response
=================================

Legacy ``geometry`` module
--------------------------

.. automodule:: blip.src.geometry
   :members:
   :undoc-members:
   :show-inheritance:

``fast_geometry`` module
------------------------

.. automodule:: blip.src.fast_geometry
   :members:
   :undoc-members:
   :show-inheritance:

The experimental ``faster_geometry`` module
-------------------------------------------

.. automodule:: blip.src.faster_geometry
   :members:
   :undoc-members:
   :show-inheritance:

``sph_geometry`` module
-----------------------

.. automodule:: blip.src.sph_geometry
   :members:
   :undoc-members:
   :show-inheritance:

``makeLISAdata`` module
-----------------------

.. automodule:: blip.src.makeLISAdata
   :members:
   :undoc-members:
   :show-inheritance:

``instrNoise`` module
---------------------

.. automodule:: blip.src.instrNoise
   :members:
   :undoc-members:
   :show-inheritance:

``orbitinglisa`` module
-----------------------

.. automodule:: blip.src.orbitinglisa
   :members:
   :undoc-members:
   :show-inheritance:

Astrophysics
============

``astro`` module
----------------

.. automodule:: blip.src.astro
   :members:
   :undoc-members:
   :show-inheritance:

Sampler interfaces
==================

Interface to ``dynesty``
------------------------

.. automodule:: blip.src.dynesty_engine
   :members:
   :undoc-members:
   :show-inheritance:

Interface to ``emcee``
----------------------

.. automodule:: blip.src.emcee_engine
   :members:
   :undoc-members:
   :show-inheritance:

Interface to ``numpyro``
------------------------

.. automodule:: blip.src.numpyro_engine
   :members:
   :undoc-members:
   :show-inheritance:


Miscellaneous
=============

``utils`` module
----------------

.. automodule:: blip.src.utils
   :members:
   :undoc-members:
   :show-inheritance:

``clebschGordan`` module
------------------------

.. automodule:: blip.src.clebschGordan
   :members:
   :undoc-members:
   :show-inheritance:

``hierarchical`` module
-----------------------

.. automodule:: blip.src.hierarchical
   :members:
   :undoc-members:
   :show-inheritance:

``config`` module
-----------------

.. automodule:: blip.config
   :members:
   :undoc-members:
   :show-inheritance: