Skip to content

Commit b4e5aae

Browse files
Add Zenodo DOI (10.5281/zenodo.19024753) to citation information
Update CITATION.cff, README, and documentation to include the DOI issued by Zenodo, along with version, repository URL, and license metadata. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 043cddf commit b4e5aae

File tree

5 files changed

+38
-13
lines changed

5 files changed

+38
-13
lines changed

CITATION.cff

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ authors:
2020
- given-names: Marcio Lobo
2121
family-names: Netto
2222
orcid: 'https://orcid.org/0000-0002-6694-0228'
23+
repository-code: 'https://github.com/CodeReclaimers/neat-python'
24+
license: BSD-3-Clause
25+
version: 2.0.1
26+
doi: 10.5281/zenodo.19024753

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,25 @@ See [`docs/network-json-format.md`](docs/network-json-format.md) for complete fo
6969

7070
## Citing ##
7171

72-
Here are APA and Bibtex entries you can use to cite this project in a publication. The listed authors are the originators
73-
and/or maintainers of all iterations of the project up to this point. If you have contributed and would like your name added
74-
to the citation, please submit an issue.
72+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19024753.svg)](https://doi.org/10.5281/zenodo.19024753)
73+
74+
If you use this project in a publication, please cite both the software and the original NEAT paper. The listed authors are
75+
the originators and/or maintainers of all iterations of the project up to this point. If you have contributed and would like
76+
your name added to the citation, please submit an issue.
7577

7678
APA
7779
```
78-
McIntyre, A., Kallada, M., Miguel, C. G., Feher de Silva, C., & Netto, M. L. neat-python [Computer software]
80+
McIntyre, A., Kallada, M., Miguel, C. G., Feher de Silva, C., & Netto, M. L. neat-python (Version 2.0.1) [Computer software]. https://doi.org/10.5281/zenodo.19024753
7981
```
8082

8183
Bibtex
8284
```
8385
@software{McIntyre_neat-python,
8486
author = {McIntyre, Alan and Kallada, Matt and Miguel, Cesar G. and Feher de Silva, Carolina and Netto, Marcio Lobo},
85-
title = {{neat-python}}
87+
title = {{neat-python}},
88+
version = {2.0.1},
89+
doi = {10.5281/zenodo.19024753},
90+
url = {https://github.com/CodeReclaimers/neat-python}
8691
}
8792
```
8893

docs/academic_research.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ Include appropriate citations:
342342

343343
* **Original NEAT paper**: Stanley, K. O., & Miikkulainen, R. (2002). Evolving neural networks through augmenting topologies. *Evolutionary Computation*, 10(2), 99-127.
344344

345-
* **neat-python**: Reference the GitHub repository and/or documentation: https://github.com/CodeReclaimers/neat-python
345+
* **neat-python**: McIntyre, A., Kallada, M., Miguel, C. G., Feher de Silva, C., & Netto, M. L. *neat-python* (Version 2.0.1) [Computer software]. https://doi.org/10.5281/zenodo.19024753
346346

347347
Additional Considerations
348348
-------------------------

docs/faq.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -607,15 +607,16 @@ How do I cite NEAT-Python?
607607

608608
**Cite both the library and the original NEAT paper:**
609609

610-
**NEAT-Python library:**
610+
**NEAT-Python library** (DOI: `10.5281/zenodo.19024753 <https://doi.org/10.5281/zenodo.19024753>`_):
611611

612612
.. code-block:: bibtex
613613
614-
@misc{neat-python,
615-
author = {CodeReclaimers, LLC},
616-
title = {{NEAT-Python}},
617-
howpublished = {\\url{https://github.com/CodeReclaimers/neat-python}},
618-
year = {2015--2025}
614+
@software{McIntyre_neat-python,
615+
author = {McIntyre, Alan and Kallada, Matt and Miguel, Cesar G. and Feher de Silva, Carolina and Netto, Marcio Lobo},
616+
title = {{neat-python}},
617+
version = {2.0.1},
618+
doi = {10.5281/zenodo.19024753},
619+
url = {https://github.com/CodeReclaimers/neat-python}
619620
}
620621
621622
**Original NEAT paper:**
@@ -633,7 +634,7 @@ How do I cite NEAT-Python?
633634
publisher={MIT Press}
634635
}
635636
636-
**In text:** "We used NEAT-Python (CodeReclaimers), an implementation of the NEAT algorithm (Stanley & Miikkulainen, 2002)."
637+
**In text:** "We used NEAT-Python (McIntyre et al., 2026), an implementation of the NEAT algorithm (Stanley & Miikkulainen, 2002)."
637638

638639
What's the difference from the original NEAT?
639640
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

progress-20260314.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,18 @@ Removed `# pylint: disable=no-self-use` comments from two locations. The `no-sel
4141
- `neat/export/exporters.py`
4242
- `neat/reporting.py`
4343
- `neat/iznn/__init__.py`
44+
45+
## Add Zenodo DOI to citation information
46+
47+
Zenodo issued DOI `10.5281/zenodo.19024753` for the project. Updated all citation-related files to include it:
48+
49+
- **`CITATION.cff`** — Added `repository-code`, `license`, `version` (2.0.1), and `doi` fields.
50+
- **`README.md`** — Added Zenodo DOI badge, DOI URL in APA entry, `version`/`doi`/`url` in BibTeX entry.
51+
- **`docs/faq.rst`** — Replaced old `@misc` citation with `@software` entry including DOI, version, and URL. Updated in-text example from "CodeReclaimers" to "McIntyre et al., 2026".
52+
- **`docs/academic_research.rst`** — Replaced bare GitHub link with full APA citation including DOI.
53+
54+
### Files modified
55+
- `CITATION.cff`
56+
- `README.md`
57+
- `docs/faq.rst`
58+
- `docs/academic_research.rst`

0 commit comments

Comments
 (0)