API Reference

The Python package installed by this repository is named gwnr. It is organized into nine subpackages:

Subpackage Purpose
gwnr.waveform Waveform generation, conditioning, alignment, hybridization, eccentricity, tidal corrections, parameter conversions
gwnr.analysis Matched-filter comparisons (faithfulness, fitting factors), PSDs, GW catalogs, template banks
gwnr.nr Numerical-relativity waveforms and simulation output (SXS, SpEC, SpECTRE)
gwnr.stats Bayesian inference setup, samplers, Fisher matrices, distributions
gwnr.graph Plotting: corner plots, contour/scatter panels, ParaView, notebook video embedding
gwnr.cosmo Cosmological conversions and redshift sampling
gwnr.workflow HTCondor DAG / batch-analysis generation
gwnr.data Bundled detector noise curves
gwnr.utils General-purpose helpers and type conversions

These pages document the public API as it exists in the source tree; docstring text is summarized from the code. For exact call signatures and full parameter lists, consult the linked source files or use help() / ? in an interactive session.

Top-level package contents:

  • gwnr.get_version_information() — returns the version string stamped into gwnr/.version at build time.

Table of contents


Copyright © Prayush Kumar. Distributed under the GPL license.

This site uses Just the Docs, a documentation theme for Jekyll.