Skip to main content

Surrogate Final BH properties.

Project description

github license Build Status

Welcome to surfinBH!

Point Break

surfinBH provides surrogate final Black Hole properties for mergers of binary black holes (BBH). Just like Point Break, but with black holes!

These fits are described in the following papers:
[1] Vijay Varma, Davide Gerosa, Francois Hebert and Leo C. Stein, 2018, in preparation.

If you find this package useful in your work, please cite reference [1] and, if available, the relevant paper describing the particular model.

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

Get data for fits

This is not required with the pip installation. With the source installation, this only needs to done once, ever.

#NOTE: Not required if installed with pip

You can also get only the particular fit you want.

#NOTE: Not required if installed with pip

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:

Making contributions

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


The code is developed and maintained by Vijay Varma. Please, report bugs to

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 0.0.9.dev1
Filename, size File type Python version Upload date Hashes
Filename, size surfinBH-0.0.9.dev1-py2-none-any.whl (22.1 MB) File type Wheel Python version py2 Upload date Hashes View
Filename, size surfinBH-0.0.9.dev1.tar.gz (21.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page