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!
And check out the tutorial notebooks in this repo!

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}
}

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.0.tar.gz (6.3 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.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gwbob-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b4a3f9e89cae29ad4ea2ccad2452afb157ad493628f985ae8cc8df612b1e0e4b
MD5 2c0da901447401ad986dece0603e9fb2
BLAKE2b-256 9503ce0ed0a6cd3cda9a2b496b5f7e3f6ddbb3b4b3db6c2cf2efe6f9c7eac8e1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for gwbob-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e27277f761dda108cec0bd9e502aaf7b6c89a236fe57fd1e956d7a4039f5903
MD5 a8e5f698e042914ed272f7f0eb1f3c57
BLAKE2b-256 2b9c5f68b26d4a8f39fe9f752bb82311ef238817a768c385578f69db9db29236

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