Skip to main content

Surrogate Final BH properties.

Project description

github PyPI version Conda Version DOI license Build Status

Welcome to surfinBH!


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

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

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

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 is compatible with both python2 and python3. This package lives on GitHub and is tested every day with Travis CI. You can see the current build status of the master branch at the top of this page.



surfinBH is available through PyPI:

pip install surfinBH


surfinBH is available on conda-forge:

conda install -c conda-forge surfinbh

From source

git clone
cd surfinBH
git submodule init
git submodule update
python install

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


All of these can be installed through pip or conda.


import surfinBH

See list of available fits

>>> ['NRSur3dq8Remnant', 'NRSur7dq4Remnant', 'surfinBH7dq2']

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

fit_name = 'NRSur7dq4Remnant'

>>> 'Fits for remnant mass, spin and kick veclocity for generically precessing BBH systems up to mass ratio 4.'

>>> '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.


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.


We also provide ipython examples for usage of different fits:

Current fits
Older fits


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.

You can find the list of contributors here.


The code is developed and maintained by Vijay Varma. 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.

Files for surfinBH, version 1.1.6
Filename, size File type Python version Upload date Hashes
Filename, size surfinBH-1.1.6-py3-none-any.whl (29.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size surfinBH-1.1.6.tar.gz (1.1 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page