Copyright (c) 2020 Black Hole Perturbation Toolkit Team
The BHPTNRSurrogate(s) package provides access to a family of surrogate
gravitational waveform models built on waveforms generated with point-particle
black hole perturbation theory (ppBHPT) framework. These models extend from
comparable mass-ratio to large mass-ratio regimes and are calibrated
to numerical relativity (NR) waveforms in the comprable-mass-ratio regime.
Many harmonic modes are included, for example, the BHPTNRSur1dq1e4 model
includes up to up to
The latest development version will always be available from the project git repository:
git clone https://github.com/BlackHolePerturbationToolkit/BHPTNRSurrogate.git
cd BHPTNRSurrogate
git submodule init
git submodule updateThis model can generate waveforms from non-spinning black hole binary systems with mass ratios varying from 3 to 1000 and spins from −0.8≤χ1≤0.8 on the larger black hole. The waveforms include all spin-weighted spherical harmonic modes up to ℓ=4, except the (4,1) and m=0 modes, and their m<0 counterparts. The uncalibrated raw ppBHPT waveforms are ~13,500M long.
Model details can be found in the following paper: Gravitational wave surrogate model for spinning, intermediate mass ratio binaries based on perturbation theory and numerical relativity
This model can generate waveforms from non-spinning black hole binary
systems with mass ratios varying from 2.5 to 10000. It supports a total of 50
modes : [(2,2),(2,1),(3,1),(3,2),(3,3),(4,2),(4,3),(4,4),(5,3),
(5,4),(5,5),(6,4),(6,5),(6,6),(7,5),(7,6),(7,7),(8,6),(8,7),(8,8),(9,7),(9,8),(9,9),(10,8),(10,9)]
and their m<0 counterparts, with modes up to
Model details can be found in the following paper: Surrogate model for gravitational wave signals from non-spinning, comparable- to large-mass-ratio black hole binaries built on black hole perturbation theory waveforms calibrated to numerical relativity
EMRISur1dq1e4 is the predecessor of the BHPTNRSur1dq1e4 model, which includes numerous
numerous upgrades (please see table 1). EMRISur1dq1e4 is
a non-spinning model trained for mass ratios
Both BHPTNRSur models use total mass by default (mass_scale='M'). For
uncalibrated waveforms, the underlying ppBHPT data use the primary mass m1, so
the package rescales both time and strain by q/(q+1) to return total-mass units.
This changes the default for uncalibrated waveforms from the implicit m1
convention used before version 0.2.0. To reproduce that earlier behavior, pass
mass_scale='m1' explicitly. This option is only available for uncalibrated
geometric waveforms; calibrated and physical waveforms require mass_scale='M'.
This package requires Python 3.8 or newer. Runtime dependencies, including scikit-learn for the two-dimensional model, are installed automatically.
Parts of the accompanying Jupyter notebook will require gwsurrogate, which can be installed with either pip
pip install gwsurrogateor conda
conda install -c conda-forge gwsurrogateNote that you do not need gwsurrogate to evaluate the EMRI surrogate model or run most parts of the notebook.
- Clone the repository
- Download the datafiles from Zenodo
wget https://zenodo.org/records/13340319/BHPTNRSur1dq1e4.h5
wget https://zenodo.org/records/13340319/BHPTNRSur2dq1e3.h5-
Create
BHPTNRSurrogate/data/and move the files into it. -
Install the package locally:
pip install -e .Alternatively, if you skip steps 2-3, the h5 data files will be automatically downloaded into the package's data/ directory the first time you call a model. This follows the package-local strategy used by gwsurrogate.
Set BHPTNR_SURROGATE_DATA_DIR before importing the package to use a custom data directory.
Example tutorial notebooks for the BHPTNRSur1dq1e4 and BHPTNRSur2dq1e3 models are available here BHPTNRSurrogate/tutorials.
For example,
jupyter notebook BHPTNRSur1dq1e4.ipynbKnown bugs are recorded in the project bug tracker:
https://github.com/BlackHolePerturbationToolkit/BHPTNRSurrogate/issues
This code is distributed under the MIT License. Details can be found in the LICENSE file.
Ritesh Bachhar, Scott Field, Tousif Islam, Gaurav Khanna, Nur Rifat, Katie Rink, Vijay Varma
If you make use of any module from the Black Hole Perturbation Toolkit in your research, please acknowledge using:
This work makes use of the Black Hole Perturbation Toolkit.
If you make use of the BHPTNRSur models, please cite the following papers:
@article{Islam:2022laz,
author = "Islam, Tousif and Field, Scott E. and Hughes, Scott A. and Khanna, Gaurav and Varma, Vijay and Giesler, Matthew and Scheel, Mark A. and Kidder, Lawrence E. and Pfeiffer, Harald P.",
title = "{Surrogate model for gravitational wave signals from nonspinning, comparable-to large-mass-ratio black hole binaries built on black hole perturbation theory waveforms calibrated to numerical relativity}",
eprint = "2204.01972",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevD.106.104025",
journal = "Phys. Rev. D",
volume = "106",
number = "10",
pages = "104025",
year = "2022"
}
@article{Rink:2024swg,
author = "Rink, Katie and Bachhar, Ritesh and Islam, Tousif and Rifat, Nur E. M. and Gonzalez-Quesada, Kevin and Field, Scott E. and Khanna, Gaurav and Hughes, Scott A. and Varma, Vijay",
title = "{Gravitational wave surrogate model for spinning, intermediate mass ratio binaries based on perturbation theory and numerical relativity}",
eprint = "2407.18319",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
month = "7",
year = "2024"
}