From 451e73af05837c719b51d8e0a865858f8a5c8dce Mon Sep 17 00:00:00 2001 From: Emmanuel Fonseca Date: Sun, 12 Nov 2023 20:30:03 -0500 Subject: [PATCH] edited for public release --- README.md | 31 +++++++++---------------------- 1 file changed, 9 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 09cc6ad..a10bfe5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ fitburst ======== -This repo contains functions and objects for modeling dynamic spectra of dispersed astrophysical signals at radio frequencies. +This repository contains functions, objects, and scripts for modeling dynamic spectra of dispersed astrophysical signals at radio frequencies. ## Installation @@ -13,28 +13,15 @@ pc> cd fitburst pc/fitburst> pip install . # add the --user option if you're looking to install in your local environment. ``` -## Usage +## Usage and Documentation +Please refer to the documentation linked above to find desciptions on the codebase and examples for interacting with it. -Once installed, the `fitburst` functionality can be imported as a Python package for various custom purposes. For example, if you wish to simply read in CHIME/FRB metadata only (e.g., parameter estimates made by the various online pipelines) for a specific event, you could do the following: +## Publication +The theory behind the modeling and analysis routines is presented in a paper currently under review, but available on the arXiv. This paper includes a variety of fitting examples and discussions on the treatment of biasing effects (e.g., intra-channel smearing from pulse dispersion) that can be accounted for within `fitburst`. If you use this codebase and publish results obtained with it, we ask that you cite the `fitburst` paper using the following BibTex citation: -``` -pc> python ->>> from fitburst.backend.chimefrb import DataReader ->>> data = DataReader(48851362) -.... ->>> print(data.burst_parameters) # a dictionary of pipeline-specific parameters ->>> print(data.files) # a list of filenames for the total-intensity data set -``` - -There are also several example scripts available in the `fitburst/pipelines` section of the repo that utilize the `fitburst` package in slightly different ways. The current script used to analyze CHIME/FRB data (`fitburst/pipelines/fitburst_example_chimefrb.py`) comes with a variety of options for interacting with the full algorithm at the command line. For example, if you wish to run the full `fitburst` pipeline on an event (i.e., data I/O and pre-processing, setup and fitting of model against pre-processed intensity data) using the intensity-DM pipeline parameters as your initial guess, and ignoring the fit of scattering parameters, you should run: -``` -pc> python /path/to/fitburst_example_chimefrb.py 48851362 --pipeline dm -``` - -If you wish to change the size of the windowed spectrum, fit for a scattering timescale of a thin-screen model, and toggle its initial guess to a value of your choosing, you should instead run: +... COMING SOON! :sweat-smile -``` -pc> python /path/to/fitburst_example_chimefrb.py 48851362 --pipeline dm --window 0.12 --fit scattering_timescale --scattering_timescale 0.05 -``` +## Credits +All authors of the `fitburst` papers are the founding developers of `fitburst`, with Emmanuel Fonseca leading the development team. We welcome novel and meaningful contributions from interested users! -Use the `-h` option in the above script to see all available options and units for various numerical quantities. +This package was built using [namoona](https://github.com/CHIMEFRB/namoona).