Welcome to the FRB documentation!
=================================

FRB is a Python package for Fast Radio Burst research, providing tools for
dispersion measure calculations, host galaxy analysis, FRB-galaxy associations,
and survey data handling. The package is developed and maintained by the FRB community.


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

.. toctree::
   :maxdepth: 2

   installing
   quickstart

Core Classes
------------

.. toctree::
   :maxdepth: 2

   frb_class
   frbhost_class

Data
----

.. toctree::
   :maxdepth: 2

   data
   database

Dispersion Measure
------------------

.. toctree::
   :maxdepth: 2

   dm

Galaxies
--------

.. toctree::
   :maxdepth: 2

   galaxies
   adding_host
   eazy
   mags_to_flux

Halo Calculations
-----------------

.. toctree::
   :maxdepth: 2

   halos/index

Rotation Measure
----------------

.. toctree::
   :maxdepth: 2

   rm


Scattering
----------

.. toctree::
   :maxdepth: 2

   tscatt

Surveys
-------

.. toctree::
   :maxdepth: 2

   surveys


FRB Scripts
-----------

.. toctree::
   :maxdepth: 2

   scripts

API Reference
-------------

.. toctree::
   :maxdepth: 2

   api/index