Skip to content

Commit 6f61ced

Browse files
Remi-GauRemi-Gau
committed
fix
1 parent 81c6426 commit 6f61ced

File tree

10 files changed

+104
-106
lines changed

10 files changed

+104
-106
lines changed

‎.github/ISSUE_TEMPLATE/bids_apps_submission.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ body:
1111
- type: markdown
1212
attributes:
1313
value: |
14-
- Have you checked our [contributing guide](https://github.com/bids-apps/bids-apps.github.io/blob/master/CONTRIBUTING.md)?
14+
- Have you checked our [contributing guide](https://bids-website.readthedocs.io/en/latest/collaboration/bids_github/CONTRIBUTING.html)?
1515
It's a helpful resource.
1616
17-
- Have you checked our [FAQ](https://bids-apps.neuroimaging.io/dev_faq/)?
17+
- Have you checked our [FAQ](https://bids-website.readthedocs.io/en/latest/faq/bids-apps.html)?
1818
1919
- type: textarea
2020
attributes:
@@ -30,7 +30,7 @@ body:
3030
3131
More details here:
3232
33-
https://github.com/bids-apps/bids-apps.github.io/blob/761bcd927ddce83e80e9f898dce1864d9bcb9b04/_config.yml#L64
33+
https://github.com/bids-standard/bids-website/blob/81c642691150e00c08ad4450dbdb05eb794f8f9a/data/tools/apps.yml#L3
3434
3535
For example:
3636

‎docs/collaboration/governance.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ users to confirm that a given dataset complies with the current edition
6060
of the standard, the [PyBIDS](https://github.com/bids-standard/pybids)
6161
Python and [bids-matlab](https://github.com/bids-standard/bids-matlab)
6262
libraries allow querying and manipulating BIDS-compliant datasets,
63-
[BIDS-Apps](https://bids-apps.neuroimaging.io/) for running portable
63+
[BIDS-Apps](https://bids-website.readthedocs.io/en/latest/tools/bids-apps.html) for running portable
6464
pipelines on validated BIDS datasets, and platforms like
6565
[OpenNeuro](https://openneuro.org/) store and serve BIDS datasets. Note
6666
that the associated software does not fall under the same governance

‎docs/collaboration/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Below is a list of common resources where users can get involved in making the B
3939
There are so many ways to help us build this community.
4040

4141
- You could help someone else learn the benefits of BIDS by giving a talk in your local organization
42-
- Or you could work on [building a BIDS App](https://bids-apps.neuroimaging.io/){:target="_blank"}!
42+
- Or you could work on [building a BIDS App](https://bids-website.readthedocs.io/en/latest/tools/bids-apps.html){:target="_blank"}!
4343

4444
<b>The only requirement is that everyone who contributes adheres to our
4545
[BIDS Code of Conduct](https://github.com/bids-standard/bids-specification/blob/master/CODE_OF_CONDUCT.md).</b>

‎docs/faq/bids-apps.md‎

Lines changed: 98 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
1-
## Can I add more arguments to the API of my App?
1+
# BIDS apps
22

3-
Every BIDS App must use the mandatory arguments mentioned above, but you are
4-
free to add more that are specific to the task your App will perform.
3+
!!! note
54

6-
We recommend you follow the guidelines mentioned in the
7-
[BIDS extension proposal 027](https://bids.neuroimaging.io/bep027)
8-
for more information on specifying the API of your App.
5+
Make sure to check out the [nipreps wesbite](https://www.nipreps.org/)
6+
for more information on using and creating BIDS apps.
7+
8+
## For users
9+
10+
### How can I check a version of a container I have available locally?
911

10-
## How can I check a version of a container I have available locally?
12+
For many bids-app you should be able to run something like:
13+
14+
```bash
15+
docker run bids/example --version
16+
```
1117

12-
Inside each BIDS App there is a /version file with the version number.
18+
Inside each BIDS App there is a `/version` file with the version number.
1319

1420
This file is automatically populated with tag used to trigger the build on the CI server.
1521

@@ -22,75 +28,36 @@ version you should refer to a specific Docker Hub tag. For example:
2228
docker pull bids/example:v0.0.5
2329
```
2430

25-
## How do I upload my BIDS App to the BIDS App Github org?
26-
27-
You can release BIDS Apps using your own or your lab's account.
28-
However, if you want to be added to the BIDS docker hub,
29-
please message the [BIDS maintainers](mailto:[email protected])
30-
to have a repo created for you.
31-
32-
If you base your code on <https://github.com/bids-apps/example> deployment on
33-
docker hub will happen automatically via Circle-ci.
34-
35-
If you want your App to show on the BIDS App website
36-
[here](https://bids-apps.neuroimaging.io/apps/), you will in any case have to
37-
update the `_config.yml` in the
38-
[BIDS App website repository](https://github.com/bids-apps/bids-apps.github.io.git).
39-
40-
## How should I version my BIDS App?
41-
42-
Since most BIDS Apps are just thin wrappers around existing pipelines it would
43-
be most sensible to use the same version as the software they are wrapping.
44-
45-
For example in case of HCP Pipelines this would be `v3.17.0`.
46-
47-
## How to tag a new release?
48-
49-
```bash
50-
git tag v0.0.1
51-
git push
52-
```
31+
## What do the analysis levels (`participant` and `group`) mean?
5332

54-
## I want to release a new version of a BIDS App, but the pipeline version is the same?
33+
Generally, `participant` means individual level analysis (for instance: single subject).
34+
The `group` level analysis can be thought of as the second step,
35+
where the input becomes the output of the `participant` level analysis.
5536

56-
This can happen when only the runscript or the Dockerfile changed?
57-
According to semantic versioning we should use the `+` signed followed by the build number.
58-
Unfortunately Docker Hub does not support semantic versioning.
59-
The best option is to use the `-` sign followed by the build number.
60-
For example `v3.17.0-3`.
37+
For example, generating statistic maps of each subject's brain could be considered `participant`,
38+
while generating the average of these maps across the dataset could be considered `group`.
6139

62-
## Is it mandatory to first check the dataset validity using the BIDS-validator?
40+
## For developers
6341

64-
It is an extremely helpful feature to have validation of the dataset as part of your tool.
65-
However, it's not considered mandatory.
66-
For instance: many Apps will
67-
simply fail with an error message if the dataset is not BIDS compliant.
42+
### Getting started
6843

69-
## Is there a BIDS App template?
44+
#### Is there a BIDS App template?
7045

7146
Have a look at the
72-
[example BIDS App repository](https://github.com/bids-apps/example). A
73-
minimalist example of a BIDS App consisting of a Dockerfile and a simple entry
74-
point script (written in this case in Python) accepting the standard BIDS Apps
75-
command line arguments.
76-
77-
## What do the analysis levels (`participant` and `group`) mean?
47+
[example BIDS App repository](https://github.com/bids-apps/example).
48+
A minimalist example of a BIDS App consisting of a Dockerfile
49+
and a simple entry point script (written in this case in Python)
50+
accepting the standard BIDS Apps command line arguments.
7851

79-
Generally, `participant` means individual level analysis (for instance: single
80-
subject) The group level analysis can be thought of as the second step, where
81-
the input becomes the output of the `participant` level analysis.
52+
#### Which container should I use to start building my app?
8253

83-
For example, generating statistic maps of each subject's brain could be
84-
considered `participant`, while generating the average of these maps across the
85-
dataset could be considered `group`.
54+
The only minimum requirements of a BIDS App's container is its ability to run your pipeline.
55+
So for example, if your App is mostly Python based it should be sufficient
56+
to start with any image that has Python and include your environment dependencies.
8657

87-
## What do we do if our application does not have any use for the group level analysis?
58+
### API
8859

89-
If your pipeline has no need for group level analysis, it is fine if it is only
90-
valid for the analysis_level argument (see
91-
[fmriprep](https://fmriprep.readthedocs.io/en/latest/usage.html))
92-
93-
## What should the API of my BIDS App look like?
60+
#### What should the API of my BIDS App look like?
9461

9562
The obligatory arguments of the API of any BIDS App are:
9663

@@ -104,20 +71,59 @@ with an API call that would look like this:
10471
app_name bids_dir output_dir analysis_level
10572
```
10673

107-
## When is a new image deposited to Docker Hub?
74+
#### What do we do if my application does not have any use for the group level analysis?
10875

109-
Even though Docker image is being build on the CI server each time
110-
you push a commit to the repository it is not automatically being pushed to Docker Hub.
111-
Only if you tag a commit, push the tag to GitHub,
112-
and the tests you configured pass a new image will be deposited in Docker Hub.
76+
If your pipeline has no need for group level analysis,
77+
it is fine if it is only valid for the analysis_level argument
78+
(see [fmriprep](https://fmriprep.readthedocs.io/en/latest/usage.html)).
11379

114-
## Where can I can data to test my app
80+
#### Can I add more arguments to the API of my App?
81+
82+
Every BIDS App must use the mandatory arguments mentioned above,
83+
but you are free to add more that are specific to the task your App will perform.
84+
85+
We recommend you follow the guidelines mentioned in the [BIDS apps specification](https://bids-standard.github.io/execution-spec/)
86+
for more information on specifying the API of your App.
87+
88+
### Testing
89+
90+
#### Where can I can get data to test my app?
11591

11692
For both lightweight and full datasets to test your BIDS App, you can choose
11793
from one of these
11894
[example datasets](https://bids-standard.github.io/bids-starter-kit/dataset_examples.html)
11995

120-
## Where should I describe changes between versions?
96+
#### Is it mandatory to first check the dataset validity using the BIDS-validator?
97+
98+
It is an extremely helpful feature to have validation of the dataset as part of your tool.
99+
However, it's not considered mandatory.
100+
For instance: many Apps will simply fail with an error message if the dataset is not BIDS compliant.
101+
102+
### Version
103+
104+
#### How should I version my BIDS App?
105+
106+
Since most BIDS Apps are just thin wrappers around existing pipelines it would
107+
be most sensible to use the same version as the software they are wrapping.
108+
109+
For example in case of HCP Pipelines this would be `v3.17.0`.
110+
111+
#### How to tag a new release?
112+
113+
```bash
114+
git tag v0.0.1
115+
git push
116+
```
117+
118+
#### I want to release a new version of a BIDS App, but the pipeline version is the same?
119+
120+
This can happen when only the runscript or the Dockerfile changed?
121+
According to semantic versioning we should use the `+` signed followed by the build number.
122+
Unfortunately Docker Hub does not support semantic versioning.
123+
The best option is to use the `-` sign followed by the build number.
124+
For example `v3.17.0-3`.
125+
126+
#### Where should I describe changes between versions?
121127

122128
After tagging a new release it is important to provide a list of changes
123129
on the GitHub Releases page.
@@ -126,13 +132,25 @@ It accepts markdown syntax and allows you to explain in detail what has changed.
126132

127133
Here's an [example](https://github.com/bids-apps/example/releases).
128134

129-
## Which container should I use to start building my app?
135+
### Deplopying
136+
137+
#### How do I upload my BIDS App to the BIDS App Github org?
130138

131-
The only minimum requirements of a BIDS App's container is its ability to run
132-
your pipeline. So for example, if your App is mostly Python based it should be
133-
sufficient to start with any image that has Python and include your environment
134-
dependencies.
139+
You can release BIDS Apps using your own or your lab's account.
140+
However, if you want to be added to the BIDS docker hub,
141+
please message the [BIDS maintainers](mailto:[email protected])
142+
to have a repo created for you.
143+
144+
If you base your code on <https://github.com/bids-apps/example> deployment
145+
on docker hub will happen automatically via Circle-ci.
135146

136-
<hr>
147+
If you want your App to show on the [BIDS website](https://bids-website.readthedocs.io/en/latest/tools/bids-apps.html),
148+
you will have to update the `data/tools/apps.yml` in the
149+
[BIDS website repository](https://github.com/bids-standard/bids-website/tree/main).
137150

138-
Generated by [FAQtory](https://github.com/willmcgugan/faqtory)
151+
#### When is a new image deposited to Docker Hub?
152+
153+
Even though Docker image is being build on the CI server each time
154+
you push a commit to the repository it is not automatically being pushed to Docker Hub.
155+
Only if you tag a commit, push the tag to GitHub,
156+
and the tests you configured pass a new image will be deposited in Docker Hub.

‎docs/faq/bids-extensions.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,3 @@ See
1717
[bids-specification issue #1177](https://github.com/bids-standard/bids-specification/issues/1177)
1818
for an example of the reasoning that led to the application of an entity
1919
previously used for functional data to anatomical MRI.
20-
21-
<hr>
22-
23-
Generated by [FAQtory](https://github.com/willmcgugan/faqtory)

‎docs/faq/eeg.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,3 @@ This is the case for Biosemi, as further documented on
3636
For a formatted example on how to deal with this in the BIDS context,
3737
please see this
3838
[template](https://github.com/bids-standard/bids-starter-kit/blob/main/templates/sub-01/ses-01/eeg/sub-01_ses-01_task-ReferenceExample_eeg.json).
39-
40-
<hr>
41-
42-
Generated by [FAQtory](https://github.com/willmcgugan/faqtory)

‎docs/faq/general.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,3 @@ page dedicated to this topic.
182182

183183
If you plan to put your dataset on [openneuro](https://openneuro.org/),
184184
you should use a CC0 or a PDDL license as explained in their [FAQ](https://openneuro.org/faq).
185-
186-
<hr>
187-
188-
Generated by [FAQtory](https://github.com/willmcgugan/faqtory)

‎docs/faq/mri.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,3 @@ Otherwise you can also use:
8989

9090
- [Fieldtrip](http://www.fieldtriptoolbox.org/faq/how_can_i_anonymize_an_anatomical_mri/) under matlab can do it.
9191
- SPM8 and SPM12: when in the batch editor go to: `SPM menu --> Util --> Deface`
92-
93-
<hr>
94-
95-
Generated by [FAQtory](https://github.com/willmcgugan/faqtory)

‎docs/faq/phenotype.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,3 @@ Yes, open this
1717
[epilepsyClassification2017](https://github.com/bids-standard/bids-starter-kit/blob/main/interactiveTreeVisualization/epilepsyClassification2017/tree.html)
1818
and follow the examples in the
1919
[phenotype templates](https://github.com/bids-standard/bids-starter-kit/tree/main/templates/phenotype).
20-
21-
<hr>
22-
23-
Generated by [FAQtory](https://github.com/willmcgugan/faqtory)

‎docs/impact/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ You can also find them [in the specification](https://bids-specification.readthe
7777
| statistical model | ![PyPI - Downloads](https://img.shields.io/pypi/dm/bsmschema) |
7878

7979
For the number of docker pulls of the BIDS apps, please check the
80-
[BIDS app dashboard](https://bids-apps.neuroimaging.io/apps/).
80+
[BIDS app dashboard](https://bids-website.readthedocs.io/en/latest/tools/bids-apps.html).
8181

8282
### Contributors
8383

0 commit comments

Comments
 (0)