.. astropath documentation master file

Welcome to the astropath documentation!
=======================================

**astropath** (Probabilistic Association of Transients to Hosts - PATH)
is a Bayesian framework for associating astronomical transients
with their host galaxies. It calculates posterior probabilities
P(O_i|x) that a given galaxy candidate O_i is the true host of
a transient at localized position x.

Made and maintained by the FRB community.


Getting Started
---------------

.. toctree::
   :maxdepth: 2

   installing
   frb_example

Priors
------

.. toctree::
   :maxdepth: 2

   offset_function

Transient
---------

.. toctree::
   :maxdepth: 2

   localization

Simulations
-----------

.. toctree::
   :maxdepth: 2

   simulations
   assign_host
   quickstart_assign_host

High-Level Interface
--------------------

.. toctree::
   :maxdepth: 2

   run
   catalogs

Scripts
-------

.. toctree::
   :maxdepth: 2

   scripts

Notebooks
---------

.. toctree::
   :maxdepth: 1

   nb/FRB_example
   nb/GW_example
   nb/Simulate_Generate_FRBs
   nb/Simulate_Assign_FRBs
   nb/Simulate_Run_PATH