Skip to content

Commit 5cdf9da

Browse files
committed
Update README.md
1 parent 3192fe2 commit 5cdf9da

File tree

1 file changed

+15
-24
lines changed

1 file changed

+15
-24
lines changed

README.md

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,29 @@
88
The current version (v2) of `precession` is described in
99
- *Efficient multi-timescale dynamics of precessing black-hole binaries.*
1010
D. Gerosa, G. Fumagalli, M. Mould, G. Cavallotto, D. Padilla Monroy, D. Gangardt, V. De Renzis.
11+
[PRD 108 (2023) 024042](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.108.024042)
1112
[arXiv:2304.04801](https://arxiv.org/abs/2304.04801)
1213

14+
The implementation of eccentricity is described in
15+
- *Spin-eccentricity interplay in merging binary black holes.*
16+
G. Fumagalli, D. Gerosa.
17+
[PRD 108 (2023) 124055](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.108.124055).
18+
[arXiv:2310.16893](https://arxiv.org/abs/2310.16893)
19+
1320
The previous implementation (v1) is described in
1421
- *PRECESSION: Dynamics of spinning black-hole binaries with python.*
15-
D. Gerosa, M. Kesden. PRD 93 (2016)
16-
[124066](http://journals.aps.org/prd/abstract/10.1103/PhysRevD.93.124066).
22+
D. Gerosa, M. Kesden.
23+
[PRD 93 (2016) 124066](http://journals.aps.org/prd/abstract/10.1103/PhysRevD.93.124066).
1724
[arXiv:1605.01067](https://arxiv.org/abs/1605.01067)
1825

19-
Note that v2 and v1 are *not* backward compatible; they are different codes. Unless you are maintaining a legacy pipeline, we highly reccommend using the new code. It is faster, more accurate, and provides more functionalities.
20-
21-
### precession.eccentricity
26+
Note that v2 and v1 are *not* backward compatible; they are different codes. Unless you are maintaining a legacy pipeline, we highly reccommend using the new code. It is faster, more accurate, and provides more functionalities.
2227

23-
The `precession` package models the dynamics of circular precessing black hole binaries. To evolve binaries on eccentric orbits, we provide an extension: `precession.eccentricity`. This module is designed to mirror the functionality of the main `precession` package while accounting for orbital eccentricity.
24-
25-
The eccentric extension is described in:
26-
- *Eccentric extension: Amaldi proceeding.*
27-
G. Fumagalli \& D. Gerosa
28-
[arXiv:2508.????](https://arxiv.org/abs/2304.04801)\\
29-
30-
and is based on
31-
- *Spin-eccentricity interplay in merging binary black holes*
32-
G. Fumagalli \& D. Gerosa
33-
[arXiv:2310.16893](https://arxiv.org/abs/2310.16893)
34-
35-
36-
<br />
37-
38-
39-
`precession` and `precession.eccentricity` are released under the MIT licence. You may use `precession` and `precession.eccentricity` as you like but should acknowledge our work. When using the code in any published work, please cite the papers above. The codes have been used in a variety of studies in gravitational-wave and astronomy black-hole binary dynamics, follow the citations to those papers for more.
28+
`precession` is released under the MIT licence. You may use `precession` as you like but should acknowledge our work. When using the code in any published work, please cite the papers above. The codes have been used in a variety of studies in gravitational-wave and astronomy black-hole binary dynamics, follow the citations to those papers for more.
4029

4130
The code is distributed under git version control at
4231
- [github.com/dgerosa/precession](https://github.com/dgerosa/precession)
4332

44-
The documentation (v2 and eccentric extension) is available
33+
The documentation (v2) is available
4534
- [dgerosa.github.io/precession](https://dgerosa.github.io/precession)
4635

4736
The v1 documentation is archived at [this link](https://htmlpreview.github.io/?https://github.com/dgerosa/precession/blob/precession_v1/docs/index.html).
@@ -55,8 +44,10 @@ A short tutorial is provided in [the documentation](https://dgerosa.github.io/pr
5544
The code is developed and maintained by [Davide Gerosa](www.davidegerosa.com). Please report bugs and suggestions using github.
5645

5746

47+
The main code deals with quasi-circular black-hole binaries and is accessible via `import precession`. The functionalities to study eccentric binaries are in the `eccentricity` submodule, which we reccommend importing as `import precession.eccentricity as precession`.
48+
5849
#### Change log
59-
- *v2.0.1* Extension of the code to work with eccentric orbits. See [arXiv:2508.????](https://arxiv.org/abs/2304.04801)
50+
- *v2.1.0* Extension to eccentric orbits. See [arXiv:2508.04801](https://arxiv.org/abs/2304.04801)
6051
- *v2.0.0* New code, not backward compatible. See [arXiv:2304.04801](https://arxiv.org/abs/2304.04801)
6152
- *v1.0.3* Python 3 support. Updated final-spin formula.
6253
- *v1.0.0* First public release. See [arXiv:1605.01067](https://arxiv.org/abs/1605.01067).

0 commit comments

Comments
 (0)