Add citation (#719)

* add citation file * update license year * add bibtex for citation * Update README.md Co-authored-by: Daisuke Oyama <[email protected]> --------- Co-authored-by: Daisuke Oyama <[email protected]>
QuantEcon · Jan 15, 2024 · 7fffa18 · 7fffa18
1 parent d1e4d22
commit 7fffa18
Show file tree

Hide file tree

Showing 3 changed files with 102 additions and 1 deletion.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,82 @@
+cff-version: "1.2.0"
+authors:
+- family-names: Batista
+  given-names: Quentin
+- family-names: Coleman
+  given-names: Chase
+- family-names: Furusawa
+  given-names: Yuya
+- family-names: Hu
+  given-names: Shu
+- family-names: Lunagariya
+  given-names: Smit
+- family-names: Lyon
+  given-names: Spencer
+- family-names: McKay
+  given-names: Matthew
+- family-names: Oyama
+  given-names: Daisuke
+- family-names: Sargent
+  given-names: Thomas J.
+- family-names: Shi
+  given-names: Zejin
+- family-names: Stachurski
+  given-names: John
+- family-names: Winant
+  given-names: Pablo
+- family-names: Watkins
+  given-names: Natasha
+- family-names: Yang
+  given-names: Ziyue
+- family-names: Zhang
+  given-names: Hengcheng
+doi: 10.5281/zenodo.10345102
+message: If you use this software, please cite our article in the
+  Journal of Open Source Software.
+preferred-citation:
+  authors:
+  - family-names: Batista
+    given-names: Quentin
+  - family-names: Coleman
+    given-names: Chase
+  - family-names: Furusawa
+    given-names: Yuya
+  - family-names: Hu
+    given-names: Shu
+  - family-names: Lunagariya
+    given-names: Smit
+  - family-names: Lyon
+    given-names: Spencer
+  - family-names: McKay
+    given-names: Matthew
+  - family-names: Oyama
+    given-names: Daisuke
+  - family-names: Sargent
+    given-names: Thomas J.
+  - family-names: Shi
+    given-names: Zejin
+  - family-names: Stachurski
+    given-names: John
+  - family-names: Winant
+    given-names: Pablo
+  - family-names: Watkins
+    given-names: Natasha
+  - family-names: Yang
+    given-names: Ziyue
+  - family-names: Zhang
+    given-names: Hengcheng
+  date-published: 2024-01-06
+  doi: 10.21105/joss.05585
+  issn: 2475-9066
+  issue: 93
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  start: 5585
+  title: "QuantEcon.py: A community based Python library for
+    quantitative economics"
+  type: article
+  url: "https://joss.theoj.org/papers/10.21105/joss.05585"
+  volume: 9
+title: "QuantEcon.py: A community based Python library for quantitative
+  economics"
diff --git a/LICENSE b/LICENSE
@@ -1,5 +1,5 @@
 
-Copyright © 2013-2023 Thomas J. Sargent and John Stachurski: MIT
+Copyright © 2013-2024 Thomas J. Sargent and John Stachurski: MIT
 All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

diff --git a/README.md b/README.md
@@ -59,3 +59,22 @@ Once you have downloaded the source files then the package can be installed by r
     flit install
 
 (To learn the basics about setting up Git see [this link](https://help.github.com/articles/set-up-git/).)
+
+## Citation
+
+QuantEcon.py is MIT licensed, so you are free to use it without any charge and restriction. If it is convenient for you, please cite QuantEcon.py when using it in your work and also consider contributing all your changes back, so that we can incorporate it.
+
+A BibTeX entry for LaTeX users is
+
+```bibtex
+@article{10.21105/joss.05585,
+author = {Batista, Quentin and Coleman, Chase and Furusawa, Yuya and Hu, Shu and Lunagariya, Smit and Lyon, Spencer and McKay, Matthew and Oyama, Daisuke and Sargent, Thomas J. and Shi, Zejin and Stachurski, John and Winant, Pablo and Watkins, Natasha and Yang, Ziyue and Zhang, Hengcheng},
+doi = {10.5281/zenodo.10345102},
+title = {QuantEcon.py: A community based Python library for quantitative economics},
+year = {2024},
+journal = {Journal of Open Source Software},
+volume = {9},
+number = {93},
+pages = {5585}
+}
+```