gwfolding 0.1.0

Folding of Stochastic Intermediate Data (SID) to one sidereal day for stochastic gravitational-wave searches.

gwfolding

Folding of Stochastic Intermediate Data (SID) frames to one sidereal day for stochastic gravitational-wave searches. The output can be written as folded SID (.gwf) frames.

Mathematical details are described in the LIGO technical document T0900093.

Prerequisite: the Fr frame library (not on PyPI)

This package reads and writes gravitational-wave frame files via the Fr module (frgetvect / frputvect). Fr is not distributed on PyPI and is not installed by pip. It must already be available in your Python environment, typically from the conda / IGWN software stack used for LIGO/Virgo analysis.

Install or activate your IGWN/conda environment so that the following works before using this package:

from Fr import frgetvect, frputvect

If that import fails, install the frame library from your conda/IGWN channel first.

Installation

pip install gwfolding

This installs the pure-Python package and its PyPI dependencies (numpy, scipy). The Fr frame library must be provided separately (see above).

Usage

from gwfolding import foldSID

foldedInvCov, foldedStatistic, params, foldParams = foldSID(
    "foldSID.par",   # path to the parameter file
    writeFrames=1,   # write folded SID frames
)

A worked example runner is provided in run_foldSID.py, and an example parameter file in foldSID.par.txt.

Authors

• Authors: Anirban Ain, Prathamesh Dalvi, Sanjit Mitra
• Python translation: Erik Floden
• Data production & maintainer: Jishnu Suresh ([e-mail])

License

MIT. See LICENSE.