Skip to content

Commit 8d65e61

Browse files
EwoutHwang-boyu
andauthored
Replace CITATION.bib with CITATION.cff for better GitHub integration (#272)
Replaced the existing `CITATION.bib` file with a `CITATION.cff` file to leverage GitHub's native citation support. The `CITATION.cff` file provides both human- and machine-readable citation metadata, allowing users to easily cite the repository in formats like APA and BibTeX directly from GitHub's "Cite this repository" feature. The new `CITATION.cff` includes: - Author details - Title, DOI, and URL - Book title and conference details - Keywords and abstract This change aligns with modern citation practices for software and academic works on GitHub. Co-authored-by: Wang Boyu <[email protected]>
1 parent 36ec306 commit 8d65e61

File tree

4 files changed

+43
-19
lines changed

4 files changed

+43
-19
lines changed

CITATION.bib

Lines changed: 0 additions & 17 deletions
This file was deleted.

CITATION.cff

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite the associated paper (see preferred-citation)."
3+
authors:
4+
- family-names: Wang
5+
given-names: Boyu
6+
orcid: "https://orcid.org/0000-0001-9879-2138"
7+
- family-names: Hess
8+
given-names: Vincent
9+
orcid: "https://orcid.org/0000-0002-9242-8500"
10+
- family-names: Crooks
11+
given-names: Andrew
12+
orcid: "https://orcid.org/0000-0002-5034-6654"
13+
title: "Mesa-Geo: A GIS Extension for the Mesa Agent-Based Modeling Framework in Python"
14+
preferred-citation:
15+
type: conference-paper
16+
authors:
17+
- family-names: Wang
18+
given-names: Boyu
19+
orcid: "https://orcid.org/0000-0001-9879-2138"
20+
- family-names: Hess
21+
given-names: Vincent
22+
orcid: "https://orcid.org/0000-0002-9242-8500"
23+
- family-names: Crooks
24+
given-names: Andrew
25+
orcid: "https://orcid.org/0000-0002-5034-6654"
26+
doi: 10.1145/3557989.3566157
27+
url: "https://doi.org/10.1145/3557989.3566157"
28+
publisher:
29+
name: Association for Computing Machinery
30+
title: "Mesa-Geo: A GIS Extension for the Mesa Agent-Based Modeling Framework in Python"
31+
collection-title: "Proceedings of the 5th ACM SIGSPATIAL International Workshop on GeoSpatial Simulation"
32+
start: 1
33+
end: 10
34+
numpages: 10
35+
conference:
36+
name: "GeoSim '22"
37+
city: Seattle
38+
region: Washington
39+
country: USA
40+
year: 2022
41+
isbn: 9781450395373

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ Don't forget to check out the [Contributors guide](https://github.com/projectmes
5757

5858
## Citing Mesa-Geo
5959

60-
To cite Mesa-Geo in your publication, you can use the [CITATION.bib](https://github.com/projectmesa/mesa-geo/blob/main/CITATION.bib).
60+
To cite Mesa-Geo in your publication, you can click the "Cite this repository" button in the right sidebar of the [repository landing page](https://github.com/projectmesa/mesa-geo), and choose either the APA or BibTeX citation format.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Don't forget to check out the [Contributors guide](https://github.com/projectmes
5959

6060
## Citing Mesa-Geo
6161

62-
To cite Mesa-Geo in your publication, you can use the [CITATION.bib](https://github.com/projectmesa/mesa-geo/blob/main/CITATION.bib).
62+
To cite Mesa-Geo in your publication, you can click the "Cite this repository" button in the right sidebar of the [repository landing page](https://github.com/projectmesa/mesa-geo), and choose either the APA or BibTeX citation format.
6363

6464

6565
```{toctree}

0 commit comments

Comments
 (0)