.. bayspec documentation master file, created by
   sphinx-quickstart on Thu Oct 24 15:25:26 2024.

BaySpec documentation
=====================

*BaySpec* is a Python library for Bayesian inference on high-energy
astrophysical spectra. It pairs MCMC and nested-sampling backends with
multi-spectrum, multi-model fitting machinery, reads OGIP FITS data out of
the box, and bridges to local,
`astromodels <https://astromodels.readthedocs.io/>`_, and
`Xspec <https://heasarc.gsfc.nasa.gov/xanadu/xspec/manual/Models.html>`_
model libraries.

For a point-and-click workflow, see the companion
`BaySpec App <https://github.com/jyangch/bayspec_app>`_ — a FastAPI + HTMX
browser workbench that wraps the same fitting machinery
(`live demo on Hugging Face Spaces <https://huggingface.co/spaces/jyangch/bayspec>`_).


Contents
--------

.. toctree::
   :maxdepth: 2

   installation
   tutorials
   modules


Indices
-------

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