Skip to content

Commit 65702c3

Browse files
committed
DOC: Add wrapper usage
1 parent 39ea7b8 commit 65702c3

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,27 @@ NiBabies specific options:
317317

318318
</details>
319319

320+
321+
#### Running with ``nibabies-wrapper``
322+
323+
The ``nibabies-wrapper`` is a lightweight Python 2/3 wrapper for running *NiBabies* via Docker and Singularity.
324+
It will generate a Docker/Singularity command line for you, print it out for reporting purposes, and then execute it without further action needed, e.g.:
325+
326+
327+
##### Docker
328+
```
329+
$ nibabies-wrapper docker /path/to/data /path/to/output participant --age-months 12
330+
RUNNING: docker run --rm -e DOCKER_VERSION_8395080871=20.10.6 -it -v /path/to/data:/data:ro \
331+
-v /path/to/output:/out nipreps/nibabies:0.1.1 /data /out participant --age-months 12
332+
```
333+
334+
##### Singularity
335+
```
336+
$ nibabies-wrapper singularity /path/to/data /path/to/output participant --age-months 12 -i nibabies-0.1.1.sif
337+
RUNNING: singularity run --cleanenv -B /path/to/data:/data:ro \
338+
-B /path/to/output:/out nibabies-0.1.1.sif /data /out participant --age-months 12
339+
```
340+
320341
### Outputs
321342

322343
TODO - Refer to [fMRIPrep's outputs](https://fmriprep.org/en/20.2.1/outputs.html) for now.

0 commit comments

Comments
 (0)