gw_remnant

Getting Started

  • Installation
    • From PyPI
    • From source (development)
    • Dependencies
    • Building the documentation
  • Quick Start
    • Basic usage
    • Using built-in waveform generators
    • Available plot methods

User Guide

  • User Guide
    • Physics Overview
      • How it works
      • Class hierarchy
    • Providing Waveform Data
      • Custom waveforms
      • Built-in waveform generators
        • NRHybSur3dq8
        • BHPTNRSur1dq1e4
        • BHPTNRSur2dq1e3
      • Tips
    • Units and Conventions
      • Geometric units
      • Kick velocity in km/s
      • Sign conventions

API Reference

  • API Reference
    • GWRemnantCalculator
      • GWRemnantCalculator
        • GWRemnantCalculator.h_dot
        • GWRemnantCalculator.E_dot
        • GWRemnantCalculator.E_rad
        • GWRemnantCalculator.Eoft
        • GWRemnantCalculator.Moft
        • GWRemnantCalculator.remnant_mass
        • GWRemnantCalculator.P_dot
        • GWRemnantCalculator.Poft
        • GWRemnantCalculator.voft
        • GWRemnantCalculator.kickoft
        • GWRemnantCalculator.remnant_kick
        • GWRemnantCalculator.remnant_kick_vector
        • GWRemnantCalculator.J_dot
        • GWRemnantCalculator.Joft
        • GWRemnantCalculator.spinoft
        • GWRemnantCalculator.remnant_spin
        • GWRemnantCalculator.spin_vector_oft
        • GWRemnantCalculator.remnant_spin_vector
        • GWRemnantCalculator.L_peak
        • GWRemnantCalculator.peak_kick
        • GWRemnantCalculator.xoft
        • GWRemnantCalculator.remnant_displacement
        • GWRemnantCalculator.get_remnant_properties()
        • GWRemnantCalculator.print_remnants()
    • Remnant Calculators
      • InitialEnergyMomenta
        • InitialEnergyMomenta
      • RemnantMassCalculator
        • RemnantMassCalculator
      • LinearMomentumCalculator
        • LinearMomentumCalculator
      • AngularMomentumCalculator
        • AngularMomentumCalculator
      • PeakLuminosityCalculator
        • PeakLuminosityCalculator
    • Waveform Generator
      • generate_nrhybsur3dq8()
      • generate_bhptnrsur1dq1e4()
      • generate_bhptnrsur2dq1e3()
      • generate_nrsur7dq4()
      • compute_nrsur3dq8_remnant()
      • compute_nrsur7dq4_remnant()
    • GWPlotter
      • GWPlotter
        • GWPlotter.plot_mass_energy()
        • GWPlotter.plot_linear_momentum()
        • GWPlotter.plot_angular_momentum()
        • GWPlotter.plot_kick_velocity()
        • GWPlotter.plot_spin_vector()
        • GWPlotter.plot_trajectory()

Tutorials

  • Tutorials
    • Computing Remnant Properties with gw_remnant
      • Using a pre-computed waveform
      • 1. Load gw_remnant
      • 2. Load waveform data
      • 3. Compute remnants using gw_remnant
      • 4. Compare remnant properties with NRSur3dq8Remnant
      • 5. Plot remnant quantities
    • Computing Remnant Properties from NRSur7dq4 Waveforms
      • 1. Setup
      • 2. Non-spinning binary (q = 2)
      • 3. Non-precessing (aligned-spin) binary
      • 4. Precessing binary
    • Computing Remnant Properties from NRHybSur3dq8 Waveforms
      • 1. Setup
      • 2. Non-spinning binary (q = 4)
      • 3. Aligned-spin binary (q = 3)
      • 4. Anti-aligned-spin binary (q = 2)
    • Computing Remnant Properties from SXS Numerical Relativity Simulations
      • 1. Setup
      • 2. Using E_initial and L_initial from NR metadata
        • 2a. Non-spinning quasi-circular
        • 2b. Non-precessing quasi-circular
        • 2c. Precessing quasi-circular
      • 3. Using native PN E_initial and L_initial
        • 3a. Non-spinning quasi-circular
        • 3b. Non-precessing quasi-circular
        • 3c. Precessing quasi-circular
    • Computing Remnant Properties from Eccentric SXS Simulations
      • 1. Setup
      • 2. Using E_initial and L_initial from NR metadata
        • 2a. Non-spinning, low eccentricity
        • 2b. Non-spinning, high eccentricity
        • 2c. Precessing, eccentric
      • 3. Using native PN E_initial and L_initial
        • 3a. Non-spinning, low eccentricity
        • 3b. Non-spinning, high eccentricity
        • 3c. Precessing, eccentric
    • Computing Remnant Properties from Maya Catalog Waveforms
      • 1. Setup
      • 2. Non-spinning quasi-circular (GT0446, q = 2)
      • 3. Aligned-spin (GT0588, q = 2, chi1z = 0.6, chi2z = 0.6)
      • 4. Precessing (GT0460, q = 2)
      • 5. Non-spinning eccentric (MAYA0951, q = 2, e = 0.04)
    • Computing Remnant Properties from pySEOBNR Waveforms
      • 1. Setup
      • 2. Non-spinning (SEOBNRv5HM, q = 3)
      • 3. Aligned-spin (SEOBNRv5HM, q = 2, chi1z = 0.5, chi2z = -0.3)
      • 4. Precessing (SEOBNRv5PHM, q = 2)
      • 5. Eccentric (SEOBNRv5EHM, q = 2, e = 0.1)

About

  • Citation
  • Contributing
    • Reporting Issues
    • Development Setup
    • Pull Requests
    • Code Style
  • Changelog
    • v0.4.0
    • v0.3.0
    • v0.2.0
    • v0.1.0
gw_remnant
  • Overview: module code

All modules for which code is available

  • gw_remnant.gw_remnant_calculator
  • gw_remnant.gw_utils.gw_plotter
  • gw_remnant.gw_utils.waveform_generator
  • gw_remnant.remnant_calculators.initial_energy_momenta
  • gw_remnant.remnant_calculators.kick_velocity_calculator
  • gw_remnant.remnant_calculators.peak_luminosity_calculator
  • gw_remnant.remnant_calculators.remnant_mass_calculator
  • gw_remnant.remnant_calculators.remnant_spin_calculator

© Copyright 2025, Tousif Islam.

Built with Sphinx using a theme provided by Read the Docs.