API reference¶

This section documents the public Python API of gwmock-signal. Pages are generated with mkdocstrings from Google-style docstrings in the source tree (src/gwmock_signal/).

How to use this site

• For workflow overview and example snippets, use User guide → Examples (sidebar).
• For exact signatures, types, and raised exceptions, use the API sections below.
• For gwmock-signal CLI flags and JSON formats, use User guide → Command-line interface.

Sections¶

Main entry points (quick links)¶

• Waveform — Time-domain polarizations: WaveformFactory over LALSimulationBackend (default) or PyCBCBackend (optional); direct pycbc_waveform_wrapper for PyCBC-only workflows.
• Projection — Strain per detector (project_polarizations_to_network).
• Injection — Strain into segments (inject_strain, inject_strains_sequential).
• Pipeline — One-call CBC injection (inject_cbc_signal).
• Multichannel — Stacked IFO strains (DetectorStrainStack).
• Network — Named networks and YAML/JSON network configs.
• Simulator — Simulator base class, CBC implementation, and the stable DetectorStrainStack return contract.
• Registry — Lookup GWSimulator subclasses by source_type string (for example bbh).
• Utility — Utility functions.

Top-level package exports¶

import gwmock_signal re-exports the following symbols via gwmock_signal.__init__. Prefer these imports in application code; submodule paths are stable but longer.

See also¶

• User guide overview
• Documentation home