Skip to main content

GRB lightcurve flare and continuum fitter.

Project description

Lightcurve and Flare Fitter - LAFF

A python package for automatic lightcurve and flare fitting in GRB lightcurves.

Description

This program looks to provide automatic and consistent fitting of GRB lightcurves, ultimately intended for statistical studies of a large collection of GRBs. Initially it looks for any 'significant' rises in flux which can be marked as a potential flare. Each potential flare is then refined and cut down until a set of start, peak and end times for flares are designated. This flare data is temporarily removed in order to fit a broken powerlaw to the continuum data - the best solution between 0 and up to 5 breaks is used. The flare data can then be readded and the flares fitted with either a simple gaussian, or more appropriately, a fast-rise slow-decay (FRED) curve.

With a fully fitted model, the program will output useful information, either printed to terminal or into a csv table. Such information includes flare timings, durations, number of breaks and fluence of the flares and continuum.

To run the program, the user simply needs to point LAFF towards an appropriate lightcurve file (current and planned formats are shown below). See below for full commands and optional instructions.

Getting Started

Dependencies

  • Python 3
  • lmfit (v1.0.3 or newer)
  • astropy (v5.1 or newer)
  • pandas (v1.4 or newer)
  • matplotlib (v3.5 or newer)
  • scipy (v1.8 or newer)
  • numpy (v1.23 or newer)

All available through standard python package installation methods (e.g. pip). Earlier versions of these may work but have not been explicility tested.

Installing

To download as pip package:

pip install laff

Executing program

  • How to run the program
  • Step-by-step bullets
code blocks for commands

Help

Any advise for common problems or issues.

command to run if program contains helper info

Authors

Contributors names and contact info

ex. Dominique Pizzie
ex. @DomPizzie

Version History

License

This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details

Acknowledgments

Inspiration, code snippets, etc.

Project details


Download files

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

Source Distribution

laff-0.7.1.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

laff-0.7.1-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file laff-0.7.1.tar.gz.

File metadata

  • Download URL: laff-0.7.1.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.0 CPython/3.8.8 Darwin/22.4.0

File hashes

Hashes for laff-0.7.1.tar.gz
Algorithm Hash digest
SHA256 6f0aa34c584235ce48710314e7a7f4233522d88632fee5e9f65cb2368c5182a1
MD5 c307a253702c48cfb8edbff1694845be
BLAKE2b-256 a79c3adfdacc1777cdaa8d02f64935276674957297f8f9cd7ff21bab126f256a

See more details on using hashes here.

File details

Details for the file laff-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: laff-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.0 CPython/3.8.8 Darwin/22.4.0

File hashes

Hashes for laff-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 78ffba3f97670789cef624a8a5204485ceed5d309e48d7ff9063ff675345a8fc
MD5 61eb171652b4130dfb8a2dd4de1f252e
BLAKE2b-256 e42c41e9d13d814bc5621df6cb27e12864e4453bd1b60932711b948186605f3d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page