PyStoch

A Python-based code for Stochastic Gravitational-Wave Background (SGWB) mapping from gravitational-wave interferometer data.

PyStoch makes SGWB anisotropy maps from folded stochastic interferometric data (FSID). It supports map-making in the pixel (HEALPix) basis and the spherical-harmonic (SpH) basis, optional broadband beam / Fisher computation, frequency notching, narrowband-radiometer (NBR) analysis, and injection studies.

Contents

• Installation
  • Frame-reading backend
  • The parameter file
• Usage
  • 1. Read frames — read_frames
  • 2. Convert frames — convert_frames
  • 3. Make maps — pystoch
  • Outputs
  • Using PyStoch as a library
• Parameter reference
  • Map basis and resolution
  • Frequency range and spectral index
  • Notching
  • Narrowband radiometer (NBR)
  • Injection
  • Threading and I/O
  • Frame conversion channels
• API reference
  • Top-level names
  • Detectors and antenna response
  • Map-making functions
  • Parameter classes and mapping
  • Command-line entry points
• Citing PyStoch
  • Authors

Pipeline at a glance

PyStoch is run as three command-line steps:

1. read_frames — scan the .gwf framesets and collect their parameters into framesets.ini.

2. convert_frames — convert the .gwf frames into a compressed HDF5 file (faster to read).

3. pystoch — make the maps; results are written as pickle (.pkl) files.

See Usage for the full walkthrough.