Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

precession



WARNING: We are currently developing a new, awesome version of precession. You can check out our progess on the master and dev branches. precession_v1, as described in arXiv:1605.01067 is still fully functional, and we reccommend you to use it for now. You can install it via pip (pip install precession, see below). The source code is available in a dedicated branch of this repository called precession_v1. The documentation can be browsed at this link. Sorry for the inconvenience, we hope v2 will be out soon! Stay tuned.



DYNAMICS OF SPINNING BLACK-HOLE BINARIES WITH PYTHON

precession is an open-source Python module to study the dynamics of precessing black-hole binaries in the post-Newtonian regime. The code provides a comprehensive toolbox to (i) study the evolution of the black-hole spins along their precession cycles, (ii) perform gravitational-wave driven binary inspirals using both orbit-averaged and precession-averaged integrations, and (iii) predict the properties of the merger remnant through fitting formulae obtained from numerical relativity simulations. precession is a ready-to-use tool to add the black-hole spin dynamics to larger-scale numerical studies such as gravitational-wave parameter estimation codes, population synthesis models to predict gravitational-wave event rates, galaxy merger trees and cosmological simulations of structure formation. precession provides fast and reliable integration methods to propagate statistical samples of black-hole binaries from/to large separations where they form to/from small separations where they become detectable, thus linking gravitational-wave observations of spinning black-hole binaries to their astrophysical formation history. The code is also a useful tool to compute initial parameters for numerical relativity simulations targeting specific precessing systems.

This code is released to the community under the Creative Commons Attribution International license. Essentially, you may use precession as you like but must make reference to our work. When using precession in any published work, please cite the paper describing its implementation:

  • PRECESSION: Dynamics of spinning black-hole binaries with python. D. Gerosa, M. Kesden. PRD 93 (2016) 124066. arXiv:1605.01067

precession is an open-source code distributed under git version-control system on

API documentation can be generated automatically in html format from the code docstrings using pdoc, and is uplodad to a dedicated branch of the git repository

Further information and scientific results are available at:

INSTALLATION

precession works in python 2.x and has been tested on 2.7.10. It can be installed through pip:

pip install precession

Prerequisites are numpy, scipy and parmap, which can be all installed through pip. Information on all code functions are available through Pyhton's built-in help system

import precession
help(precession.function)

Several tests and tutorial are available in the submodule precession.test. A detailed description of the functionalies of the code is provided in the scientific paper arXiv:1605.01067, where examples are also presented.

RESULTS

precession has been used in the following published papers:

RELEASES

DOI

v1.0.0 Stable version released together with the first arxiv submission of arXiv:1605.01067.

v1.0.2 Clarifications on typos in Eq. (36) and (37) of arXiv:1605.01067. See help(precession) for more information.

v1.0.3 Python 3 now supported (hurray!). By default, finalspin now returns more updated result by Hofmann, Barausse and Rezzolla 2016.

CREDITS

The code is developed and maintained by Davide Gerosa. Please, report bugs to

dgerosa@caltech.edu

I am happy to help you out!

Thanks: M. Kesden, U. Sperhake, E. Berti, R. O'Shaughnessy, A. Sesana, D. Trifiro', A. Klein, J. Vosmera and X. Zhao.

About

Dynamics of spinning black-hole binaries with python

Resources

License

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages