GERBLS documentation

Important

This documentation is currently undergoing improvements. Some package features may not be fully documented yet; this will be improved in the near future.

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.

Contents:

• Installing GERBLS
  • Installing from PyPI
  • Installing from source
  • Common issues
• Getting started
  • Things to know about GERBLS
  • Two ways to run GERBLS
  • Literature references
• Basic usage
  • Overview
  • Example
• Full usage
• Fast BLS demonstration
• API
  • BLS generators
  • BLS results and analyzers
  • Detrending
  • Data structures
  • Transit modeling
  • Utility functions

• Index