teobresums 0.0.1

TEOBResumS: Effective-One-Body model for generic compact binary coalescences

TEOBResumS: Effective-one-body model for compact binary waveforms

To start, checkout the Wiki.

Code versions

Code versions are tagged on master. Code versions used in scientific papers are tagged with the arXiv number.

For detailed release notes of the most recent version see the CHANGES file.

Latest version

Quasi-circular precessing and non-precessing models for BBH, BNS and BHNS with higher modes, including EOB-SPA.

Authors

See the AUTHORS file.

License

TEOBResumS is a free software distributed under the terms of the GNU General Public License as published by the Free Software Foundation.

See the LICENSE file.

Pre-requisites

• C compiler (e.g. GCC)
• GSL library

Installation

TEOBResumS can be built as an executable or a python module using disutil.

PyPI

$ pip install teobresums

From source

$ git clone https://bitbucket.org/eob_ihes/teobresums.git
$ cd teobresums/Python/
$ python setup.py install

We strongly advise users to use anaconda.

C executable

To build the executable, check the compiler and compilation options in C/Makefile file and then:

$ git clone https://bitbucket.org/eob_ihes/teobresums.git
$ cd teobresums/C/
$ make

Usage

Run the executable:

$ cd /PATH/TO/teobresums/C/
$ ./TEOBResumS.x -p <parfile>

Example parfiles can be found in the directory C/par/.

Example scripts for using the python module can be instead found in Python/Examples/.

If you have a PyCBC installation, a plugin for TEOBResumS python module is available in PyCBC/ and should be automatically detected by PyCBC; see PyCBC/test.py.

References

Main references:

• Riemenschneider et al (2021) Assessment of consistent next-to-quasicircular corrections and postadiabatic approximation in effective-one-body multipolar waveforms for binary black hole coalescences
• Nagar et al (2020) Multipolar effective one body waveform model for spin-aligned black hole binaries
• Nagar et al (2019) Multipolar effective one body model for nonspinning black hole binaries
• Nagar et al (2018) Time-domain effective-one-body gravitational waveforms for coalescing compact binaries with nonprecessing spins, tides and self-spin effects
• Nagar et al (2015) Energetics and phasing of nonprecessing spinning coalescing black hole binaries
• Damour et al (2014) New effective-one-body description of coalescing nonprecessing spinning black-hole binaries

please cite the above references when using the code. Please, see also the complete list of references on the Wiki and cite papers according to what you use.

Developers

Please contact Sebastiano Bernuzzi and Alessandro Nagar if you wish to be included in the list of developers.

A short description of the code can be found in here. Please, take a moment to understand the data structures and how the parameters are managed.

See here for a description of the workflow of this repo.

If you want to start a new branch or development make sure to

• Talk to us
• Run the benchmark before applying any change
• Run the benchmark after you applied your changes and before pushing them; compare and make sure you did not break anything.

Contact

You can get in contact with TEOBResumS developers and fellow users through our mailing list. To subscribe please click on the badge below.