zdm

zdm is a Python package for Fast Radio Burst (FRB) redshift-dispersion measure (z-DM) calculations. It provides tools for statistical modeling of FRB populations, computing likelihoods, and constraining cosmological and FRB population parameters.

The package implements the theoretical framework for relating observed FRB dispersion measures to their redshifts, accounting for contributions from the Milky Way, host galaxies, and the intergalactic medium.

Key Features

• Cosmological Modeling: Lambda-CDM cosmology with configurable parameters

• z-DM Grids: Efficient computation of probability distributions over redshift and dispersion measure

• Survey Support: Built-in support for CHIME, ASKAP, Parkes and other FRB surveys

• Likelihood Analysis: Compute likelihoods for FRB populations given survey data

• MCMC Parameter Estimation: Integration with emcee for Bayesian parameter inference

• Repeater Modeling: Support for repeating FRB population models

Getting Started

User Guide

• Installation
  • Requirements
  • Installing from Source
  • Installing Dependencies
  • Full Installation Script
  • Verifying Installation
  • Using tox
  • Troubleshooting
• Quickstart
  • Basic Concepts
  • Setting Up a State
  • Initializing Cosmology
  • Loading a Survey
  • Building a Grid
  • Computing Likelihoods
  • Complete Example
  • Working with Parameters
  • Visualization
  • Next Steps
• Tutorials
  • Available Notebooks
  • Tutorial: Basic Likelihood Calculation
  • Tutorial: Parameter Exploration
  • Tutorial: MCMC Parameter Estimation
  • Tutorial: Working with Repeaters
  • Further Resources

Reference

• Architecture
  • Overview
  • Core Classes
  • Data Flow
  • Key Modules
  • File Organization
  • Extension Points
• Parameters
  • State Object
  • Cosmology Parameters (cosmo)
  • FRB Demographics Parameters (FRBdemo)
  • Energy Parameters (energy)
  • Host Galaxy Parameters (host)
  • Milky Way Parameters (MW)
  • IGM Parameters (IGM)
  • Width Parameters (width)
  • Scattering Parameters (scat)
  • Repeater Parameters (rep)
  • Analysis Parameters (analysis)
• API Reference
  • Core Modules
  • Computation Modules
  • Utility Modules
  • Analysis Modules
  • Data Classes
  • Specialized Modules
• Optical Host Galaxy Association
  • Overview
  • Host Magnitude Models
  • The model_wrapper Class
  • Typical Workflow
  • Parameter Reference
  • Optimisation and Statistics
  • Scripts
  • API Reference
  • References

Development

• Contributing

Citation

If you use zdm in your research, please cite:

@article{james2022,
   author = {James, Clancy W. and others},
   title = {A measurement of Hubble's Constant using Fast Radio Bursts},
   journal = {MNRAS},
   year = {2022}
}

License

zdm is licensed under a 3-clause BSD style license. See the LICENSE file in the repository for details.

Indices and tables

• Index

• Module Index

• Search Page