Fill "Cite Us" section (#469)

* Fill "Cite Us" section * Add line break * Use "and" * Add CITATION.bib * Update README.md Co-authored-by: Michael Schlottke-Lakemper <[email protected]> --------- Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
trixi-framework · Mar 20, 2024 · fe2a6cc · fe2a6cc
1 parent 6fbb010
commit fe2a6cc
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CITATION.bib b/CITATION.bib
@@ -0,0 +1,8 @@
+@misc{trixiparticles,
+  title={{T}rixi{P}articles.jl: {P}article-based multiphysics simulations in {J}ulia},
+  author={Erik Faulhaber and Niklas Neher and Sven Berger and
+          Michael Schlottke-Lakemper and Gregor Gassner},
+  year={2024},
+  howpublished={\url{https://github.com/trixi-framework/TrixiParticles.jl}},
+  doi={10.5281/zenodo.10797541}
+}
diff --git a/README.md b/README.md
@@ -8,6 +8,7 @@
 [![codecov](https://codecov.io/github/trixi-framework/TrixiParticles.jl/branch/main/graph/badge.svg?token=RDZXYbij0b)](https://codecov.io/github/trixi-framework/TrixiParticles.jl)
 [![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
 [![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10797541.svg)](https://zenodo.org/doi/10.5281/zenodo.10797541)
 
 **TrixiParticles.jl** is a numerical simulation framework designed for particle-based numerical methods, with an emphasis on multiphysics applications, written in [Julia](https://julialang.org).
 A primary goal of the framework is to be user-friendly for engineering, science, and educational purposes. In addition to its extensible design and optimized implementation, we prioritize the user experience, including installation, pre- and postprocessing.
@@ -111,6 +112,19 @@ You can find the documentation for the latest release
 
 ## Cite Us
 
+If you use TrixiParticles.jl in your own research or write a paper using results obtained
+with the help of TrixiParticles.jl, please cite it as
+```bibtex
+@misc{trixiparticles,
+  title={{T}rixi{P}articles.jl: {P}article-based multiphysics simulations in {J}ulia},
+  author={Erik Faulhaber and Niklas Neher and Sven Berger and
+          Michael Schlottke-Lakemper and Gregor Gassner},
+  year={2024},
+  howpublished={\url{https://github.com/trixi-framework/TrixiParticles.jl}},
+  doi={10.5281/zenodo.10797541}
+}
+```
+
 ## Authors
 Erik Faulhaber (University of Cologne) and Niklas Neher (HLRS) implemented the foundations
 for TrixiParticles.jl and are principal developers along with Sven Berger (hereon).