Welcome to bilby's documentation!
=================================

.. automodule:: bilby
    :members:

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   installation
   citing-bilby
   code-overview
   examples
   basics-of-parameter-estimation
   prior
   likelihood
   samplers
   dynesty-guide
   bilby-mcmc-guide
   plugins
   bilby-output
   compact-binary-coalescence-parameter-estimation
   transient-gw-data
   gw_likelihood
   gw_prior
   conversion
   gw_references
   writing-documentation
   hyperparameters
   containers
   contribution-guide
   faq


.. toctree::
   :maxdepth: 1
   :caption: Examples:

   making_priors
   compare_samplers
   fitting_with_x_and_y_errors
   visualising_the_results

.. currentmodule:: bilby

API:
----

.. autosummary::
   :toctree: api
   :template: custom-module-template.rst
   :caption: API:
   :recursive:

    core
    gw
    hyper
    bilby_mcmc