Skip to content

Commit 23704cd

Browse files
committed
Add citation page to the docs site
Adds a Citing page with the Zenodo DOI badge, guidance on concept versus version DOIs, and APA and BibTeX entries taken from the DataCite record. The docs home page gets the DOI badge and a short citation section.
1 parent 9b9269e commit 23704cd

3 files changed

Lines changed: 63 additions & 0 deletions

File tree

‎docs/CITING.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Citing processFNIRS2
2+
3+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23348858.svg)](https://doi.org/10.5281/zenodo.23348858)
4+
5+
If you use processFNIRS2 in your research, please cite the software. Each
6+
release is archived on [Zenodo](https://doi.org/10.5281/zenodo.23348858).
7+
8+
## Which DOI to use
9+
10+
| DOI | Points to | Use it for |
11+
|-----|-----------|------------|
12+
| [10.5281/zenodo.23348858](https://doi.org/10.5281/zenodo.23348858) | processFNIRS2 as a whole; always resolves to the latest release | Citing the toolbox in general |
13+
| Version DOI, listed on the [Zenodo record](https://doi.org/10.5281/zenodo.23348858) under "Versions" | One specific release | Methods sections and code-availability statements, so readers can reproduce your analysis |
14+
15+
Check the version you ran with `pf2_base.pf2version()`. For v1.2.0 the version
16+
DOI is [10.5281/zenodo.23348859](https://doi.org/10.5281/zenodo.23348859).
17+
18+
## APA
19+
20+
> Curtin, A., & Ayaz, H. (2026). *processFNIRS2* (Version v1.2.0) [Computer
21+
> software]. Zenodo. https://doi.org/10.5281/zenodo.23348858
22+
23+
## BibTeX
24+
25+
```bibtex
26+
@software{curtin2026processfnirs2,
27+
author = {Curtin, Adrian and Ayaz, Hasan},
28+
title = {processFNIRS2},
29+
version = {v1.2.0},
30+
publisher = {Zenodo},
31+
year = {2026},
32+
doi = {10.5281/zenodo.23348858},
33+
url = {https://doi.org/10.5281/zenodo.23348858},
34+
license = {GPL-3.0-or-later}
35+
}
36+
```
37+
38+
For a specific release, replace the `doi`, `url` and `version` with that
39+
release's values from Zenodo.
40+
41+
## Other formats
42+
43+
- **GitHub:** the "Cite this repository" button on the
44+
[repository page](https://github.com/AyazLab/processFNIRS2) exports APA and
45+
BibTeX from
46+
[`CITATION.cff`](https://github.com/AyazLab/processFNIRS2/blob/master/CITATION.cff).
47+
- **Zenodo:** the record's "Citation" box offers further styles and export
48+
formats (RIS, CSL JSON, DataCite XML).
49+
50+
A companion publication will be listed here when available.

‎docs/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# processFNIRS2 Documentation
22

3+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23348858.svg)](https://doi.org/10.5281/zenodo.23348858)
4+
35
Reference documentation for the processFNIRS2 MATLAB fNIRS analysis toolbox.
46
New here? Start with the [project README](https://github.com/AyazLab/processFNIRS2/blob/master/README.md)
57
for installation and a quick start, then come back for the deeper references
@@ -18,6 +20,16 @@ below. Runnable tutorials live in
1820
| [EXPLORERNIRS_PIPELINE.md](EXPLORERNIRS_PIPELINE.md) | The group-analysis layer (exploreFNIRS): Experiment class, grouping, statistics. |
1921
| [ARCHITECTURE.md](ARCHITECTURE.md) | How the toolbox fits together: data flow, package map, and where new code belongs. |
2022

23+
## Citing
24+
25+
If you use processFNIRS2 in your research, please cite it:
26+
27+
> Curtin, A., & Ayaz, H. (2026). *processFNIRS2* (Version v1.2.0) [Computer
28+
> software]. Zenodo. https://doi.org/10.5281/zenodo.23348858
29+
30+
See [Citing processFNIRS2](CITING.md) for BibTeX and for choosing between the
31+
project DOI and a per-version DOI.
32+
2133
## Also useful
2234

2335
- [Project README](https://github.com/AyazLab/processFNIRS2/blob/master/README.md) — overview, install, quick start.

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,4 @@ nav:
5757
- CLI/UX Guide: CLI_UX_GUIDE.md
5858
- exploreFNIRS Pipeline: EXPLORERNIRS_PIPELINE.md
5959
- Architecture: ARCHITECTURE.md
60+
- Citing: CITING.md

0 commit comments

Comments
 (0)