Skip to content

Commit

Permalink
add model citations and acks
Browse files Browse the repository at this point in the history
sfield17 committed Apr 3, 2024

Verified

This commit was signed with the committer’s verified signature.
agostbiro Agost Biro
1 parent c3ffa53 commit 4898e97
Showing 2 changed files with 158 additions and 4 deletions.
154 changes: 154 additions & 0 deletions tutorial/paper/paper.bib
Original file line number Diff line number Diff line change
@@ -7,4 +7,158 @@ @article{LISAConsortiumWaveformWorkingGroup:2023arg
primaryClass = "gr-qc",
month = "11",
year = "2023"
}

@article{Field:2013cfa,
author = "Field, Scott E. and Galley, Chad R. and Hesthaven, Jan S. and Kaye, Jason and Tiglio, Manuel",
title = "{Fast prediction and evaluation of gravitational waveforms using surrogate models}",
eprint = "1308.3565",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevX.4.031006",
journal = "Phys. Rev. X",
volume = "4",
number = "3",
pages = "031006",
year = "2014"
}

@article{Blackman:2015pia,
author = "Blackman, Jonathan and Field, Scott E. and Galley, Chad R. and Szil\'agyi, B\'ela and Scheel, Mark A. and Tiglio, Manuel and Hemberger, Daniel A.",
title = "{Fast and Accurate Prediction of Numerical Relativity Waveforms from Binary Black Hole Coalescences Using Surrogate Models}",
eprint = "1502.07758",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevLett.115.121102",
journal = "Phys. Rev. Lett.",
volume = "115",
number = "12",
pages = "121102",
year = "2015"
}

@article{OShaughnessy:2017tak,
author = "O'Shaughnessy, Richard and Blackman, Jonathan and Field, Scott E.",
title = "{An architecture for efficient gravitational wave parameter estimation with multimodal linear surrogate models}",
eprint = "1701.01137",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
reportNumber = "LIGO-P1600309",
doi = "10.1088/1361-6382/aa7649",
journal = "Class. Quant. Grav.",
volume = "34",
number = "14",
pages = "144002",
year = "2017"
}

@article{Blackman:2017dfb,
author = "Blackman, Jonathan and Field, Scott E. and Scheel, Mark A. and Galley, Chad R. and Hemberger, Daniel A. and Schmidt, Patricia and Smith, Rory",
title = "{A Surrogate Model of Gravitational Waveforms from Numerical Relativity Simulations of Precessing Binary Black Hole Mergers}",
eprint = "1701.00550",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevD.95.104023",
journal = "Phys. Rev. D",
volume = "95",
number = "10",
pages = "104023",
year = "2017"
}

@article{Varma:2018mmi,
author = "Varma, Vijay and Field, Scott E. and Scheel, Mark A. and Blackman, Jonathan and Kidder, Lawrence E. and Pfeiffer, Harald P.",
title = "{Surrogate model of hybridized numerical relativity binary black hole waveforms}",
eprint = "1812.07865",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevD.99.064045",
journal = "Phys. Rev. D",
volume = "99",
number = "6",
pages = "064045",
year = "2019"
}

@article{Yoo:2023spi,
author = "Yoo, Jooheon and others",
title = "{Numerical relativity surrogate model with memory effects and post-Newtonian hybridization}",
eprint = "2306.03148",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevD.108.064027",
journal = "Phys. Rev. D",
volume = "108",
number = "6",
pages = "064027",
year = "2023"
}

@article{Yoo:2022erv,
author = "Yoo, Jooheon and Varma, Vijay and Giesler, Matthew and Scheel, Mark A. and Haster, Carl-Johan and Pfeiffer, Harald P. and Kidder, Lawrence E. and Boyle, Michael",
title = "{Targeted large mass ratio numerical relativity surrogate waveform model for GW190814}",
eprint = "2203.10109",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevD.106.044001",
journal = "Phys. Rev. D",
volume = "106",
number = "4",
pages = "044001",
year = "2022"
}

@article{Varma:2019csw,
author = "Varma, Vijay and Field, Scott E. and Scheel, Mark A. and Blackman, Jonathan and Gerosa, Davide and Stein, Leo C. and Kidder, Lawrence E. and Pfeiffer, Harald P.",
title = "{Surrogate models for precessing binary black hole simulations with unequal masses}",
eprint = "1905.09300",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevResearch.1.033015",
journal = "Phys. Rev. Research.",
volume = "1",
pages = "033015",
year = "2019"
}

@article{Barkett:2019tus,
author = "Barkett, Kevin and Chen, Yanbei and Scheel, Mark A. and Varma, Vijay",
title = "{Gravitational waveforms of binary neutron star inspirals using post-Newtonian tidal splicing}",
eprint = "1911.10440",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevD.102.024031",
journal = "Phys. Rev. D",
volume = "102",
number = "2",
pages = "024031",
year = "2020"
}

@article{Rifat:2019ltp,
author = "Rifat, Nur E. M. and Field, Scott E. and Khanna, Gaurav and Varma, Vijay",
title = "{Surrogate model for gravitational wave signals from comparable and large-mass-ratio black hole binaries}",
eprint = "1910.10473",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevD.101.081502",
journal = "Phys. Rev. D",
volume = "101",
number = "8",
pages = "081502",
year = "2020"
}

@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"
}
8 changes: 4 additions & 4 deletions tutorial/paper/paper.md
Original file line number Diff line number Diff line change
@@ -56,8 +56,7 @@ The development of ``GWSurrogate`` is hosted on [GitHub](https://github.com/sxs-

# Statement of need

``GWSurrogate`` is a Python package that provides an easy to use interface to gravitational wave surrogate models built
using the methods described in (ADD CITATIONS HERE). More specifically, ``GWSurrogate`` gravitational wave models provide evaluation of
``GWSurrogate`` is a Python package that provides an easy to use interface to gravitational wave surrogate models. More specifically, ``GWSurrogate`` gravitational wave models provide evaluation of
$$
h_{\tt S}(t, \theta, \phi;\Lambda) = \sum^{\infty}_{\ell=2} \sum_{m=-\ell}^{\ell} h_{\tt S}^{\ell m}(t;\Lambda) ~^{-2}Y_{\ell m}(\theta, \phi) \,,
$$
@@ -67,11 +66,12 @@ where $^{-2}Y_{\ell m}$ are the spin$=-2$ weighted spherical harmonics and $\Lam
- models implemented in ``GWSurrogate`` follow the waveform convention choices of the LIGO-Virgo-Kagra collaboration, thus ensuring that downstream data analysis codes can use ``GWSurrogate`` models without needing to worry about different conventions, and
- ``GWSurrogate`` models can be directly evaluated in either physical units (often used in data analysis studies) and dimensionless units (often used in theoretical studies) where all dimensioned quantities are expressed in terms of the system's total mass.

Certain models allow for additional functionality such as returning the dynamics of the binary black hole; these special features are described further in model-specific [example notebooks](https://github.com/sxs-collaboration/gwsurrogate/tree/master/tutorial).
Currently, there are 15 supported surrogate models [@Blackman:2015pia,@OShaughnessy:2017tak,@Blackman:2017dfb,@Varma:2018mmi,@Yoo:2023spi,@Yoo:2022erv,@Varma:2019csw,@Barkett:2019tus,@Rifat:2019ltp,@Islam:2022laz,@Field:2013cfa]. These models vary in their duration, included physical effects (e.g. nonlinear memory, tidal forces, harmonic modes retained, eccentricity, mass ratio extent, precession effects, etc), and underlying solution method (e.g. Effective One Body, numerical relativity, and black hole perturbation theory). Details about all models can be found by doing `gws.catalog.list(verbose=True)`, while the ``GWSurrogate`` [homepage](https://github.com/sxs-collaboration/gwsurrogate) summarizes the state-of-the-art models for each particular problem. Certain models allow for additional functionality such as returning the dynamics of the binary black hole; these special features are described further in model-specific [example notebooks](https://github.com/sxs-collaboration/gwsurrogate/tree/master/tutorial).


# Acknowledgements

We acknowledge...
We acknowledge our many close collaborators for their contribution to the development of surrogate models. We further acknowledge the community of ``GWSurrogate`` users who have contributed pull requests and opened issues, including Mike Boyle, Collin Capano, Raffi Enficiaud, Oliver Jennrich, Duncan Macleod, Alex Nitz, Seth Olsen, Swati Singh, and Avi Vajpeyi. This software has been developed over the past 10 years with continued support from the National Science Foundation, most recently through NSF grants PHY-2110496 and DMS-2309609.


# References

0 comments on commit 4898e97

Please sign in to comment.