gwModels

gwModels is a Python package hosting data-driven and phenomenological models for the gravitational radiation (waveforms) emitted from binary black hole mergers, along with remnant property models for final mass, spin, and kick velocity.

For questions, suggestions, or collaborations, please email tousifislam24@gmail.com.

Available Models

Waveform Frameworks

Model	Description	Reference	Tutorial
gwNRHME	Non-spinning quasi-circular HM waveform → eccentric	2403.15506	1_1
gwNRXHME	Non-precessing quasi-circular HM waveform → eccentric	2502.02739	1_1

Eccentric Higher-Mode Waveforms

Model	Components	Reference	Tutorial
NRHybSur3dq8-gwNRHME	NRHybSur3dq8 + SEOBNRv5EHM	2408.02762	2_1
BHPTNRSur1dq1e4-gwNRHME	BHPTNRSur1dq1e4 + SEOBNRv5EHM	2408.02762	2_2

Eccentricity Estimation

Model	Description	Reference	Tutorial
eccentricity_estimation	Computes \(e_{\xi}\), \(e_{\omega}\), \(e_{\rm gw}\)	2502.02739	3_1

Dynamics: Eccentricity Evolution

Model	Type	Parameter Range	Reference	Tutorial
gwEccEvNS	NR-based approximate	Non-spinning	2502.02739	4_1
gwEccEvNSv2	Analytical	Non-spinning	2604.17868	4_2
gwEccEvolve_NoSpinq4	SVD surrogate + GPR	\(1 \leq q \leq 4\), \(0.003 \leq e_0 \leq 0.443\)	2604.17868	4_3

Remnant: Kick Velocity

Model	Type	Valid Range	Extra Deps	Reference	Tutorial
gwModel_kick_q200	Analytical (aligned)	\(1 \leq q \leq 1000\)	—	2511.11536	5_1
gwModel_kick_q200_GPR	GPR (aligned)	\(1 \leq q \leq 1000\)	scikit-learn	2511.11536	5_1
gwModel_kick_prec_flow	Normalizing flow (prec.)	\(q \leq 100\)	torch, nflows	2511.11536	5_1
HLZ_2014_aligned_spin	Analytical (aligned)	—	—	1406.7295	5_2
bbh_final_kick_precessing_CLZM2007	Analytical (prec.)	—	—	Gonzalez+ 2007	5_2

Remnant: Final Mass and Spin

Model	Quantity	Spin Type	Reference	Tutorial
bbh_final_mass_precessing_BMR2012	Final mass	Precessing	Barausse, Morozova & Rezzolla (2012)	5_2
bbh_final_spin_precessing_HBR2016	Final spin	Precessing	Hofmann, Barausse & Rezzolla (2016)	5_2
bbh_final_mass_non_precessing_UIB2016	Final mass	Aligned	1611.00332	5_2
bbh_final_spin_non_precessing_UIB2016	Final spin	Aligned	1611.00332	5_2

Contents

• Installation
  • From PyPI
  • From source
  • Dependencies
  • Building the documentation
• Quick Start
  • Eccentric waveform with higher modes (gwNRHME)
  • Eccentricity estimation
  • Eccentricity evolution models
  • Aligned-spin kick velocity
  • Precessing kick distribution
  • Final mass and spin
• API Reference
  • Frameworks
  • Waveforms
  • Eccentricity Measures
  • Dynamics
  • Remnants
  • Utilities
• Notebook Tutorials
  • Example notebook to use gwNRHME framework
  • Example notebook to use NRHybSur3dq8-gwNRHME model
  • Example notebook to use BHPTNRSur1dq1e4-gwNRHME model
  • Example notebook to compute eccentricity \(e_{\xi}(t)\) from waveforms
  • 1. Load waveforms
  • 2. Compute eccentricity \(e_{\xi}\)
  • 3. Compare with gw-eccentricity package
  • 4. Diagnostic plots of all modulation parameters, fits and gwModels eccentricity
  • 5. Calculate smooth \(e_{\rm gw}\) and \(e_{\omega}\) directly from gwModels using \(e_{\xi}\) envelops
  • gwEccEvNS : a simple model for eccentricity evolution in time domain for non-spinning binaries
  • gwEccEvNSv2 : analytical model for eccentricity evolution in time domain for non-spinning binaries
  • gwEccEvolve_NoSpinq4 : SVD surrogate model for eccentricity evolution in non-spinning binaries
  • gwModels kick velocity models
  • Remnant models: final mass, spin, and kick
• Citation
• Contributing
  • Reporting Issues
  • Development Setup
  • Pull Requests
  • Code Style
  • Contact