From 779ff361a11014220d40b83a237a6a59d65a766f Mon Sep 17 00:00:00 2001 From: Smit-create Date: Sun, 7 Jan 2024 10:09:27 +0530 Subject: [PATCH 1/4] add citation file --- CITATION.cff | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 00000000..6c9815fe --- /dev/null +++ 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" From d26f71ab924ee451dd7947ed9d1d79cda662d344 Mon Sep 17 00:00:00 2001 From: Smit-create Date: Sun, 7 Jan 2024 10:09:35 +0530 Subject: [PATCH 2/4] update license year --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 04334378..40a58b6a 100644 --- 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: From 6df15c516ec20c6582002abc7e6da329c4785c2d Mon Sep 17 00:00:00 2001 From: Smit-create Date: Sun, 7 Jan 2024 10:09:54 +0530 Subject: [PATCH 3/4] add bibtex for citation --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index ca1188bb..5094b4d0 100644 --- a/README.md +++ b/README.md @@ -59,3 +59,17 @@ 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} +} +``` From 70d3cfd40965ca3b10dea87f72b3cd986e1dfe34 Mon Sep 17 00:00:00 2001 From: Smit Lunagariya Date: Mon, 8 Jan 2024 20:10:35 +0530 Subject: [PATCH 4/4] Update README.md Co-authored-by: Daisuke Oyama --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5094b4d0..e536d161 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,11 @@ A BibTeX entry for LaTeX users is @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} +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} } ```