Skip to content

Commit 4b2127a

Browse files
authored
Add CITATION.cff and update citations in README (#252)
1 parent 663b885 commit 4b2127a

File tree

2 files changed

+125
-16
lines changed

2 files changed

+125
-16
lines changed

CITATION.cff

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# This CITATION.cff file was generated with cffinit.
2+
# Visit https://bit.ly/cffinit to generate yours today!
3+
4+
cff-version: 1.2.0
5+
title: >-
6+
BABS : BIDS App Bootstrap
7+
message: >-
8+
If you use this software, please cite it using the
9+
metadata from this file, as well as the
10+
Imaging Neuroscience (doi:10.1162/imag_a_00074) and
11+
Biological Psychiatry (doi:10.1016/j.biopsych.2024.02.056) papers.
12+
type: software
13+
authors:
14+
- given-names: Chenying
15+
family-names: Zhao
16+
orcid: "https://orcid.org/0000-0001-7878-6259"
17+
- given-names: Dorota
18+
family-names: Jarecka
19+
- given-names: Sydney
20+
family-names: Covitz
21+
affiliation: Stanford University
22+
orcid: "https://orcid.org/0000-0002-7430-4125"
23+
- given-names: Yibei
24+
family-names: Chen
25+
- given-names: Simon B.
26+
family-names: Eickhoff
27+
- given-names: Damien
28+
family-names: Fair
29+
affiliation: University of Minnesota
30+
orcid: "https://orcid.org/0000-0001-8602-393X"
31+
- given-names: Alexandre R.
32+
family-names: Franco
33+
- given-names: Yaroslav O.
34+
family-names: Halchenko
35+
- given-names: Timothy J.
36+
family-names: Hendrickson
37+
- given-names: Felix
38+
family-names: Hoffstaedter
39+
- given-names: Audrey
40+
family-names: Houghton
41+
- given-names: Gregory
42+
family-names: Kiar
43+
- given-names: Austin
44+
family-names: Macdonald
45+
- given-names: Kahini
46+
family-names: Mehta
47+
48+
affiliation: Columbia University
49+
orcid: "https://orcid.org/0000-0001-9466-100X"
50+
- given-names: Michael P.
51+
family-names: Milham
52+
- given-names: Taylor
53+
family-names: Salo
54+
55+
affiliation:Penn Lifespan Informatics and Neuroimaging Center, University of Pennsylvania, Philadelphia, PA, USA; Department of Psychiatry, Perelman School of Medicine, University of Pennsylvania, Philadelphia, PA, USA
56+
orcid: "https://orcid.org/0000-0001-9813-3167"
57+
- given-names: Michael
58+
family-names: Hanke
59+
- given-names: Satrajit S.
60+
family-names: Ghosh
61+
- given-names: Brooke L.
62+
family-names: Sevchik
63+
affiliation: Penn Lifespan Informatics and Neuroimaging Center, University of Pennsylvania, Philadelphia, PA, USA; Department of Psychiatry, Perelman School of Medicine, University of Pennsylvania, Philadelphia, PA, USA.
64+
- given-names: S. Parker
65+
family-names: Singleton
66+
affiliation: Penn Lifespan Informatics and Neuroimaging Center, University of Pennsylvania, Philadelphia, PA, USA; Department of Psychiatry, Perelman School of Medicine, University of Pennsylvania, Philadelphia, PA, USA
67+
orcid: "https://orcid.org/0000-0002-7102-7820"
68+
- given-names: Tien
69+
family-names: Tong
70+
affiliation: Penn Lifespan Informatics and Neuroimaging Center, University of Pennsylvania, Philadelphia, PA, USA; Department of Psychiatry, Perelman School of Medicine, University of Pennsylvania, Philadelphia, PA, USA
71+
orcid: 'https://orcid.org/0000-0002-1940-3198'
72+
- given-names: Matthew
73+
family-names: Cieslak
74+
75+
affiliation: Penn Lifespan Informatics and Neuroimaging Center, University of Pennsylvania, Philadelphia, PA, USA; Department of Psychiatry, Perelman School of Medicine, University of Pennsylvania, Philadelphia, PA, USA
76+
orcid: "https://orcid.org/0000-0002-1931-4734"
77+
- given-names: Steven
78+
family-names: Meisler
79+
orcid: "https://orcid.org/0000-0002-8888-1572"
80+
affiliation: Penn Lifespan Informatics and Neuroimaging Center, University of Pennsylvania, Philadelphia, PA, USA; Department of Psychiatry, Perelman School of Medicine, University of Pennsylvania, Philadelphia, PA, USA
81+
- given-names: Theodore
82+
family-names: Satterthwaite
83+
affiliation: Penn Lifespan Informatics and Neuroimaging Center, University of Pennsylvania, Philadelphia, PA, USA; Department of Psychiatry, Perelman School of Medicine, University of Pennsylvania, Philadelphia, PA, USA
84+
orcid: "https://orcid.org/0000-0001-7072-9399"
85+
identifiers:
86+
- type: doi
87+
value: 10.5281/zenodo.8184642
88+
description: The Zenodo DOI
89+
repository-code: "https://github.com/PennLINC/babs"
90+
url: "https://pennlinc-babs.readthedocs.io/"
91+
abstract: >-
92+
BIDS App Bootstrap (BABS) is a reproducible, generalizable, and scalable
93+
Python package for BIDS App analysis of large datasets.
94+
It uses DataLad and adopts the FAIRly big framework.
95+
Currently, BABS supports jobs submissions and audits on SLURM
96+
high performance computing (HPC) clusters.
97+
keywords:
98+
- BIDS-App
99+
- Neuroimaging
100+
license: MIT
101+
version: 0.0.10
102+
date-released: "2025-03-24"

README.rst

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
BABS: BIDS App Bootstrap
3-
===============================
3+
========================
44

55
.. image:: https://readthedocs.org/projects/pennlinc-babs/badge/?version=latest
66
:target: http://pennlinc-babs.readthedocs.io/en/latest/?badge=latest
@@ -13,43 +13,50 @@ BABS: BIDS App Bootstrap
1313

1414
Full documentation at https://pennlinc-babs.readthedocs.io
1515

16+
1617
About
17-
---------
18+
-----
19+
1820
BIDS App Bootstrap (BABS) is a reproducible, generalizable, and
1921
scalable Python package for BIDS App analysis of large datasets.
2022
It uses `DataLad <https://www.datalad.org/>`_ and adopts
2123
the `FAIRly big framework <https://doi.org/10.1038/s41597-022-01163-2>`_.
22-
Currently, BABS supports jobs submissions and audits on Sun Grid Engine (SGE) and Slurm
24+
Currently, BABS supports job submissions and audits on SLURM
2325
high performance computing (HPC) clusters.
2426

25-
Please cite our paper if you use BABS:
2627

27-
Zhao, C., Jarecka, D., Covitz, S., Chen, Y., Eickhoff, S. B.,
28-
Fair, D. A., Franco, A. R., Halchenko, Y. O., Hendrickson, T. J., Hoffstaedter, F.,
29-
Houghton, A., Kiar, G., Macdonald, A., Mehta, K., Milham, M. P.,
30-
Salo, T., Hanke, M., Ghosh, S. S., Cieslak, M. & Satterthwaite, T. D. (2024).
31-
A reproducible and generalizable software workflow
32-
for analysis of large-scale neuroimaging data collections using BIDS Apps.
33-
*Imaging Neuroscience*. Accepted.
28+
Citing BABS
29+
-----------
30+
31+
If you use BABS, please cite it using the metadata from the `CITATION.cff <CITATION.cff>`_ file,
32+
as well as the following papers:
33+
34+
Zhao, C., Jarecka, D., Covitz, S., Chen, Y., Eickhoff, S. B., Fair, D. A., ... & Satterthwaite, T. D. (2024).
35+
A reproducible and generalizable software workflow for analysis of large-scale neuroimaging data collections
36+
using BIDS Apps. *Imaging Neuroscience*, 2, 1-19. doi:10.1162/imag_a_00074.
3437

35-
Currently, the paper has been accepted for publication in *Imaging Neuroscience*.
36-
The *bioRxiv* version can be found `here <https://doi.org/10.1101/2023.08.16.552472>`_.
38+
Zhao, C., Chen, Y., Jarecka, D., Ghosh, S., Cieslak, M., & Satterthwaite, T. D. (2024).
39+
BABS in Action: Merging Reproducibility and Scalability for Large-Scale Neuroimaging Analysis With BIDS Apps.
40+
*Biological Psychiatry*, 95(10), S21-S22. doi:10.1016/j.biopsych.2024.02.056.
3741

3842

3943
BABS programs
40-
---------------------
44+
-------------
4145

4246
.. image:: https://github.com/PennLINC/babs/raw/main/docs/_static/babs_cli.png
4347
.. Note: this image is taken from the main branch, so it's normal that docs built from branches is not up-to-date.
4448
.. If using relative path, e.g., `_static/babs_cli.png`, although readthedocs front page would look good, GitHub front page cannot find that image!!!
4549
50+
4651
Schematic of BABS workflow
47-
----------------------------
52+
--------------------------
53+
4854
.. image:: https://github.com/PennLINC/babs/raw/main/docs/_static/babs_workflow.png
4955
.. Note: this image is taken from the main branch, so it's normal that docs built from branches is not up-to-date.
5056
57+
5158
Background and Significance
52-
-------------------------------
59+
---------------------------
5360

5461
Neuroimaging research faces a crisis of reproducibility.
5562
With massive sample sizes and greater data complexity, this problem becomes more acute.

0 commit comments

Comments
 (0)