DOI: 10.5281/zenodo.1215752
title: Binary black-hole surrogate waveform catalog

description: This repository contains all publicly available numerical relativity surrogate data for waveforms produced by the Spectral Einstein Code. The base method for building surrogate models can be found in Field et al., PRX 4, 031006 (2014).

Several numerical relativity surrogate models are currently available in this catalog:



Current models





NRHybSur3dq8_CCE.h5 — This is a surrogate model for binary black hole systems built using CCE waveforms, capturing memory effects, with generic mass ratios but restricted to nonprecessing spins. Before constructing the surrogate, the NR waveforms are hybridized with post-Newtonian waveforms to include the early inspiral. Therefore this model covers full stellar mass range for for ground-based detectors. A paper describing it can be found at  Yoo et al., Phys. Rev. D 108, 064027 (2023). It is evaluated with the gwsurrogate Python package, which can be found on  PyPI.




NRHybSur2dq15.h5 — This is a surrogate model for binary black hole systems with a high mass ratio (up to 15), but restricted to nonprecessing spins and no secondary spin. Before constructing the surrogate, the NR waveforms are hybridized with SEOBNRv4HM to include the early inspiral. Therefore this model covers 9.5 solar mass or higher total mass system for ground-based detectors. A paper describing it can be found at Yoo et al., Phys. Rev. D 106, 044001 (2022). It is evaluated with the gwsurrogate Python package, which can be found on  PyPI.




NRSur7dq4.h5 — This is a surrogate model for binary black hole mergers with generic spins and mass ratios up to 4. A paper describing it can be found at Varma et al., Phys. Rev. Research 1, 033015 (2019). It is evaluated with the gwsurrogate Python package, which can be found on PyPI . Instructions for evaluating this surrogate can be found at this example IPython code .




NRHybSur3dq8.h5 — This is a surrogate model for binary black hole systems with generic mass ratios but restricted to nonprecessing spins. Before constructing the surrogate, the NR waveforms are hybridized with post-Newtonian waveforms to include the early inspiral. Therefore this model covers the full stellar mass range for ground-based detectors. A paper describing it can be found at Varma et al., PRD 99, 064045 (2019).  It is evaluated with the gwsurrogate Python package, which can be found on PyPI . Instructions for evaluating this surrogate can be found this example IPython code .




NRSur7dq4Remnant — This is a surrogate model for mass, spin, and recoil kick velocity of the remnant BH left behind in generically precessing binary black hole mergers, with mass ratios up to 4. A paper describing it can be found at Varma et al., Phys. Rev. Research 1, 033015 (2019). It is evaluated with the surfinBH Python package, which can be found on PyPI. Installation instructions and an ipython help notebook can be found in the same link.




NRSur7dq4EmriRemnant — This is a surrogate model for mass and spin of the remnant BH left behind in generically precessing binary black hole mergers, extending to arbitrary mass ratios. A paper describing it can be found at Boschini et al., Phys. Rev. D 108, 084015 (2023). It is evaluated with the surfinBH Python package, which can be found on PyPI. Installation instructions and an ipython help notebook can be found in the same link.


NRSur3dq8_RD — This is a surrogate model for mass, spin, and complex quasinormal mode amplitudes of the remnant BH left behind from mergers with mass ratios up to 8 but restricted to nonprecessing spins. A paper describing it can be found at Magaña Zertuche et al., arxiv:2408.05300. It is evaluated with the surfinBH Python package, which can be found on PyPI. Installation instructions and an ipython help notebook can be found in the same link.

SEOBNRv4PHMSur — This is a surrogate model for binary black hole systems described by the precessing effective one body (EOB) waveform model SEOBNRv4PHM. The model is valid for mass ratio <= 20.  A paper describing it can be found at Gadre et al., arXiv:2203.00381. It is evaluated with the gwsurrogate Python package, which can be found on PyPI.

NRSur3dq8BMSRemnant — This is a surrogate model for the initial-to-final BMS transformation from mergers with mass ratios up to 8 but restricted to nonprecessing spins. A paper describing it can be found at Da Re et al., arxiv:2503.09569. It is evaluated with the surfinBH Python package, which can be found on PyPI. Installation instructions and an ipython help notebook can be found in the same link.



Older models





SpEC_q1_10_NoSpin_nu5thDegPoly_exclude_2_0.h5 — A surrogate model for binary black hole mergers with non-spinning black holes. This is describedin Blackman et al., PRL115, 121102 (2015). It is evaluated with the gwsurrogate python package, which can be found on PyPI . Instructions for evaluating this surrogate can be found in tutorials included with the gwsurrogate package and in this example IPython code .




NRSur4d2s_FDROM_grid12.h5 and NRSur4d2s_TDROM_grid12.h5 — These are fast frequency-domain and time-domain (respectively) surrogate models for binary black hole mergers where the black holes may be spinning, but the spins are restricted to a parameter subspace which includes some but not all precessing configurations. NRSur4d2s_FDROM_grid12.h5 is the NRSur4d2s_FDROM model described in Blackman et al., PRD 95, 104023, (2017), and NRSur4d2s_TDROM_grid12.h5 is built from the underlying (slower) NRSur4d2s time-domain model in the same way but without the FFTs. These surrogates are also evaluated using gwsurrogate, and a tutorial can be found in this example IPython code .




NRSur7dq2.h5 — This is a surrogate model for binary black hole mergers with generic spins. A paper describing it can be foundat Blackman et al., PRD 96, 024058 (2017). This surrogate is evaluated through a standalone python package contained in NRSur7dq2.tar.gz, which has simple installation instructions in its README file. A tutorial can be found for evaluating this surrogate in this example IPython code .





 

 

If you find these surrogate models useful in your own research please cite the Field et al., PRX (2014) paper as well as the relevant paper describing the specific numerical relativity surrogate model, if available (e.g., the Blackman et al. 2015 paper for non-spinning binary black hole coalescences).

Caveats:





Evaluating surrogate models outside of the ranges they were trained upon may give inaccurate results. Please use with caution when extrapolating.




The surrogate data available here for non-spinning binary black holes produced in Blackman et al. 2015 contains the (2,0) mode. However, this mode was not used in the paper. While this surrogate can predict a (2,0) mode, current numerical relativity simulations may not yet be able to accumulate (non-oscillatory) Christodoulou memory sufficiently. The surrogate (2,0) mode is founded upon basis SpEC waveforms that have been hybridized with leading order post-Newtonian waveforms. Therefore, the (2,0) mode can be included in the mode’s output but should be used with caution. Currently, the default option to evaluate this surrogate (using GWSurrogate) is to exclude all m=0 modes.