@@ -96,7 +96,7 @@ Where ``<version>`` should be replaced with the desired version of fMRIPrep that
96
96
Preparing a Singularity image (Singularity version < 2.5)
97
97
---------------------------------------------------------
98
98
In this case, start with a machine (e.g., your personal computer) with Docker installed.
99
- Use `docker2singularity <https://github.com/singularityware/docker2singularity >`_ to
99
+ Use `docker2singularity <https://github.com/singularityware/docker2singularity >`_ to
100
100
create a singularity image.
101
101
You will need an active internet connection and some time. ::
102
102
@@ -106,7 +106,7 @@ You will need an active internet connection and some time. ::
106
106
singularityware/docker2singularity \
107
107
poldracklab/fmriprep:<version>
108
108
109
- Where ``<version> `` should be replaced with the desired version of fMRIPrep that you want
109
+ Where ``<version> `` should be replaced with the desired version of fMRIPrep that you want
110
110
to download.
111
111
112
112
Beware of the back slashes, expected for Windows systems.
@@ -135,11 +135,11 @@ If the data to be preprocessed is also on the HPC, you are ready to run fmriprep
135
135
136
136
.. note ::
137
137
138
- Singularity by default `exposes all environment variables from the host inside
138
+ Singularity by default `exposes all environment variables from the host inside
139
139
the container <https://github.com/singularityware/singularity/issues/445> `_.
140
- Because of this your host libraries (such as nipype) could be accidentally used
140
+ Because of this your host libraries (such as nipype) could be accidentally used
141
141
instead of the ones inside the container - if they are included in ``PYTHONPATH ``.
142
- To avoid such situation we recommend using the ``--cleanenv `` singularity flag
142
+ To avoid such situation we recommend using the ``--cleanenv `` singularity flag
143
143
in production use. For example: ::
144
144
145
145
$ singularity run --cleanenv ~/poldracklab_fmriprep_latest-2016-12-04-5b74ad9a4c4d.img \
@@ -160,9 +160,9 @@ If the data to be preprocessed is also on the HPC, you are ready to run fmriprep
160
160
161
161
.. note ::
162
162
163
- Depending on how Singularity is configured on your cluster it might or might not
164
- automatically bind (mount or expose) host folders to the container.
165
- If this is not done automatically you will need to bind the necessary folders using
163
+ Depending on how Singularity is configured on your cluster it might or might not
164
+ automatically bind (mount or expose) host folders to the container.
165
+ If this is not done automatically you will need to bind the necessary folders using
166
166
the ``-B <host_folder>:<container_folder> `` Singularity argument.
167
167
For example: ::
168
168
@@ -177,7 +177,7 @@ Manually Prepared Environment (Python 3.5+)
177
177
178
178
.. warning ::
179
179
180
- This method is not recommended! Make sure you would rather do this than
180
+ This method is not recommended! Make sure you would rather do this than
181
181
use a `Docker Container `_ or a `Singularity Container `_.
182
182
183
183
Make sure all of fmriprep's `External Dependencies `_ are installed.
@@ -226,10 +226,10 @@ FMRIPREP uses FreeSurfer tools, which require a license to run.
226
226
To obtain a FreeSurfer license, simply register for free at
227
227
https://surfer.nmr.mgh.harvard.edu/registration.html.
228
228
229
- When using manually-prepared environments or singularity, FreeSurfer will search
230
- for a license key file first using the ``$FS_LICENSE `` environment variable and then
231
- in the default path to the license key file (``$FREESURFER_HOME/license.txt ``).
232
- If using the ``--cleanenv `` flag and ``$FS_LICENSE `` is set, use ``--fs-license-file $FS_LICENSE ``
229
+ When using manually-prepared environments or singularity, FreeSurfer will search
230
+ for a license key file first using the ``$FS_LICENSE `` environment variable and then
231
+ in the default path to the license key file (``$FREESURFER_HOME/license.txt ``).
232
+ If using the ``--cleanenv `` flag and ``$FS_LICENSE `` is set, use ``--fs-license-file $FS_LICENSE ``
233
233
to pass the license file location to fMRIPrep.
234
234
235
235
It is possible to run the docker container pointing the image to a local path
0 commit comments