Updating README and CITATION file with JOSS paper (#185)

Oden-EAG · Mar 5, 2024 · fcd80dd · fcd80dd
1 parent 8665bcc
commit fcd80dd
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 18 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -1,10 +1,10 @@
 cff-version: 1.2.0
-message: "If you use hp3D, please cite it as follows."
 url: "https://github.com/Oden-EAG/hp3d"
-version: 1.0
 doi: 10.5281/zenodo.10763374
+version: 1.0
 date-released: 2024-03-02
-title: "hp3D: A Scalable MPI/OpenMP hp-Adaptive Finite Element Software Library for Complex Multiphysics Applications"
+title: "hp3D: A Scalable MPI/OpenMP hp-Adaptive Finite
+  Element Software Library for Complex Multiphysics Applications"
 authors:
 - family-names: "Henneking"
   given-names: "Stefan"
@@ -21,16 +21,33 @@ authors:
 - family-names: "Demkowicz"
   given-names: "Leszek"
   orcid: "https://orcid.org/0000-0001-7839-8037"
+message: "If you use hp3D, please cite it as follows."
 preferred-citation:
   type: article
   authors:
   - family-names: "Henneking"
     given-names: "Stefan"
     orcid: "https://orcid.org/0000-0003-2177-8519"
+  - family-names: "Petrides"
+    given-names: "Socratis"
+    orcid: "https://orcid.org/0000-0002-1284-5495"
+  - family-names: "Fuentes"
+    given-names: "Federico"
+    orcid: "https://orcid.org/0000-0002-4039-082X"
+  - family-names: "Badger"
+    given-names: "Jacob"
+    orcid: "https://orcid.org/0000-0001-6482-105X"
   - family-names: "Demkowicz"
     given-names: "Leszek"
     orcid: "https://orcid.org/0000-0001-7839-8037"
-  doi: "10.48550/arXiv.2207.12211"
-  journal: "arXiv preprint arXiv:2207.12211"
-  title: "hp3D User Manual"
-  year: 2022
+  title: "hp3D: A Scalable MPI/OpenMP hp-Adaptive Finite
+    Element Software Library for Complex Multiphysics Applications"
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  year: 2024
+  volume: 9
+  issue: 95
+  start: 5946
+  issn: 2475-9066
+  doi: 10.21105/joss.05946
diff --git a/README.md b/README.md
@@ -2,6 +2,9 @@
 A Scalable MPI/OpenMP hp-Adaptive Finite Element Software Library
 for Complex Multiphysics Applications
 
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.05946/status.svg)](https://doi.org/10.21105/joss.05946)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10763374.svg)](https://doi.org/10.5281/zenodo.10763374)
+
 ## Downloading the library
 1. Clone the repository
 - via HTTPS: `git clone https://github.com/Oden-EAG/hp3d.git`
@@ -75,44 +78,56 @@ Projects are implemented in `hp3d/trunk/problems/`. A few projects have been imp
 ## Citing hp3D
 Please add the following citation to any paper, technical report, or article that incorporated the `hp3D` library:
 ```bibtex
+@article{hp2024joss,
+         Author = {Henneking, Stefan and Petrides, Socratis and Fuentes, Federico and Badger, Jacob and Demkowicz, Leszek},
+         Title = {{$hp$3D: A Scalable MPI/OpenMP $hp$-Adaptive Finite Element Software Library for Complex Multiphysics Applications}},
+         Publisher = {The Open Journal},
+         Journal = {Journal of Open Source Software},
+         Year = {2024},
+         Volume = {9}, 
+         Number = {95}, 
+         Pages = {5946},
+         doi = {10.21105/joss.05946}}
+```
+And, optionally,
+```bibtex
 @article{hpUserManual,
          Author = {Henneking, Stefan and Demkowicz, Leszek},
          Title = {{$hp$3D User Manual}},
-         Year = {2022},
-         Journal={arXiv preprint arXiv:2207.12211}}
+         Journal={arXiv preprint arXiv:2207.12211},
+         Year = {2022}}
 ```
-And, optionally,
 ```bibtex
 @book{hpBook3,
       Author = {Henneking, Stefan and Demkowicz, Leszek and Petrides, Socratis and Fuentes, Federico and Keith, Brendan and Gatto, Paolo},
-      Publisher = {In preparation},
       Title = {{Computing with $hp$ Finite Elements. III. Parallel $hp$3D Code}},
+      Publisher = {In preparation},
       Year = {2024}}
 ```
 ```bibtex
 @book{hpBook2,
       Author = {Demkowicz, Leszek and Kurtz, Jason and Pardo, David and Paszy\'{n}ski, Maciej and Rachowicz, Waldemar and Zdunek, Adam},
-      Publisher = {Chapman \& Hall/CRC},
       Title = {{Computing with $hp$ Finite Elements. II. Frontiers: Three-Dimensional Elliptic and Maxwell Problems with Applications}},
+      Publisher = {Chapman \& Hall/CRC},
       Year = {2007}}
 ```
 ```bibtex
 @book{hpBook1,
       Author = {Demkowicz, Leszek},
-      Publisher = {Chapman \& Hall/CRC Press, Taylor and Francis},
       Title = {{Computing with $hp$ Finite Elements. I. One- and Two-Dimensional Elliptic and Maxwell Problems}},
+      Publisher = {Chapman \& Hall/CRC Press, Taylor and Francis},
       Year = {2006}}
 ```
 ```bibtex
 @article{shape2015,
          Author = {Fuentes, Federico and Keith, Brendan and Demkowicz, Leszek and Nagaraj, Sriram},
-         Journal = {Computers \& Mathematics with Applications},
-         Number = {4},
-         Pages = {353--458},
-         Publisher = {Elsevier},
          Title = {Orientation embedded high order shape functions for the exact sequence elements of all shapes},
+         Publisher = {Elsevier},
+         Journal = {Computers \& Mathematics with Applications},
+         Year = {2015},
          Volume = {70},
-         Year = {2015}}
+         Number = {4},
+         Pages = {353--458}}
 ```
 
 ## User Guide