Merge pull request #190 from toruseo/joss-readme

JOSS documentation update
toruseo · Feb 7, 2025 · 8da1774 · 8da1774
2 parents 83327c0 + f0111b3
commit 8da1774
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 3 deletions.
diff --git a/.github/CITATION.cff b/.github/CITATION.cff
@@ -0,0 +1,28 @@
+cff-version: "1.2.0"
+authors:
+- family-names: Seo
+  given-names: Toru
+  orcid: "https://orcid.org/0000-0001-9767-7218"
+doi: 10.5281/zenodo.14799163
+message: If you use this software, please cite our article in the
+  Journal of Open Source Software.
+preferred-citation:
+  authors:
+  - family-names: Seo
+    given-names: Toru
+    orcid: "https://orcid.org/0000-0001-9767-7218"
+  date-published: 2025-02-06
+  doi: 10.21105/joss.07617
+  issn: 2475-9066
+  issue: 106
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  start: 7617
+  title: "UXsim: lightweight mesoscopic traffic flow simulator in pure
+    Python"
+  type: article
+  url: "https://joss.theoj.org/papers/10.21105/joss.07617"
+  volume: 10
+title: "UXsim: lightweight mesoscopic traffic flow simulator in pure
+  Python"
diff --git a/README.jp.md b/README.jp.md
@@ -6,6 +6,7 @@
 [![codecov](https://codecov.io/gh/toruseo/UXsim/graph/badge.svg?token=DK77Y1Y5AT)](https://codecov.io/gh/toruseo/UXsim)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/uxsim)
 [![arXiv](https://img.shields.io/badge/arXiv-2309.17114-b31b1b.svg)](http://dx.doi.org/10.48550/arXiv.2309.17114)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.07617/status.svg)](https://doi.org/10.21105/joss.07617)
 [![Static Badge](https://img.shields.io/badge/readme-English%20%F0%9F%87%BA%F0%9F%87%B8%20-%20darkblue)](https://github.com/toruseo/UXsim/blob/main/README.md)
 
 *UXsim*はPython製のオープンソース・フリーなマクロ・メソ交通流シミュレータです．
@@ -62,6 +63,8 @@ https://github.com/toruseo/UXsim/assets/34780089/ec780a33-d9ba-4068-a005-0b06127
 
 ## インストール
 
+Python 3.9以降に対応しています．
+
 ### pipを使用
 
 最も簡単な方法は，PyPIからpipを使用してインストールすることです．
@@ -213,8 +216,11 @@ UXsimはMIT Licenseのもとで公開しています．
 
 使用された成果を発表される際は，参考文献として以下を引用してください：
 
-- 瀬尾亨. [マクロ交通流シミュレーション：数学的基礎理論とPythonによる実装](https://www.coronasha.co.jp/np/isbn/9784339052794/). コロナ社, 2023
-- Toru Seo. [UXsim: An open source macroscopic and mesoscopic traffic simulator in Python-a technical overview](http://dx.doi.org/10.48550/arXiv.2309.17114). arXiv preprint arXiv: 2309.17114, 2023
+- Toru Seo. [UXsim: lightweight mesoscopic traffic flow simulator in pure Python](https://doi.org/10.21105/joss.07617). Journal of Open Source Software, Vol. 10, No. 106, p. 7617, 2025.
+
+より詳細な説明が必要であれば以下も引用してください：
+- 瀬尾亨. [マクロ交通流シミュレーション：数学的基礎理論とPythonによる実装](https://www.coronasha.co.jp/np/isbn/9784339052794/). コロナ社, 2023.
+- Toru Seo. [UXsim: An open source macroscopic and mesoscopic traffic simulator in Python-a technical overview](http://dx.doi.org/10.48550/arXiv.2309.17114). arXiv preprint arXiv: 2309.17114, 2023.
 
 UXsimを使用した研究は[Githubのwikiページ](https://github.com/toruseo/UXsim/wiki)にまとめられています．自由に編集してください．
 

diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@
 [![codecov](https://codecov.io/gh/toruseo/UXsim/graph/badge.svg?token=DK77Y1Y5AT)](https://codecov.io/gh/toruseo/UXsim)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/uxsim)
 [![arXiv](https://img.shields.io/badge/arXiv-2309.17114-b31b1b.svg)](http://dx.doi.org/10.48550/arXiv.2309.17114)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.07617/status.svg)](https://doi.org/10.21105/joss.07617)
 [![Static Badge](https://img.shields.io/badge/readme-%E6%97%A5%E6%9C%AC%E8%AA%9E%20%F0%9F%87%AF%F0%9F%87%B5%20-pink)](https://github.com/toruseo/UXsim/blob/main/README.jp.md)
 
 *UXsim* is a free, open-source macroscopic and mesoscopic network traffic flow simulator written in Python.
@@ -216,9 +217,26 @@ To learn more about UXsim, please see:
 UXsim is released under the MIT License. You are free to use it as long as the source is acknowledged.
 
 When publishing works based on UXsim, please cite:
+- Toru Seo. [UXsim: lightweight mesoscopic traffic flow simulator in pure Python](https://doi.org/10.21105/joss.07617). Journal of Open Source Software, Vol. 10, No. 106, p. 7617, 2025.
 
+```
+@Article{seo2025joss,
+  author    = {Toru Seo},
+  journal   = {Journal of Open Source Software},
+  title     = {{UXsim}: lightweight mesoscopic traffic flow simulator in pure {Python}},
+  year      = {2025},
+  number    = {106},
+  pages     = {7617},
+  volume    = {10},
+  doi       = {10.21105/joss.07617},
+  publisher = {The Open Journal},
+  url       = {https://doi.org/10.21105/joss.07617},
+}
+```
+
+If you need more detailed information, please also cite:
 - Toru Seo. [Macroscopic Traffic Flow Simulation: Fundamental Mathematical Theory and Python Implementation](https://toruseo.github.io/misc/MacroTrafficSim_English_summary.pdf). Corona Publishing Co., Ltd., 2023.
-- Toru Seo. [UXsim: An open source macroscopic and mesoscopic traffic simulator in Python-a technical overview](http://dx.doi.org/10.48550/arXiv.2309.17114). arXiv preprint arXiv: 2309.17114, 2023
+- Toru Seo. [UXsim: An open source macroscopic and mesoscopic traffic simulator in Python-a technical overview](http://dx.doi.org/10.48550/arXiv.2309.17114). arXiv preprint arXiv: 2309.17114, 2023.
 
 Works using UXsim is summarized on the [Github Wiki page](https://github.com/toruseo/UXsim/wiki). Please feel free to edit.