Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.

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'

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
surfinBH.DownloadData()

You can also get only the particular fit you want.

#NOTE: Not required if installed with pip
surfinBH.DownloadData(fit_name)

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:

Making contributions

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

Credits

The code is developed and maintained by Vijay Varma. Please, report bugs to vvarma@caltech.edu.

Metadata

Release files for surfinBH 0.0.9.dev0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for surfinBH 0.0.9.dev0
File Size Uploaded Provenance Actions
surfinBH-0.0.9.dev0.tar.gz 20.9 kB Without provenance Details for surfinBH-0.0.9.dev0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for surfinBH 0.0.9.dev0
File Interpreter ABI Platform Actions
surfinBH-0.0.9.dev0-py2-none-any.whl Python 2 none any Details for surfinBH-0.0.9.dev0-py2-none-any.whl

Total release size: 22.1 MB

Release files / surfinBH-0.0.9.dev0.tar.gz

Download URL surfinBH-0.0.9.dev0.tar.gz
Size 20.9 kB
Tags Source
SHA-256 checksum
How to use checksums
cfba6640cf0163dae8c5019ce2e465dcaa0e64cb0388cfde5e8afe78fca15ad6
BLAKE2b-256 checksum
How to use checksums
cb7357e70fde4a66957c574e07a76699dac33dc3dcc1a82720586782f433727e
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.0.9.dev0-py2-none-any.whl

Download URL surfinBH-0.0.9.dev0-py2-none-any.whl
Size 22.1 MB
Tags Python 2
SHA-256 checksum
How to use checksums
1536e5552e56e21f21feba99e57946f97a82f5396cbc12beedcad3a30bd82e53
BLAKE2b-256 checksum
How to use checksums
637542dfcda51e5c57766daf11d58243d864acbda1bb3fe16897b88570cbc9b5
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

Security for surfinBH 0.0.9.dev0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page