Overview

The ringdown package is composed of five primary modules: ringdown.fit, ringdown.data, ringdown.result, ringdown.model and ringdown.waveforms. The single most important object in the package is the Fit class, which contains all information and settings required to set up and execute an analysis. Several examples of its use are provided in the Example gallery.

The Fit object interfaces with a of numpyro model for sampling.

Auxiliary to fit, the data and waveforms modules contain utilities for handling strain data (time and frequency series, power spectral densities, autocovariance functions) and templates (both ringdown-only and inspiral-merger-ringdown). This functionality is intentionally minimal; many other widely-used packages exist for generic manipulation of strain data, e.g., GWpy, PyCBC. Like those packages, ringdown relies heavily on LALSuite for waveform handling and related operations.

The above functionality can be used to build your own workflows. Additionally, ringdown ships with a single executable ringdown_fit which can be used to automatically set up and run a ringdown fit starting from a configuration file. This can easily be used to create automated workflows if desired.