gwModels

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
      • Base class
        • BaseEccentricHM
      • gwNRHME
        • NRHME
      • gwNRXHME
        • NRXHME
    • Waveforms
      • Eccentric higher-mode models
        • IMRHME
        • NRHybSur3dq8_gwNRHME
        • BHPTNRSur1dq1e4_gwNRHME
        • IMRPhenomTHM_gwNRHME
      • External models
        • NR surrogate models
        • BHPT surrogate models
        • SEOB models
        • LAL models
    • Eccentricity Measures
      • PN eccentricity evolution
        • compute_tau()
        • Newtonian_e_t()
        • PN2_e_t()
        • PN3_e_t()
      • Eccentricity from modulations
        • ComputeEccentricityFromModulations
        • ComputeEccentricity
      • Eccentricity from orbital frequency
        • ComputeEccentricityFromOmega
      • Initial eccentricity
        • compute_et_harmonic_3PN()
        • compute_et_ADM_2PN()
    • Dynamics
      • gwEccEvNS
        • gwEccEvNS_model()
      • gwEccEvNSv2
        • gwEccEvNSv2()
      • gwEccEvolve
        • gwEccEvolve_NoSpinq4
    • Remnants
      • Non-precessing kick (Islam & Wadekar 2025)
        • gwModel_kick_q200()
      • GPR kick (Islam & Wadekar 2025)
        • gwModel_kick_q200_GPR
      • Precessing kick flow (Islam & Wadekar 2025)
        • gwModel_kick_prec_flow
      • HLZ kick
        • spin_difference_vector()
        • total_spin_vector()
        • calculate_kick_components()
        • bbh_final_kick_precessing_CLZM2007()
        • bbh_final_kick_nonprecessing_HLZ2014()
      • HBR final mass and spin
        • energy_at_isco()
        • angular_momentum_at_isco()
        • angle_between_spins()
        • angle_correction()
        • bbh_final_mass_precessing_BMR2012()
        • bbh_final_spin_precessing_HBR2016()
      • UIB2016 final mass and spin
        • bbh_final_mass_non_precessing_UIB2016()
        • bbh_final_spin_non_precessing_UIB2016()
      • Utilities
        • validate_q()
        • validate_spin_magnitudes()
        • validate_spin_z()
        • symmetric_mass_ratio()
        • kerr_isco_radius()
    • Utilities
      • Alignment
        • get_peak()
        • check_pi_rotation()
        • phase_align_dict()
        • AlignWFData
      • Peak finding
        • PeakFinderCrude
        • PeakFinderScipy
      • Waveform features
        • get_amplitude()
        • get_phase()
        • get_frequency()
        • get_gw_frequency()
      • Metrics
        • mathcalE_error()
        • simple_mismatch()
      • Plot settings
        • set_rcparams()
  • Notebook Tutorials
    • Example notebook to use gwNRHME framework
      • 1. Generate eccentric 22 mode waveform
      • 2. Generate multi-modal circular waveform
      • 3. Combine them to obtain multi-modal eccentric waveforms
    • Example notebook to use NRHybSur3dq8-gwNRHME model
      • 1. Generate waveforms by combining NRHybSur3dq8 (multi-mode) and SEOBNRv5EHM (22 mode)
      • 2. Generate waveforms from combined model using NRHybSur3dq8_gwNRHME
    • Example notebook to use BHPTNRSur1dq1e4-gwNRHME model
      • 1. Generate waveforms by combining BHPTNRSur1dq1e4 (multi-mode) and SEOBNRv5EHM (22 mode)
      • 2. Generate waveforms from combined model using BHPTNRSur1dq1e4_gwNRHME
    • 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
      • Example evolution
    • gwEccEvNSv2 : analytical model for eccentricity evolution in time domain for non-spinning binaries
      • Example evolution
    • gwEccEvolve_NoSpinq4 : SVD surrogate model for eccentricity evolution in non-spinning binaries
      • Load the model
      • Single evaluation
      • Evaluation with uncertainty
      • Parameter-space sweep
    • gwModels kick velocity models
      • 1. Aligned-spin kicks : gwModel_kick_q200
      • 2. Aligned-spin GPR kicks : gwModel_kick_q200_GPR
      • 3. Precessing-spin kicks : gwModel_kick_prec_flow
      • 3. Batched sampling and density evaluation
        • Validation: batched sampling vs one-by-one sampling
        • Conditional density: log_prob
      • gwmodel vs HLZ on the same population
    • Remnant models: final mass, spin, and kick
      • 1. HLZ precessing kick velocity
      • 2. HLZ aligned-spin kick (arXiv:1406.7295)
      • 3. HBR final mass (Barausse, Morozova & Rezzolla 2012)
      • 4. HBR final spin (Hofmann, Barausse & Rezzolla 2016)
      • 5. UIB2016 final mass and spin (aligned-spin, Jimenez Forteza et al.)
  • Citation
  • Contributing
    • Reporting Issues
    • Development Setup
    • Pull Requests
    • Code Style
    • Contact
gwModels
  • API Reference
  • View page source

API Reference

  • Frameworks
    • Base class
    • gwNRHME
    • gwNRXHME
  • Waveforms
    • Eccentric higher-mode models
    • External models
  • Eccentricity Measures
    • PN eccentricity evolution
    • Eccentricity from modulations
    • Eccentricity from orbital frequency
    • Initial eccentricity
  • Dynamics
    • gwEccEvNS
    • gwEccEvNSv2
    • gwEccEvolve
  • Remnants
    • Non-precessing kick (Islam & Wadekar 2025)
    • GPR kick (Islam & Wadekar 2025)
    • Precessing kick flow (Islam & Wadekar 2025)
    • HLZ kick
    • HBR final mass and spin
    • UIB2016 final mass and spin
    • Utilities
  • Utilities
    • Alignment
    • Peak finding
    • Waveform features
    • Metrics
    • Plot settings
Previous Next

© Copyright 2024, Tousif Islam.

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