Skip to main content

Calculate the redshift of a FRB from its dispersion measure

Project description

PyPI - Latest Release PyPI - Python Versions Travis Documentation Status

Fruitbat

Fruitbat is an open source python package used to estimate the redshift of Fast Radio Burst (FRB) from its dispersion measure.

NOTE: FRUITBAT IS CURRENTLY IN EARLY DEVELOPMENT AND IS NOT READY FOR SCIENCE YET

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. :)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
fruitbat-0.0.2-py3-none-any.whl (13.3 kB) Copy SHA256 hash SHA256 Wheel py3
fruitbat-0.0.2.tar.gz (12.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page