From 978ac9416e0379daa527e02134a9c62fbded05da Mon Sep 17 00:00:00 2001 From: Sam Reeve <6740307+streeve@users.noreply.github.com> Date: Wed, 4 Sep 2024 14:12:10 -0400 Subject: [PATCH] Add citation details --- CITATION.bib | 12 ++++++++++++ README.md | 6 ++++++ 2 files changed, 18 insertions(+) create mode 100644 CITATION.bib diff --git a/CITATION.bib b/CITATION.bib new file mode 100644 index 0000000..44f732b --- /dev/null +++ b/CITATION.bib @@ -0,0 +1,12 @@ +@article{Kwon2024, + doi = {10.21105/joss.06875}, + url = {https://doi.org/10.21105/joss.06875}, + year = {2024}, + publisher = {The Open Journal}, + volume = {9}, + number = {100}, + pages = {6875}, + author = {Sun Yong Kwon and Eric Thibodeau and Alex Plotkowski and Ying Yang}, + title = {Equilipy: a python package for calculating phase equilibria}, + journal = {Journal of Open Source Software} +} \ No newline at end of file diff --git a/README.md b/README.md index f58f813..c33dde8 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,12 @@ The following features are currently available. For details, check out the example directory and [Features and Examples](https://ornl.github.io/Equilipy/features.html) +## Citing Equilipy + +If you use Equilipy in your work, please cite the following [paper](CITATION.bib). +In addition, cite the current release or version used from +[Zenodo](https://zenodo.org/doi/10.5281/zenodo.13157231). + ## Contributing We encourage you to contribute to Equilipy. Please see [contributing guidelines](CONTRIBUTING.md).