Skip to main content

A Backwards-One-Body Gravitational Waveform Package

Project description

gwBOB Logo

gwBOB

The Backwards-One-Body Gravitational Waveform Package

License: MIT Build Status Documentation Status Python Version Project Status

Getting Started

Please see more detailed documentation here!

What is the Backwards One Body Model?

The Backwards One Body (BOB) model is an analytical and physically motivated approach to modeling gravitational waveforms from black hole binary mergers, as described in arXiv:1810.00040. The BOB model is based on the physical insight that, during the late stages of binary evolution, the spacetime dynamics of the binary system closely resemble a linear perturbation of the final, stationary black hole remnant.


Features

  • Analytical accuracy: Closed form expressions for the amplitude and frequency evolution.
  • Minimally Calibrated: Requires minimal calibration to numerical relativity (NR)
  • Test all BOB flavors Easily generate and switch between different "flavors" of BOB depending on your research problem.
  • Easy initialization Easy initialization using SXS, CCE, or raw NR data.
  • Beyond Kerr waveforms Compare NR data to BOB waveforms generated with custom QNMs.
  • Easy comparisons: Easy comparisons to waveforms from the public SXS and CCE catalog, as well as raw NR data.
  • Well Documented and Actively Developed

Generate plots like these with just a few lines of code!

Requirements

  • (Windows users should use WSL)
  • kuibit
  • sxs
  • qnmfits
  • scri
  • jax (install the GPU compatible version if possible)
  • sympy
  • numpy
  • scipy
  • matplotlib

Install via pip

pip install gwBOB

Citing this Code

If you use this code please cite

@article{mcwilliams2019analytical,
  title={Analytical black-hole binary merger waveforms},
  author={McWilliams, Sean T},
  journal={Physical review letters},
  volume={122},
  number={19},
  pages={191102},
  year={2019},
  publisher={APS}
}
@misc{kankani2025bobwaveformbuilderoptimizing,
      title={BOB the (Waveform) Builder: Optimizing Analytical Black-Hole Binary Merger Waveforms}, 
      author={Anuj Kankani and Sean T. McWilliams},
      year={2025},
      eprint={2510.25012},
      archivePrefix={arXiv},
      primaryClass={gr-qc},
      url={https://arxiv.org/abs/2510.25012}, 
}

BOB paper to be added.

JOSS paper to be added.

Contributing

Contributions are always welcome! If you find an issue, or have any questions on how to use the code, please raise an issue on this repo. If you want to contribute directly to the code, please fork the code and create a pull request!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gwbob-1.0.2.tar.gz (38.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gwbob-1.0.2-py3-none-any.whl (36.1 kB view details)

Uploaded Python 3

File details

Details for the file gwbob-1.0.2.tar.gz.

File metadata

  • Download URL: gwbob-1.0.2.tar.gz
  • Upload date:
  • Size: 38.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for gwbob-1.0.2.tar.gz
Algorithm Hash digest
SHA256 abb20767c7adb6fe3056892f8874db4c6140443b96be58f352c32a9b43c64b2d
MD5 a0733be328f95c9741f73d5184cf28b6
BLAKE2b-256 823141692f07e868764ff70e7edcadd5a129fad90eaf0aee21f89f150a333565

See more details on using hashes here.

File details

Details for the file gwbob-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: gwbob-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 36.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for gwbob-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 30a49aec7c35db07874109d369cc0975e157a765783ce5f7ade9fc9c9c8ca249
MD5 b0d936107855fd76612a3a7b9159e863
BLAKE2b-256 c2771f2ae0ec419113f1a2af01343ecfac2f00c4d40a3cec919d6c42381fdbed

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page