gerbls 0.6.0

No project description provided

GERBLS

GERBLS (Greatly Expedited Robust Box Least Squares) is a lightweight fast-folding implementation of the BLS (Box Least Squares) algorithm. It is designed to facilitate transiting planet searches in photometric data via an easy setup and fast runtimes.

GERBLS can outperform popular brute-force BLS implementations such as astropy.timeseries.BoxLeastSquares by over 10-20x in runtime speed.

Installation

Currently, GERBLS requires a Python version of 3.9 or above. Additional dependencies are numpy and a build-time dependency on Cython. These will be checked and/or installed automatically.

To install the latest version of GERBLS, run the following code:

pip install gerbls

If you encounter any issues while installing or using GERBLS, or would like to request a feature to be added to the code, please do not hesitate to contact me.

Basic usage

Documentation

A full "Read The Docs" documentation page is currently in the works.

Features in development

There are multiple additional features that are currently in various stages of development but need to be tested more thoroughly before they can be released publicly. These include:

• Various light curve detrending methods (Savitsky-Golay filter, Gaussian Process, etc.)
• Post-BLS limb-darkened transit model fitting
• Period-dependent bootstrap FAP calculation, which allows the significance of any potential transit to be evaluated (or alternative, an S/R threshold to be set) as a function of orbital period
• Additional tools to implement fake transit injection and recovery searches

Acknowledgements

GERBLS includes some C code from the publicly available pulsar-searching riptide package to implement the fast-folding algorithm.