Welcome to GWForge’s documentation!

A lightweight code to generate mock gravitational wave detector data using user-defined population and arbitrary detector sensitivity. It ships six tools – gwforge_population, gwforge_noise, gwforge_inject, gwforge_glitch, gwforge_fisher and gwforge_population_fisher – plus gwforge_workflow, which chains noise, injections and glitches into an HTCondor DAG, and gwforge_optimal_snr and gwforge_estimate_psd for the bookkeeping in between.

Installation

To install this library for development or use, follow the instructions here

Documentation

Heavily under-development documentation is accessible here

License

gwforge is released under the MIT License. (see here for a description of the license).

Warning

This library is under heavy development. The code may be unstable and can break.

Contents:

• Installation:
  • 1. Create Conda Environment:
  • 2. Install Optional dependencies
  • 3. Finally install the package itself
• Usage and Examples
  • Simulating the source population
  • Simulating the detector noise
  • Injecting a signal
  • Adding glitches
  • Detector response
  • Fisher and DALI Forecasts
  • Population Fisher Forecasts
  • A workflow for gwforge
• API Reference