Skip to content

Commit

Permalink
doc: minor fixes to fMRIprep singularity example
Browse files Browse the repository at this point in the history
  • Loading branch information
m-wierzba committed Oct 22, 2024
1 parent 2edad31 commit 64ed693
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
4 changes: 2 additions & 2 deletions examples/fmriprep-singularity/fmriprep-singularity
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@
# the lists: `input.txt`, `output.txt`, and `parameter.txt` to keep the command
# line short.
#
# `datalad compute -I input.txt -O output.txt -P parameter.txt fmriprep-singularity`
# `datalad make -I input.txt -O output.txt -P parameter.txt fmriprep-singularity`

inputs = ['container', 'input_dir', 'output_dir', 'participant_label', 'license_file']

use_shell = 'false'
executable = 'singularity'

# Note: `{root_directory}` resolves to the directory of the dataset in which the
# computation was started with `datalad compute`.
# computation was started with `datalad make`.

arguments = [
'run', '{container}',
Expand Down
8 changes: 5 additions & 3 deletions examples/fmriprep-singularity/fmriprep-singularity.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ The example comprises the following files:

This example requires Singularity.

Please note, that there is no need to install fMRIprep. The singularity container will be automatically retrieved from the ReproNim containers collection. However, in order to use fMRIprep you need to obtain a [FreeSurfer license](https://surfer.nmr.mgh.harvard.edu/fswiki/License).

Please also note that fMRIprep is invoked with the option `--sloppy`. This is done to reduce the runtime. For reproducible results, please run fMRIprep without the option `--sloppy`.
Please note, that there is no need to install fMRIprep. The singularity container will be automatically retrieved from the ReproNim containers collection. However, in order to use fMRIprep you need to obtain a [FreeSurfer license](https://surfer.nmr.mgh.harvard.edu/fswiki/License).

It is assumed that the license file is located in `/tmp`. Make sure to copy it there or modify the `parameter.txt` file accordingly (see the [Add template](#add-template) section below).

Expand Down Expand Up @@ -103,3 +101,7 @@ You can also do that in `debug` mode:
```bash
> datalad -l debug make -I input.txt -O output.txt -P parameter.txt fmriprep-singularity
```

### Final note

In this example fMRIprep is invoked with the option `--sloppy` to reduce the runtime. For reproducible results, run fMRIprep without `--sloppy`.
2 changes: 1 addition & 1 deletion examples/fmriprep-singularity/input.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Paths are relative to the dataset in which `datalad compute` was executed
# Paths are relative to the dataset in which `datalad make` was executed
data/ds000102/dataset_description.json
data/ds000102/participants.tsv
data/ds000102/T1w.json
Expand Down
2 changes: 1 addition & 1 deletion examples/fmriprep-singularity/output.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Paths are relative to the dataset in which `datalad compute` was executed
# Paths are relative to the dataset in which `datalad make` was executed
derivatives/ds000102/**

0 comments on commit 64ed693

Please sign in to comment.