fruitbat 0.0.2

Documentation

The documentation for fruitbat can be found at https://fruitbat.readthedocs.io/en/latest/index.html.

Installation

Run the following to install:

pip install fruitbat

Or you can clone this repository:

git clone https://github.com/abatten/fruitbat
cd fruitbat
pip install .

Usage

If you want to get started using fruitbat there is a Getting Started section of the documentation made just for you! Otherwise the tl;dr is the following:

Most of the calculations will be centred around the Frb class. You can can define an instance of the ~Frb with a name and a dispersion measure. To calculate the redshift of the FRB use the method calc_redshift_

>>> import fruitbat
>>> frb = fruitbat.Frb("FRB121102", dm=557, dm_excess=369)
>>> frb.calc_redshift()
0.4537827606357084

You can provide a method and/or a cosmology that you want to assume.

>>> frb.calc_redshift(method="zhang2018", cosmology="planck2018")
0.42190276949033323

Referencing Fruitbat

If you use fruitbat in your research, we would like it if you could reference us. :)