Skip to content

Commit 7fffa18

Browse files
Smit-createoyamad
andauthored
Add citation (#719)
* add citation file * update license year * add bibtex for citation * Update README.md Co-authored-by: Daisuke Oyama <Oyama.Daisuke@gmail.com> --------- Co-authored-by: Daisuke Oyama <Oyama.Daisuke@gmail.com>
1 parent d1e4d22 commit 7fffa18

File tree

3 files changed

+102
-1
lines changed

3 files changed

+102
-1
lines changed

CITATION.cff

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
cff-version: "1.2.0"
2+
authors:
3+
- family-names: Batista
4+
given-names: Quentin
5+
- family-names: Coleman
6+
given-names: Chase
7+
- family-names: Furusawa
8+
given-names: Yuya
9+
- family-names: Hu
10+
given-names: Shu
11+
- family-names: Lunagariya
12+
given-names: Smit
13+
- family-names: Lyon
14+
given-names: Spencer
15+
- family-names: McKay
16+
given-names: Matthew
17+
- family-names: Oyama
18+
given-names: Daisuke
19+
- family-names: Sargent
20+
given-names: Thomas J.
21+
- family-names: Shi
22+
given-names: Zejin
23+
- family-names: Stachurski
24+
given-names: John
25+
- family-names: Winant
26+
given-names: Pablo
27+
- family-names: Watkins
28+
given-names: Natasha
29+
- family-names: Yang
30+
given-names: Ziyue
31+
- family-names: Zhang
32+
given-names: Hengcheng
33+
doi: 10.5281/zenodo.10345102
34+
message: If you use this software, please cite our article in the
35+
Journal of Open Source Software.
36+
preferred-citation:
37+
authors:
38+
- family-names: Batista
39+
given-names: Quentin
40+
- family-names: Coleman
41+
given-names: Chase
42+
- family-names: Furusawa
43+
given-names: Yuya
44+
- family-names: Hu
45+
given-names: Shu
46+
- family-names: Lunagariya
47+
given-names: Smit
48+
- family-names: Lyon
49+
given-names: Spencer
50+
- family-names: McKay
51+
given-names: Matthew
52+
- family-names: Oyama
53+
given-names: Daisuke
54+
- family-names: Sargent
55+
given-names: Thomas J.
56+
- family-names: Shi
57+
given-names: Zejin
58+
- family-names: Stachurski
59+
given-names: John
60+
- family-names: Winant
61+
given-names: Pablo
62+
- family-names: Watkins
63+
given-names: Natasha
64+
- family-names: Yang
65+
given-names: Ziyue
66+
- family-names: Zhang
67+
given-names: Hengcheng
68+
date-published: 2024-01-06
69+
doi: 10.21105/joss.05585
70+
issn: 2475-9066
71+
issue: 93
72+
journal: Journal of Open Source Software
73+
publisher:
74+
name: Open Journals
75+
start: 5585
76+
title: "QuantEcon.py: A community based Python library for
77+
quantitative economics"
78+
type: article
79+
url: "https://joss.theoj.org/papers/10.21105/joss.05585"
80+
volume: 9
81+
title: "QuantEcon.py: A community based Python library for quantitative
82+
economics"

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
Copyright © 2013-2023 Thomas J. Sargent and John Stachurski: MIT
2+
Copyright © 2013-2024 Thomas J. Sargent and John Stachurski: MIT
33
All rights reserved.
44

55
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:

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,22 @@ Once you have downloaded the source files then the package can be installed by r
5959
flit install
6060

6161
(To learn the basics about setting up Git see [this link](https://help.github.com/articles/set-up-git/).)
62+
63+
## Citation
64+
65+
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.
66+
67+
A BibTeX entry for LaTeX users is
68+
69+
```bibtex
70+
@article{10.21105/joss.05585,
71+
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},
72+
doi = {10.5281/zenodo.10345102},
73+
title = {QuantEcon.py: A community based Python library for quantitative economics},
74+
year = {2024},
75+
journal = {Journal of Open Source Software},
76+
volume = {9},
77+
number = {93},
78+
pages = {5585}
79+
}
80+
```

0 commit comments

Comments
 (0)