Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Surrogate Final BH properties.

Project description

github PyPI 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, Davide Gerosa, Leo C. Stein, François Hébert and Hao Zhang, arxiv:1809.09125.

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

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

>>> ['surfinBH3dq8', 'surfinBH7dq2']

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

fit_name = 'surfinBH7dq2'

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

>>> 'arxiv:1809.09125'

Load the fit

This only needs to be done once at the start of your script.

fit = surfinBH.LoadFits(fit_name)
>>> Loaded surfinBH7dq2 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:


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.

Filename, size & hash SHA256 hash help File type Python version Upload date
surfinBH-1.0.3-py2-none-any.whl (22.1 MB) Copy SHA256 hash SHA256 Wheel py2
surfinBH-1.0.3.tar.gz (21.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page