Skip to content

Commit 3930865

Browse files
authored
docs: Update citation to JOSS article (#2740)
- Replace the BibTeX citation with a Citation File Format (CFF) that references our new paper in the Journal of Open Source Software. - Update README and docs to display the JOSS DOI badge and provide proper citation instructions for "Mesa 3: Agent-based modeling with Python in 2025".
1 parent f1b9763 commit 3930865

File tree

4 files changed

+84
-26
lines changed

4 files changed

+84
-26
lines changed

CITATION.bib

-19
This file was deleted.

CITATION.cff

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
cff-version: "1.2.0"
2+
authors:
3+
- family-names: Hoeven
4+
given-names: Ewout
5+
name-particle: ter
6+
orcid: "https://orcid.org/0009-0002-0805-3425"
7+
- family-names: Kwakkel
8+
given-names: Jan
9+
orcid: "https://orcid.org/0000-0001-9447-2954"
10+
- family-names: Hess
11+
given-names: Vincent
12+
orcid: "https://orcid.org/0000-0002-9242-8500"
13+
- family-names: Pike
14+
given-names: Thomas
15+
orcid: "https://orcid.org/0000-0003-1576-0283"
16+
- family-names: Wang
17+
given-names: Boyu
18+
orcid: "https://orcid.org/0000-0001-9879-2138"
19+
- family-names: rht
20+
orcid: "https://orcid.org/0009-0002-6902-111X"
21+
- family-names: Kazil
22+
given-names: Jackie
23+
orcid: "https://orcid.org/0000-0002-8300-7384"
24+
doi: 10.5281/zenodo.15090710
25+
message: If you use this software, please cite our article in the
26+
Journal of Open Source Software.
27+
preferred-citation:
28+
authors:
29+
- family-names: Hoeven
30+
given-names: Ewout
31+
name-particle: ter
32+
orcid: "https://orcid.org/0009-0002-0805-3425"
33+
- family-names: Kwakkel
34+
given-names: Jan
35+
orcid: "https://orcid.org/0000-0001-9447-2954"
36+
- family-names: Hess
37+
given-names: Vincent
38+
orcid: "https://orcid.org/0000-0002-9242-8500"
39+
- family-names: Pike
40+
given-names: Thomas
41+
orcid: "https://orcid.org/0000-0003-1576-0283"
42+
- family-names: Wang
43+
given-names: Boyu
44+
orcid: "https://orcid.org/0000-0001-9879-2138"
45+
- family-names: rht
46+
orcid: "https://orcid.org/0009-0002-6902-111X"
47+
- family-names: Kazil
48+
given-names: Jackie
49+
orcid: "https://orcid.org/0000-0002-8300-7384"
50+
date-published: 2025-03-28
51+
doi: 10.21105/joss.07668
52+
issn: 2475-9066
53+
issue: 107
54+
journal: Journal of Open Source Software
55+
publisher:
56+
name: Open Journals
57+
start: 7668
58+
title: "Mesa 3: Agent-based modeling with Python in 2025"
59+
type: article
60+
url: "https://joss.theoj.org/papers/10.21105/joss.07668"
61+
volume: 10
62+
title: "Mesa 3: Agent-based modeling with Python in 2025"

README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Mesa: Agent-based modeling in Python
22

3-
| | |
4-
| --- | --- |
5-
| CI/CD | [![GitHub Actions build status](https://github.com/projectmesa/mesa/workflows/build/badge.svg)](https://github.com/projectmesa/mesa/actions) [![Coverage status](https://codecov.io/gh/projectmesa/mesa/branch/main/graph/badge.svg)](https://codecov.io/gh/projectmesa/mesa) |
3+
| | |
4+
|---------| --- |
5+
| CI/CD | [![GitHub Actions build status](https://github.com/projectmesa/mesa/workflows/build/badge.svg)](https://github.com/projectmesa/mesa/actions) [![Coverage status](https://codecov.io/gh/projectmesa/mesa/branch/main/graph/badge.svg)](https://codecov.io/gh/projectmesa/mesa) |
66
| Package | [![PyPI - Version](https://img.shields.io/pypi/v/mesa.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/Mesa/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/mesa.svg?color=blue&label=Downloads&logo=pypi&logoColor=gold)](https://pypi.org/project/Mesa/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mesa.svg?logo=python&label=Python&logoColor=gold)](https://pypi.org/project/Mesa/) |
7-
| Meta | [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/) |
8-
| Chat | [![chat](https://img.shields.io/matrix/project-mesa:matrix.org?label=chat&logo=Matrix)](https://matrix.to/#/#project-mesa:matrix.org) |
7+
| Meta | [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/) |
8+
| Chat | [![chat](https://img.shields.io/matrix/project-mesa:matrix.org?label=chat&logo=Matrix)](https://matrix.to/#/#project-mesa:matrix.org) |
9+
| Cite | [![DOI](https://joss.theoj.org/papers/10.21105/joss.07668/status.svg)](https://doi.org/10.21105/joss.07668) |
910

1011
Mesa allows users to quickly create agent-based models using built-in
1112
core components (such as spatial grids and agent schedulers) or
@@ -133,4 +134,7 @@ Don't forget to checkout the [Contributors guide](https://github.com/projectmesa
133134

134135
## Citing Mesa
135136

136-
To cite Mesa in your publication, you can use the [CITATION.bib](https://github.com/projectmesa/mesa/blob/main/CITATION.bib).
137+
To cite Mesa in your publication, you can refer to our peer-reviewed article in the Journal of Open Source Software (JOSS):
138+
- ter Hoeven et al., (2025). Mesa 3: Agent-based modeling with Python in 2025. Journal of Open Source Software, 10(107), 7668, https://doi.org/10.21105/joss.07668
139+
140+
Our [CITATION.cff](https://github.com/projectmesa/mesa/blob/main/CITATION.cff) file generates APA, BibTeX and other citation formats.

docs/index.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Mesa: Agent-based modeling in Python
22

3+
```{image} https://joss.theoj.org/papers/10.21105/joss.07668/status.svg
4+
:target: https://doi.org/10.21105/joss.07668
5+
```
6+
37
```{image} https://github.com/projectmesa/mesa/workflows/build/badge.svg
48
:target: https://github.com/projectmesa/mesa/actions
59
```
@@ -67,7 +71,14 @@ Mesa is an open source project and welcomes contributions:
6771
- [Issue Tracker] - Report bugs or suggest features
6872
- [Contributors Guide] - Learn how to contribute
6973

70-
The original Mesa conference paper is [available here](http://conference.scipy.org.s3-website-us-east-1.amazonaws.com/proceedings/scipy2015/jacqueline_kazil.html).
74+
### Citing Mesa
75+
76+
To cite Mesa in your publication, you can refer to our peer-reviewed article in the Journal of Open Source Software (JOSS):
77+
- ter Hoeven et al., (2025). Mesa 3: Agent-based modeling with Python in 2025. Journal of Open Source Software, 10(107), 7668, https://doi.org/10.21105/joss.07668
78+
79+
Our [CITATION.cff](https://github.com/projectmesa/mesa/blob/main/CITATION.cff) file generates APA, BibTeX and other citation formats.
80+
81+
The original Mesa conference paper from 2015 is [available here](http://conference.scipy.org.s3-website-us-east-1.amazonaws.com/proceedings/scipy2015/jacqueline_kazil.html).
7182

7283
```{toctree}
7384
:hidden: true

0 commit comments

Comments
 (0)