Clone wiki

TEOBResumS / Home

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

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

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.

Code versions

Quasi-circular precessing and non-precessing models for BBH, BNS and BHNS with higher modes, including EOB-SPA.
Quasi-circular precessing and non-precessing models for BBH and BNS with higher modes, including EOB-SPA.
Quasi-circular non-precessing models for BBH and BNS with higher modes.
Quasi-circular non-precessing models for BBH and BNS, including post-adiabatic method and higher modes for BNS. This version was ported in LAL and the LAL implementation is reviewed by LVC.
Quasi-circular non-precessing models for BBH and BNS, including post-adiabatic method and higher modes for BNS.
C++ implementation abandoned in June 2018 and code development is frozen.
Initial C++ implementation, reviewed by LVC. Review was concluded on 11.04.2018. The review's final statement can be found here. The reviewed version is tagged as LVC-review-end.

Pre-requisites

C compiler
GSL library

Compilation

TEOBResumS can be built as an executable or a python module using disutil. We recommend to use the latest version on master branch.

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

$ cd /PATH/TO/teobresums/C/
$ make

Alternatively, to build the python module under the teobresums/Python directory do:

$ cd /PATH/TO/teobresums/Python/
$ python setup.py build_ext --inplace

To build the module in your current environment do:

$ cd /PATH/TO/teobresums/Python/
$ python setup.py install

We strongly advise users to use anaconda.

Usage

The executable works with an input parfile

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

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.

In v1 the default parameters are set from from an external parfile par/default.par, hence you need to set the environment variable TEOBRESUMS before calling the executable.

TEOBResumS conventions, parameters and output

The list of conventions, options supported by TEOBResumS and the output description for both the C and Python versions is available here.

For developers: on the same page, detailed guidelines on how to add new parameters to the code are present. Developers are encouraged to follow them.

C Examples

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

Python Examples

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

Developers

If you wish to to contribute or to be included in the list of developers, please contact Sebastiano Bernuzzi and Alessandro Nagar.

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

The repo is managed following a simple git workflow (see e.g. here): master must always be deployable, all changes are made through feature branches. See the repo usage page for a short description.

Wikipages for developers:

Reports

References

Key references are collected here. Please, take a moment to look at the list and cite the references relative to the parts of the code you use (tides, precession, etc).

Contact

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

Updated 2023-11-16