Skip to main content

Surrogate Final BH properties.

Project description

github PyPI version Conda Version DOI license Build Status

Welcome to surfinBH!

BHScattering

surfinBH provides surrogate final Black Hole properties for mergers of binary black holes (BBH).

These fits are described in the following papers:
[1] V. Varma, D. Gerosa, L. C. Stein, F. Hébert and H. Zhang, arxiv:1809.09125.

[2] V. Varma, S. E. Field, M. A. Scheel, J. Blackman, D. Gerosa, L. C. Stein, L. E. Kidder, H. P. Pfeiffer, arxiv:1905.09300.

[3] M. Boschini, D. Gerosa, V. Varma, et al., arXiv:2307.03435

[4] L. Magaña Zertuche, L. C. Stein, et al., arXiv:2408.05300

If you find this package useful in your work, please cite reference [1] and, if available, the relevant paper describing the particular model. Please also cite this package, see the DOI badge at the top of this page for BibTeX keys.

This package lives on GitHub, is compatible with python3, and is tested every week. You can see the current build status of the master branch at the top of this page.

Installation

PyPI

surfinBH is available through PyPI:

pip install surfinBH

Conda

surfinBH is available on conda-forge:

conda install -c conda-forge surfinbh

From source

git clone git@github.com:vijayvarma392/surfinBH.git
cd surfinBH
git submodule init
git submodule update
python setup.py install

If you do not have root permissions, replace the last step with python setup.py install --user

Dependencies

All of these can be installed through pip or conda.

Usage

import surfinBH

See list of available fits

print(list(surfinBH.fits_collection.keys()))
>>> ['NRSur3dq8Remnant', 'surfinBH7dq2', 'NRSur7dq4Remnant', 'NRSur7dq4EmriRemnant', 'NRSur3dq8_RD']

Pick your favorite fit and get some basic information about it.

fit_name = 'NRSur7dq4Remnant'

surfinBH.fits_collection[fit_name].desc
>>> 'Fits for remnant mass, spin and kick veclocity for generically precessing BBH systems up to mass ratio 4.'

surfinBH.fits_collection[fit_name].refs
>>> 'arxiv:1905.09300'

Load the fit

This only needs to be done once at the start of your script. If the fit data is not already downloaded, this will also download the data.

fit = surfinBH.LoadFits(fit_name)
>>> Loaded NRSur7dq4Remnant fit.

Evaluation

The evaluation of each fit is different, so be sure to read the documentation. This also describes the frames in which different quantities are defined.

help(fit)

We also provide ipython examples for usage of different fits:

Current fits
Older fits

Animations

We also provide a tool to visualize the binary black hole scattering process, see binary black hole explorer. Here's an example:

Making contributions

See this README for instructions on how to make contributions to this package.

Credits

The code is maintained by Vijay Varma. You can find the list of contributors here. Please report bugs by raising an issue on our GitHub repository.

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

surfinBH-1.2.6.tar.gz (32.4 kB view details)

Uploaded Source

Built Distribution

surfinBH-1.2.6-py3-none-any.whl (22.1 MB view details)

Uploaded Python 3

File details

Details for the file surfinBH-1.2.6.tar.gz.

File metadata

  • Download URL: surfinBH-1.2.6.tar.gz
  • Upload date:
  • Size: 32.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for surfinBH-1.2.6.tar.gz
Algorithm Hash digest
SHA256 03d074526c6236a4da2bf510f067a0eb39a4389224e8e0c5e07650a5debbe515
MD5 dbd58a83bee04a5f6daa3e9631eafc56
BLAKE2b-256 4c3df027727ffbcd2f94a6c694b17d2b1a8e4712103a9921ac50b6f56d16bb01

See more details on using hashes here.

File details

Details for the file surfinBH-1.2.6-py3-none-any.whl.

File metadata

  • Download URL: surfinBH-1.2.6-py3-none-any.whl
  • Upload date:
  • Size: 22.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for surfinBH-1.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 750c6e00e714a48982fca9d3cd574f9bdf917694ce7a75cf220e66d84244a3ec
MD5 f69dd42d3745d2e2187c11758ff035d3
BLAKE2b-256 95e51df52ed0507e41c699192707f2f4edf971210f69ec96cf40f5dc76a16ddf

See more details on using hashes here.

Supported by

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