Update citation to journal reference and add corresponding `CITATION.…

…CFF` file to directly export citation from GitHub repo.
flexi-framework · Oct 10, 2024 · 19604f0 · 19604f0
1 parent c304102
commit 19604f0
Show file tree

Hide file tree

Showing 2 changed files with 128 additions and 8 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,116 @@
+cff-version: 1.2.0
+message: "If you find GALÆXI helpful, please cite as follows:"
+
+title: GALÆXI
+authors:
+  - family-names: Altmann
+    given-names: Christoph
+  - family-names: Atak
+    given-names: Muhammed
+  - family-names: Appel
+    given-names: Daniel
+  - family-names: Beck
+    given-names: Andrea
+  - family-names: Blind
+    given-names: Marcel
+  - family-names: Bolemann
+    given-names: Thomas
+  - family-names: Copplestone
+    given-names: Stephen
+  - family-names: Dürrwächter
+    given-names: Jakob
+  - family-names: Fechter
+    given-names: Stefan
+  - family-names: Flad
+    given-names: David
+  - family-names: Föll
+    given-names: Fabian
+  - family-names: Frank
+    given-names: Hannes
+  - family-names: Gao
+    given-names: Min
+  - family-names: Gassner
+    given-names: Gregor
+  - family-names: Hindenlang
+    given-names: Florian
+  - family-names: Hitz
+    given-names: Timon
+  - family-names: Hoffmann
+    given-names: Malte
+  - family-names: Jöns
+    given-names: Steven
+  - family-names: Jens
+    given-names: Keim
+  - family-names: Keller
+    given-names: Serena
+  - family-names: Kempf
+    given-names: Daniel
+  - family-names: Kopper
+    given-names: Patrick
+  - family-names: Krais
+    given-names: Nico
+  - family-names: Kuhn
+    given-names: Thomas
+  - family-names: Kurz
+    given-names: Marius
+  - family-names: Mossier
+    given-names: Pascal
+  - family-names: Müller
+    given-names: Christoph
+  - family-names: Munz
+    given-names: Claus-Dieter
+  - family-names: Neudorfer
+    given-names: Jonathan
+  - family-names: Núñez-de la Rosa
+    given-names: Jonatan
+  - family-names: Ortwein
+    given-names: Philip
+  - family-names: Schwarz
+    given-names: Anna
+  - family-names: Sonntag
+    given-names: Matthias
+  - family-names: Starr
+    given-names: Spencer
+  - family-names: Staudenmaier
+    given-names: Marc
+  - family-names: Zeifang
+    given-names: Jonas
+
+abstract: A high order discontinuous Galerkin framework for compressible flows on GPU systems 
+keywords:
+  - Discontinuous Galerkin
+  - High-Performance Computing
+  - Computational Fluid Dynamics
+license: GPL-3.0
+repository: https://github.com/flexi-framework/galaexi
+
+preferred-citation:
+  type: article
+  title: "GALÆXI: Solving complex compressible flows with high-order discontinuous Galerkin methods on accelerator-based systems"
+  authors:
+    - family-names: Kurz
+      given-names: Marius
+    - family-names: Kempf
+      given-names: Daniel
+    - family-names: Blind
+      given-names: Marcel P.
+    - family-names: Kopper
+      given-names: Patrick
+    - family-names: Offenhäuser
+      given-names: Philipp
+    - family-names: Schwarz
+      given-names: Anna
+    - family-names: Starr
+      given-names: Spencer
+    - family-names: Keim
+      given-names: Jens
+    - family-names: Beck
+      given-names: Andrea
+  year: 2025
+  month: 01
+  journal: Computer Physics Communications
+  volume: 306
+  pages: 109388
+  doi: 10.1016/j.cpc.2024.109388
+  url: https://www.sciencedirect.com/science/article/pii/S0010465524003114
+  notes: "Code available at: https://github.com/flexi-framework/galaexi"
diff --git a/README.md b/README.md
@@ -35,18 +35,22 @@ GALÆXI is a scientific project. If you use GALÆXI for publications or
 presentations in science, please support the project by citing it.
 As general reference, please cite
 ```
-Kurz, M., Kempf, D., Blind, M., Kopper, P., Offenhäuser, P., Schwarz, A., Starr, S., Keim, J., Beck, A.,
+Kurz, M., Kempf, D., Blind, M. P., Kopper, P., Offenhäuser, P., Schwarz, A., Starr, S., Keim, J., Beck, A. (2025).
 GALÆXI: Solving complex compressible flows with high-order discontinuous Galerkin methods on accelerator-based systems,
-ArXiv preprint, https://doi.org/10.48550/arXiv.2404.12703.
+Computer Physics Communications, 306, 109388.
 ```
 or use the following Bibtex files
 
-    @misc{galaexi,
-      title  = {GAL{\AE}XI: Solving complex compressible flows with high-order discontinuous Galerkin methods on accelerator-based systems}, 
-      author = {Daniel Kempf and Marius Kurz and Marcel Blind and Patrick Kopper and Philipp Offenhäuser and Anna Schwarz and Spencer Starr and Jens Keim and Andrea Beck},
-      year   = {2024},
-      doi    = {https://doi.org/10.48550/arXiv.2404.12703},
-      note   = {Code available at \url{https://github.com/flexi-framework/galaexi}.}
+    @article{galaexi,
+      title   = {GAL{\AE}XI: Solving complex compressible flows with high-order discontinuous Galerkin methods on accelerator-based systems},
+      journal = {Computer Physics Communications},
+      volume  = {306},
+      pages   = {109388},
+      year    = {2025},
+      author  = {Marius Kurz and Daniel Kempf and Marcel P. Blind and Patrick Kopper and Philipp Offenhäuser and Anna Schwarz and Spencer Starr and Jens Keim and Andrea Beck},
+      url     = {https://www.sciencedirect.com/science/article/pii/S0010465524003114},
+      doi     = {https://doi.org/10.1016/j.cpc.2024.109388},
+      note    = {Code available at \url{https://github.com/flexi-framework/galaexi}.}
     }
 
 To refer to specific applications and features, you can also cite the appropriate paper from this [list][publications].