Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation + citation bot to reflect accepted TRACE paper #801

Merged
merged 1 commit into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/integrators.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ The `reb_integrator_mercurius` structure contains the configuration and data str

TRACE is a hybrid time-reversible integrator, based on the algorithm described in [Hernandez & Dehnen 2023](https://ui.adsabs.harvard.edu/abs/2023MNRAS.522.4639H/abstract).
It uses WHFast for long term integrations but switches time-reversibly to BS or IAS15 for all close encounters. TRACE is appropriate for systems with a dominant central mass that will occasionally have close encounters.
The TRACE implementation is described in [Lu, Hernandez & Rein](https://ui.adsabs.harvard.edu/abs/2024arXiv240503800L/abstract).
The TRACE implementation is described in [Lu, Hernandez & Rein](https://ui.adsabs.harvard.edu/abs/2024MNRAS.533.3708L/abstract).


The following code enables TRACE and sets the critical radius to 4 Hill radii
Expand Down
20 changes: 16 additions & 4 deletions rebound/citations.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,22 @@ def cite(sim):
if sim.integrator == "trace":
txt += """The simulations were integrated using the hybrid time-reversible TRACE integrator \\citep{reboundtrace}. """
bib += """@ARTICLE{reboundtrace,
author = {{Lu}, Tiger and {Hernandez}, David M. and {Rein}, Hanno},
title = "{TRACE: a Time Reversible Algorithm for Close Encounters}",
journal = {\\mnras},
pubstate = {in prep}
author = {{Lu}, Tiger and {Hernandez}, David M. and {Rein}, Hanno},
title = "{TRACE: a code for time-reversible astrophysical close encounters}",
journal = {\mnras},
keywords = {Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics, Physics - Computational Physics},
year = 2024,
month = sep,
volume = {533},
number = {3},
pages = {3708-3723},
doi = {10.1093/mnras/stae1982},
archivePrefix = {arXiv},
eprint = {2405.03800},
primaryClass = {astro-ph.EP},
adsurl = {https://ui.adsabs.harvard.edu/abs/2024MNRAS.533.3708L},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
}
"""

Expand Down
Loading