This release is a pre-release and may not be stable for production use.
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, François Hébert, Leo C. Stein and Hao Zhang,
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. 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.
Installation
PyPI
surfinBH is available through PyPI:
pip install surfinBH
From source
git clone https://github.com/vijayvarma392/surfinBH
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(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
>>> 'arxiv.2018.xxxx'
Load the fit
This only needs to be done once at the start of your script.
fit = surfinBH.LoadFits(fit_name)
>>> Loaded surfinBH7dq2 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:
Animations
We also provide a tool to visualize the binary black hole scattering process, see black_hole_scattering.
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.
Credits
The code is developed and maintained by Vijay Varma. Please, report bugs to vvarma@caltech.edu.
2 maintainers
Release files for surfinBH 0.1.3.dev0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| surfinBH-0.1.3.dev0.tar.gz | 22.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| surfinBH-0.1.3.dev0-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 22.1 MB
Release files / surfinBH-0.1.3.dev0.tar.gz
| Download URL | surfinBH-0.1.3.dev0.tar.gz |
|---|---|
| Size | 22.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0620af1a8793bc55d6c22adfb52d07f409f7c67c1c2f516e56e80cf83ea566a0
|
|
BLAKE2b-256 checksum How to use checksums |
999d69ef99f1a075490bc912f1758139069813e780f53b1293ab698e9294aaa6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / surfinBH-0.1.3.dev0-py2-none-any.whl
| Download URL | surfinBH-0.1.3.dev0-py2-none-any.whl |
|---|---|
| Size | 22.1 MB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
50ffa82b24edac43e2327d2e43fe72bd04914716272944dcb9cb8f11c8f80818
|
|
BLAKE2b-256 checksum How to use checksums |
f8669c8f97b84978b0c0fe421c0a23c69cddc16dd5e5d79db8302309298f9238
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
