From 122066031a51e3771c678c240d15f8bb6ed442aa Mon Sep 17 00:00:00 2001 From: chihta-wang Date: Mon, 17 Jun 2024 16:53:52 +0200 Subject: [PATCH 1/5] Update README file by adding the paper for OGL --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 7efc5eb51..91426e34e 100644 --- a/README.md +++ b/README.md @@ -143,6 +143,19 @@ title = {{Ginkgo: A Modern Linear Operator Algebra Framework for High Performanc volume = {48}, year = {2022} } + +@Article{Olenik2024, +author={Olenik, Gregor and Koch, Marcel and Boutanios, Ziad and Anzt, Hartwig}, +title={Towards a platform-portable linear algebra backend for OpenFOAM}, +journal={Meccanica}, +year={2024}, +month={Jun}, +day={12}, +issn={1572-9648}, +doi={10.1007/s11012-024-01806-1}, +url={https://doi.org/10.1007/s11012-024-01806-1} +} + ``` ## Example From 4b3dbae73a9d38d2b99bfe8e2669bfd01aaba84f Mon Sep 17 00:00:00 2001 From: chihta-wang Date: Mon, 17 Jun 2024 16:54:57 +0200 Subject: [PATCH 2/5] Add a CITATION file --- CITATION.cff | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..f2495e978 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,31 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: + - family-names: "Olenik" + given-names: "Gregor" + - family-names: "Koch" + given-names: "Marcel" + - family-names: "Boutanios" + given-names: "Ziad" + - family-names: "Anzt" + given-names: "Hartwig" +title: "The OpenFOAM Ginkgo Layer (OGL)" +version: 0.5.3 +date-released: 2024-03-08 +url: "https://github.com/hpsim/OGL" +preferred-citation: + type: article + authors: + - family-names: "Olenik" + given-names: "Gregor" + - family-names: "Koch" + given-names: "Marcel" + - family-names: "Boutanios" + given-names: "Ziad" + - family-names: "Anzt" + given-names: "Hartwig" + doi: "10.1007/s11012-024-01806-1" + journal: " Meccanica" + month: 6 + title: "Towards a platform‑portable linear algebra backend for OpenFOAM" + year: 2024 \ No newline at end of file From 0874194cefb33dd083c4c71da124240d420d46ae Mon Sep 17 00:00:00 2001 From: chihta-wang Date: Mon, 17 Jun 2024 17:01:06 +0200 Subject: [PATCH 3/5] Add licensing info for the CITATION file --- .reuse/dep5 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.reuse/dep5 b/.reuse/dep5 index 3621bb2ef..78eea379a 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -31,6 +31,9 @@ Files: AUTHORS.md Copyright: 2024 OGL authors License: GPL-3.0-or-later +Files: CITATION.cff +Copyright: 2024 OGL authors +License: GPL-3.0-or-later # Sample paragraph, commented out: # # Files: src/* From a5155a8a872761fa78cc6bb6897248cb6f9a4887 Mon Sep 17 00:00:00 2001 From: chihta-wang Date: Tue, 18 Jun 2024 13:30:11 +0200 Subject: [PATCH 4/5] Move the main paper above the Ginkgo paper in the citation section --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 91426e34e..a63966765 100644 --- a/README.md +++ b/README.md @@ -132,18 +132,6 @@ When using OGL please cite the main Ginkgo paper describing Ginkgo's purpose, de available through the following reference: ``` bibtex -@article{Anzt_Ginkgo_A_Modern_2022, -author = {Anzt, Hartwig and Cojean, Terry and Flegar, Goran and Göbel, Fritz and Grützmacher, Thomas and Nayak, Pratik and Ribizel, Tobias and Tsai, Yuhsiang and Quintana-Ortí, Enrique S.}, -doi = {10.1145/3480935}, -journal = {ACM Transactions on Mathematical Software}, -month = mar, -number = {1}, -pages = {1--33}, -title = {{Ginkgo: A Modern Linear Operator Algebra Framework for High Performance Computing}}, -volume = {48}, -year = {2022} -} - @Article{Olenik2024, author={Olenik, Gregor and Koch, Marcel and Boutanios, Ziad and Anzt, Hartwig}, title={Towards a platform-portable linear algebra backend for OpenFOAM}, @@ -156,6 +144,17 @@ doi={10.1007/s11012-024-01806-1}, url={https://doi.org/10.1007/s11012-024-01806-1} } +@article{Anzt_Ginkgo_A_Modern_2022, +author = {Anzt, Hartwig and Cojean, Terry and Flegar, Goran and Göbel, Fritz and Grützmacher, Thomas and Nayak, Pratik and Ribizel, Tobias and Tsai, Yuhsiang and Quintana-Ortí, Enrique S.}, +doi = {10.1145/3480935}, +journal = {ACM Transactions on Mathematical Software}, +month = mar, +number = {1}, +pages = {1--33}, +title = {{Ginkgo: A Modern Linear Operator Algebra Framework for High Performance Computing}}, +volume = {48}, +year = {2022} +} ``` ## Example From 24385197e78f181249126a969eb666e238be936d Mon Sep 17 00:00:00 2001 From: chihta-wang Date: Tue, 18 Jun 2024 13:33:34 +0200 Subject: [PATCH 5/5] Update the field of the author name of the OGL in the citation file --- CITATION.cff | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index f2495e978..70033f7d5 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,14 +1,7 @@ cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - - family-names: "Olenik" - given-names: "Gregor" - - family-names: "Koch" - given-names: "Marcel" - - family-names: "Boutanios" - given-names: "Ziad" - - family-names: "Anzt" - given-names: "Hartwig" + - names: "The OGL authors" title: "The OpenFOAM Ginkgo Layer (OGL)" version: 0.5.3 date-released: 2024-03-08 @@ -25,7 +18,7 @@ preferred-citation: - family-names: "Anzt" given-names: "Hartwig" doi: "10.1007/s11012-024-01806-1" - journal: " Meccanica" + journal: "Meccanica" month: 6 title: "Towards a platform‑portable linear algebra backend for OpenFOAM" year: 2024 \ No newline at end of file