Welcome to pyseobnr’s documentation!

Contents:

• Installation
  • Install pyseobnr from source
  • Installing optional dependencies to run checks
  • Installing optional dependencies to build documentation
  • Developments and tests
  • Platform specific instructions
• Using pyseobnr
  • Standard interface
  • EOB internal interface
  • Usage through pyCBC
• Expert mode and debugging
• References
• Contributing to pyseobnr
  • Before contributing
  • Development guidelines

Notebooks

• PySEOBNR introduction
• SEOBNRv5PHM: spin-precessing model example
• Activation of the anti-symmetric modes
• SEOBNRv5EHM: aligned spin eccentric model example
• Using the pyseobnr interface
• A note on conventions
• Generate modes and polarizations in physical units with LAL conventions
• Using the gwsignal interface (new waveform interface)
• pSEOB example
• pyCBC example

API

Throughout the code we refer to several different technical documents, that can be found here

pyseobnr.generate_waveform
pyseobnr.eob.dynamics
pyseobnr.eob.waveform
pyseobnr.eob.fits
pyseobnr.eob.utils
pyseobnr.eob.hamiltonian
pyseobnr.models	Models of waveforms.
pyseobnr.auxiliary.mode_mixing.auxiliary_functions_modemixing	Mode mixing fitting function and coefficients from [Berti2014].

Todos