v0.2.9 add citation to SmoQyDQMC.jl paper

SmoQySuite · Nov 17, 2023 · 40ce184 · 40ce184 · cohensbw · Nov 17, 2023
1 parent e3d6184
commit 40ce184
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 1 deletion.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "SmoQyDQMC"
 uuid = "00e12d65-277b-447e-9c1d-a17422dd36f5"
 authors = ["Benjamin Cohen-Stead <[email protected]>"]
-version = "0.2.8"
+version = "0.2.9"
 
 [deps]
 BinningAnalysis = "b7192094-8e58-5052-a244-180a858778ee"

diff --git a/README.md b/README.md
@@ -60,6 +60,22 @@ the [Reexport.jl](https://github.com/simonster/Reexport.jl.git) package in order
 - [JLD2.jl](https://github.com/JuliaIO/JLD2.jl.git): Package used to write data to binary files in an HDF5 compatible format. It is also recommended this package be used at the scripting level to implement checkpointing in a simulation.
 - [BinningAnalysis.jl](https://github.com/carstenbauer/BinningAnalysis.jl.git): Export method impelementing the jackknife algorithm for calculating error bars.
 
+## Citation
+
+If you found this library to be useful in the course of academic work, please consider citing us:
+
+```bibtex
+@misc{SmoQyDQMC,
+      title={SmoQyDQMC.jl: A flexible implementation of determinant quantum Monte Carlo for Hubbard and electron-phonon interactions}, 
+      author={Benjamin Cohen-Stead and Sohan Malkaruge Costa and James Neuhaus and Andy Tanjaroon Ly and Yutan Zhang and Richard Scalettar and Kipton Barros and Steven Johnston},
+      year={2023},
+      eprint={2311.09395},
+      archivePrefix={arXiv},
+      primaryClass={cond-mat.str-el},
+      url={https://arxiv.org/abs/2311.09395}
+}
+```
+
 ## Contact Us
 
 For question and comments regarding this package, please email either Dr. Benjamin Cohen-Stead at [[email protected]](mailto:[email protected]) or Professor Steven Johnston at [[email protected]](mailto:[email protected]).
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -59,6 +59,22 @@ the [`Reexport.jl`](https://github.com/simonster/Reexport.jl.git) package in ord
 - [`JLD2.jl`](https://github.com/JuliaIO/JLD2.jl.git): Package used to write data to binary files in an HDF5 compatible format. It is also recommended this package be used at the scripting level to implement checkpointing in a simulation.
 - [`BinningAnalysis.jl`](https://github.com/carstenbauer/BinningAnalysis.jl.git): Export method impelementing the jackknife algorithm for calculating error bars.
 
+## Citation
+
+If you found this library to be useful in the course of academic work, please consider citing us:
+
+```bibtex
+@misc{SmoQyDQMC,
+      title={SmoQyDQMC.jl: A flexible implementation of determinant quantum Monte Carlo for Hubbard and electron-phonon interactions}, 
+      author={Benjamin Cohen-Stead and Sohan Malkaruge Costa and James Neuhaus and Andy Tanjaroon Ly and Yutan Zhang and Richard Scalettar and Kipton Barros and Steven Johnston},
+      year={2023},
+      eprint={2311.09395},
+      archivePrefix={arXiv},
+      primaryClass={cond-mat.str-el},
+      url={https://arxiv.org/abs/2311.09395}
+}
+```
+
 ## Contact Us
 
 For question and comments regarding this package, please email either Dr. Benjamin Cohen-Stead at [[email protected]](mailto:[email protected]) or Professor Steven Johnston at [[email protected]](mailto:[email protected]).