Surrogate Final BH properties.
Project description
Welcome to surfinBH!
surfinBH provides fits for Surrogate Final Black Hole properties from mergers of binary black holes (BBH). Just like Point Break, but with black holes! This package lives on GitHub.
These fits are described in the following papers:
[1] Vijay Varma, Davide Gerosa, Francois Hebert and Leo C. Stein, 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.
Installation
PyPi
surfinBH is available through PyPi.
pip install surfinBH
From source
git clone https://github.com/vijayvarma392/surfinBH
cd surfinBH
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.
- numpy
- scipy
- scikit-learn (at least 0.19.1)
- h5py
Usage
import surfinBH
See list of available fits
print(surfinBH.fits_collection.keys())
>>> ['surfinBH3dq8', 'surfinBH7dq2']
Pick your favorite fit and get some basic information about it.
fit_name = 'surfinBH7dq2'
surfinBH.fits_collection[fit_name].desc
>>> 'Fits for remnant mass, spin and kick veclocity for generically precessing BBH systems.'
surfinBH.fits_collection[fit_name].refs
>>> 'Varma:2018_inprep'
surfinBH.fits_collection[fit_name].refs_url
>>> 'arxiv.2018.xxxx'
Get data for the fit. This only needs to done once, ever.
surfinBH.DownloadData(fit_name)
>>> fit_7dq2.h5 100%[======================>] 42.85M 495KB/s in 60s
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 defines the frames in which different quantities are defined.
help(fit)
Evaluate the fit. Here we show the evaluation for the surfinBH7dq2 model.
q = 1.2
chiA = [0.1, 0.2, 0.3]
chiB = [0.2, -0.5, 0.3]
x = [q] + chiA + chiB
print(x)
>>> [1.2, 0.1, 0.2, 0.3, 0.2, -0.5, 0.3]
# Final mass and its 1-sigma error etimate
mC, mC_err_est = fit('mC', x)
# Final spin vector and its 1-sigma error estimate
chiC, chiC_err_est = fit('chiC', x)
# Final kick vector and its 1-sigma error estimate
velC, velC_err_est = fit('velC', x)
Credits
The code is developed and maintained by Vijay Varma. Please, report bugs to vvarma@caltech.edu.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file surfinBH-0.0.5.dev1.tar.gz.
File metadata
- Download URL: surfinBH-0.0.5.dev1.tar.gz
- Upload date:
- Size: 10.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.1.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/2.7.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 70cd413f854766d6da6fb8cf88a051de2e8a21c50bf352d409c240aba487e9e8 |
|
| MD5 | 1ba7382d9b02f3a00628941ad1a21c1f |
|
| BLAKE2b-256 | f860f265fe37385d444e699b912f4414d3764c1691829623c6858a58d9220130 |
File details
Details for the file surfinBH-0.0.5.dev1-py2-none-any.whl.
File metadata
- Download URL: surfinBH-0.0.5.dev1-py2-none-any.whl
- Upload date:
- Size: 12.8 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.1.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/2.7.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8bc55be7d9a89a15fd1616566b6309b79f34c5c0da458791867d1b6038c14417 |
|
| MD5 | 6262c57c66c8d19b410a21d240b655a4 |
|
| BLAKE2b-256 | f90acd2e8f469229d779b8a6cb1225310f04f29a1e6a103cb73f28d3bb06a180 |
