Dear Einstein Toolkit team, My name is Vinicius Ramos Rodrigues, and I am currently developing a research module (thorn) intended for use with the Einstein Toolkit in the context of numerical relativity research. The module is being designed as a processual stress-energy sector compatible with the Toolkit infrastructure, including coupling through TmunuBase and evolution with MoL/BSSN-based setups. My goal is to make this implementation available for research use and to ensure that it follows the most appropriate technical and community standards for the Einstein Toolkit ecosystem. I would like to ask for your guidance on the best path for doing this. In particular, I would appreciate advice on: whether there is a recommended procedure for sharing a new research thorn with the community, whether there are preferred coding, documentation, or testing requirements before such a thorn is made available, and whether contribution through a public repository or another review process would be the most suitable route. If useful, I can also provide a short technical summary of the module, its equations, intended use case, and current implementation status. Thank you very much for your time and for maintaining such an important resource for the numerical relativity community. Best regards, Vinicius Ramos Rodrigues
Hello Vinicius,
For a formal contribution to the Einstein Tookit there is:
https://einsteintoolkit.org/contribute.html
in the "How to Contribute New Software Components" section.
If you would like to advertise your thorn without including in the official Einstein Toolkit release then you can send email to this list, we also try and track public modules that are not (yet) part of the Einstein Toolkit distribution in
https://docs.einsteintoolkit.org/et-docs/Thorns_we_know_of
There's no specific coding style guide. We do include a clang-format style file in
https://bitbucket.org/cactuscode/cactus/src/master/.clang-format
which can be used with clang-format (https://clang.llvm.org/docs/ClangFormat.html) to format code.
There is also a (separate and different) code style document that was included in Cactus in the maintainers's guide:
https://bitbucket.org/cactuscode/cactus/src/master/doc/MaintGuide.pdf
Yours, Roland
[CAUTION: Non-UBC Email]
Dear Einstein Toolkit team, My name is Vinicius Ramos Rodrigues, and I am currently developing a research module (thorn) intended for use with the Einstein Toolkit in the context of numerical relativity research. The module is being designed as a processual stress-energy sector compatible with the Toolkit infrastructure, including coupling through TmunuBase and evolution with MoL/BSSN-based setups. My goal is to make this implementation available for research use and to ensure that it follows the most appropriate technical and community standards for the Einstein Toolkit ecosystem. I would like to ask for your guidance on the best path for doing this. In particular, I would appreciate advice on: whether there is a recommended procedure for sharing a new research thorn with the community, whether there are preferred coding, documentation, or testing requirements before such a thorn is made available, and whether contribution through a public repository or another review process would be the most suitable route. If useful, I can also provide a short technical summary of the module, its equations, intended use case, and current implementation status. Thank you very much for your time and for maintaining such an important resource for the numerical relativity community. Best regards, Vinicius Ramos Rodrigues
users@lists.einsteintoolkit.org
-
Roland Haas -
Vinicius