Update citation (#1967)

* add info on how to cite ERF * update citation
erf-model · Nov 20, 2024 · d143fca · d143fca
1 parent f99dd86
commit d143fca
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/Docs/sphinx_doc/HowToCite.rst b/Docs/sphinx_doc/HowToCite.rst
@@ -12,7 +12,7 @@ Almgren et al., (2023). ERF: Energy Research and Forecasting. Journal of Open So
 
 The bibtex version would be
 
-@article{Almgren2023,
+@article{ERF_JOSS,
     title   = {ERF: Energy Research and Forecasting},
     journal = {Journal of Open Source Software}
     author  = {Ann Almgren and Aaron Lattanzi and Riyaz Haque and Pankaj Jha and Branko Kosovic and Jeffrey Mirocha and Bruce Perry and Eliot Quon and Michael Sanders and David Wiersema and Donald Willcox and Xingqiu Yuan and Weiqun Zhang},

diff --git a/README.rst b/README.rst
@@ -72,3 +72,23 @@ distribute copies to the public, prepare derivative works, and perform
 publicly and display publicly, and to permit other to do so.
 
 The license for ERF can be found in the LICENSE.md file.
+
+Citation
+~~~~~~~~~
+
+To cite ERF, please use [![Citing](http://joss.theoj.org/papers/10.21105/joss.05202/status.svg)](https://doi.org/10.21105/joss.05202)
+
+```
+@article{ERF_JOSS,
+    title   = {ERF: Energy Research and Forecasting},
+    journal = {Journal of Open Source Software}
+    author  = {Ann Almgren and Aaron Lattanzi and Riyaz Haque and Pankaj Jha and Branko Kosovic and Jeffrey Mirocha and Bruce Perry and Eliot Quon and Michael Sanders and David Wiersema and Donald Willcox and Xingqiu Yuan and Weiqun Zhang},
+    doi     = {10.21105/joss.05202},
+    url     = {https://doi.org/10.21105/joss.05202},
+    year    = {2023},
+    publisher = {The Open Journal of Open Source Software},
+    volume  = {8},
+    number  = {87},
+    pages   = {5202},
+}
+```