Citation - GRTLCollaboration/engrenage GitHub Wiki

Citation

You should not really be using Engrenage for research. However, I will probably create a JOSS paper for Engrenage in the future, so stay tuned. For now if you want to cite the code please just provide the url for the GitHub repo.

Acknowledgements

This code is based on a private spherically adapted (but not spherically symmetric) code by Thomas Baumgarte, and the NRpy code of Zac Etienne, in particular the formalism used closely follows that described in the papers Numerical relativity in spherical polar coordinates: Evolution calculations with the BSSN formulation and SENR/NRPy+: Numerical relativity in singular curvilinear coordinate systems.

This code has also benefitted from input from Nils Vu @nilsvu ("You don't use python environments? I don't even know where to start..."), Leo Stein @duetosymmetry ("Why wouldn't you use the existing numpy functions for that?") and bug spotting from Cristian Joana @cjoana and Cheng-Hsin Cheng @chcheng3 when this code debuted at the ICERM Numerical Relativity Community Summer School in August 2022. Thanks also to Marcus Hatton @MarcusHatton for the addition of animation to the figures.

The main developer of Engrenage is Katy Clough, who is supported by a UK STFC Ernest Rutherford Fellowship ST/V003240/1.