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

• Installing frb
  • Installing Dependencies
  • Installing frb
  • Adding additional CIGALE filter files
  • EAZY setup
  • pPXF
• Quick Start Guide
  • Basic Usage
  • Common Workflows
  • Command Line Tools
  • Working with Your Own Data
  • Next Steps
  • Common Gotchas
  • Getting Help

Core Classes

• FRB Class
  • Overview
  • Loading FRBs
  • Key Attributes
  • Grabbing the Host Galaxy
  • Listing All FRBs
  • Building a Table of FRBs
  • Creating Custom FRBs
  • Writing to JSON
  • API Reference
  • See Also
• FRBHost Class
  • Overview
  • Loading Host Galaxies
  • Key Attributes
  • Calculating Derived Quantities
  • Retrieving Spectra
  • Running SED Fitting
  • Parsing External Results
  • Building a Table of Hosts
  • Listing All Hosts
  • Loading PATH Results
  • Writing to JSON
  • Setting Redshifts
  • API Reference
  • See Also

Data

• Data
  • Overview
  • FRBs
  • Host Galaxies
  • Spectra
• Database
  • FRBs
  • Hosts
  • Misc

Dispersion Measure

• Dispersion Measure
  • Galactic ISM
  • Intervening Galaxies

Galaxies

• FRB Galaxies
  • FRBGalaxy
  • FRBHost
• Adding a Host Galaxy
  • Overview
  • Steps
• Eazy
  • Overview
  • Setup
  • Running
  • Parsing
• Magnitudes to flux conversion

Halo Calculations

• frb.halos Package Documentation
  • Overview
  • Modules
  • Quick Start
  • Common Workflows
  • Dependencies
  • Related Modules
  • References
  • Examples
  • See Also

Rotation Measure

• Rotation Measure
  • Galactic RM

Scattering

• Turbulent Scattering
  • Turbulence

Surveys

• Surveys
  • Usage
  • Available Surveys

FRB Scripts

• Scripts
  • Overview
  • frb_summary
  • frb_pzdm_mag
  • frb_sightline
  • frb_build
  • frb_galaxies
  • frb_image
  • frb_dmism
  • frb_search_for_halos
  • frb_tns

API Reference

• API Reference
  • Core Modules
  • Quick Reference
  • Function Index
  • Class Hierarchy
  • Constants and Defaults
  • Error Handling
  • Data Types
  • Contributing to the API