Skip to content

How to cite us

If you used Neurodesk in your research or teaching, please cite our main paper and the relevant containerised tools to ensure reproducibility and proper attribution.

Please cite the Neurodesk paper. You can also access it via the open access link or refer to the preprint version.

If you used Neurodesktop, please include the version used (e.g. v2026-09-23). See examples below.

Full citation: Renton, A.I., Dao, T.T., Johnstone, T., Civier, O., Sullivan, R. P., White, D. J., … Narayanan, A. & Bollmann, S. Neurodesk: an accessible, flexible and portable data analysis environment for reproducible neuroimaging. Nat Methods (2024). https://doi.org/10.1038/s41592-023-02145-x

BibTeX:

@article{Renton2024,
author = {Renton, Angela I and Dao, Thuy T and Johnstone, Tom and Civier, Oren and Sullivan, Ryan P and White, David J and Lyons, Paris and Slade, Benjamin M and Abbott, David F and Amos, Toluwani J and Bollmann, Saskia and Botting, Andy and Campbell, Megan E J and Chang, Jeryn and Close, Thomas G and D{\"{o}}rig, Monika and Eckstein, Korbinian and Egan, Gary F and Evas, Stefanie and Flandin, Guillaume and Garner, Kelly G and Garrido, Marta I and Ghosh, Satrajit S and Grignard, Martin and Halchenko, Yaroslav O and Hannan, Anthony J and Heinsfeld, Anibal S and Huber, Laurentius and Hughes, Matthew E and Kaczmarzyk, Jakub R and Kasper, Lars and Kuhlmann, Levin and Lou, Kexin and Mantilla-Ramos, Yorguin-Jose and Mattingley, Jason B and Meier, Michael L and Morris, Jo and Narayanan, Akshaiy and Pestilli, Franco and Puce, Aina and Ribeiro, Fernanda L and Rogasch, Nigel C and Rorden, Chris and Schira, Mark M and Shaw, Thomas B and Sowman, Paul F and Spitz, Gershon and Stewart, Ashley W and Ye, Xincheng and Zhu, Judy D and Narayanan, Aswin and Bollmann, Steffen},
doi = {10.1038/s41592-023-02145-x},
issn = {1548-7105},
journal = {Nature Methods},
number = {5},
pages = {804--808},
title = {{Neurodesk: an accessible, flexible and portable data analysis environment for reproducible neuroimaging}},
url = {https://doi.org/10.1038/s41592-023-02145-x},
volume = {21},
year = {2024}
}

For reproducibility, include the tool name, version number, and build date for each containerised application that you used in Neurodesk. Also cite the original publications for each tool, as well as Neurodesk. You can get this information in two ways:

Where available, the Container DOI link in the application list identifies the packaged software version on Zenodo. Cite that record to identify your computational environment, and cite the tool papers to credit the underlying methods.

Copy a citation from the Applications catalogue

Section titled “Copy a citation from the Applications catalogue”

Each card in the Applications catalogue has a Tool citations row. If the tool’s recipe has a citation, the row shows it, and DOIs and URLs in it are links. The row has these buttons:

  • Copy citation copies the tool’s citation text. It appears only when the tool has a citation.
  • Copy methods text copies a methods sentence for the latest version of the tool, followed by a reference list with the tool’s citation and the Neurodesk paper.

The methods sentence has this format:

ants (v2.6.5, built 2026-10-12) was run in Neurodesk (v2026-09-23, Renton et al., 2024).

The copied sentence names the latest version in the catalogue. If you used a different version, change the version and build date to match. To see all versions and their build dates, expand All Versions on the card.

If a tool has no citation in the catalogue, find the tool’s directory in neurocontainers/recipes and look for references in README.md or the readme section of build.yaml. Follow the tool authors’ guidance for the methods you used. For example, the FSL recipe includes overview references and directs readers to the individual tools’ manuals.

Generate a citation list with neurodesk cite

Section titled “Generate a citation list with neurodesk cite”

Neurodesktop records each Neurodesk tool that you load. The neurodesk cite command turns that record into a CITATIONS.md file with a methods sentence for each tool version and one reference list.

Neurodesktop adds one line to a usage log each time a Neurodesk module loads. The line has the module name, the version, and the time in UTC. Loads from these places are recorded:

  • ml and module load in a terminal.
  • Notebook kernels and the module side panel in JupyterLab.
  • Applications in the desktop menu.

The log is ~/.local/state/neurodesk/module-usage.tsv, or $XDG_STATE_HOME/neurodesk/module-usage.tsv if you set XDG_STATE_HOME. Only Neurodesk modules from CVMFS or from local containers are recorded. The log stays only in your home directory, and Neurodesktop does not send it anywhere. Your home directory is persistent in the standard Docker and hosted setups, so the log is kept when you restart Neurodesktop.

To write the citation list, run this command in a Neurodesktop terminal:

Terminal window
neurodesk cite

The command writes CITATIONS.md to the first of these locations that is a writable folder:

  1. ~/neurodesktop-storage
  2. /neurodesktop-storage
  3. Your home directory

The file has one entry for each tool version, in the order that you first loaded them. If you loaded a tool many times, it is listed once. Remove the tools that your analysis did not use before you add the text to a paper.

These options change what the command does:

OptionEffect
--since YYYY-MM-DDInclude only loads on or after this date. The date is in UTC.
--output PATHWrite the file to PATH instead of the default location.
--clearEmpty the usage log and exit. You cannot restore the cleared loads. To leave out older loads without deleting them, use --since.

For example, to write the citations for one project into the project folder:

Terminal window
neurodesk cite --since 2026-11-01 --output ~/neurodesktop-storage/my-project/CITATIONS.md

This excerpt shows the output for a session that loaded ants and bidsme:

# Citations for Neurodesk tools
Generated by `neurodesk cite` from 4 recorded module loads between 2026-11-03 and 2026-11-06. Remove any tool your analysis did not use.
## Methods
ants (v2.6.5, built 2026-10-12) was run in Neurodesk (v2026-09-23, Renton et al., 2024).
bidsme (v1.11.0, built 2026-09-15) was run in Neurodesk (v2026-09-23, Renton et al., 2024).
## References
Avants BB, Tustison NJ, Song G, Cook PA, Klein A, Gee JC. A reproducible evaluation of ANTs similarity metric performance in brain image registration. Neuroimage. 2011 Feb 1;54(3):2033-44. doi: 10.1016/j.neuroimage.2010.09.025. ...
bidsme: the Neurodesk catalogue does not list a citation yet. See https://neurodesk.org/overview/how-to-cite-us/ and the recipe at https://github.com/neurodesk/neurocontainers/tree/main/recipes/bidsme
Renton, A.I., Dao, T.T., Johnstone, T., ... Nat Methods (2024). https://doi.org/10.1038/s41592-023-02145-x

The tool citations come from the Applications catalogue on neurodesk.org. A tool without a catalogue citation gets a link to this guide and to its recipe. If you used an EEG, MEG, or electrophysiology tool, the file also reminds you to cite the AEDAPT project.

neurodesk cite downloads the catalogue each time it runs and keeps a copy in ~/.cache/neurodesk/. If the download fails, the command uses the copy and prints the date of the copy. If there is no copy, the command still writes CITATIONS.md, but without build dates or tool citations, and it prints a warning.

Here are some example excerpts of how to cite Neurodesk:

“TGV QSM (v1.0.0_20210629, Langkammer et al, 2015) was run in Neurodesk (v2026-09-23, Renton et al, 2024)”

EEG example: “EEGlab (2020.0_20211026, Delorme & Makeig, 2004) was run in Neurodesk (v2026-09-23, Renton et al, 2024) part of the AEDAPT project.”

  1. Langkammer, C; Bredies, K; Poser, BA; Barth, M; Reishofer, G; Fan, AP; Bilgic, B; Fazekas, F; Mainero; C; Ropele, S. Fast Quantitative Susceptibility Mapping using 3D EPI and Total Generalized Variation. Neuroimage. 2015 May 1;111:622-30. doi: 10.1016/j.neuroimage.2015.02.041
  2. Renton, A.I., Dao, T.T., Johnstone, T., Civier, O., Sullivan, R. P., White, D. J., … Narayanan, A. & Bollmann, S. Neurodesk: an accessible, flexible and portable data analysis environment for reproducible neuroimaging. Nat Methods (2024). 10.1038/s41592-023-02145-x
  3. Delorme A & Makeig S (2004) EEGLAB: an open-source toolbox for analysis of single-trial EEG dynamics, Journal of Neuroscience Methods 134:9-21. doi: 10.1016/j.jneumeth.2003.10.009

The citation for each tool comes from its recipe in neurocontainers, recipes/<tool>/build.yaml. Neurodesk uses structured_readme.citation if the recipe sets it. Otherwise, it uses the Citation: section of the readme. The Applications catalogue and neurodesk cite read the citation from the catalogue data, so a change to the citation does not need a container rebuild. To add or fix a citation, open a pull request in neurocontainers that changes build.yaml.