Skip to content

Commit 18d21cc

Browse files
committed
enh: added new questions to FAQ as suggested by @emdupre in #1778 (comment)
1 parent 2ef6980 commit 18d21cc

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

docs/faq.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ FAQ, Tips, and Tricks
66

77
Should I run quality control of my images before running *fMRIPrep*?
88
--------------------------------------------------------------------
9-
109
Yes. You should do so before any processing/analysis takes place.
1110

1211
Oftentimes (more often than we would like), images have fatal artifacts and problems.
@@ -27,7 +26,6 @@ some kind of preprocessing (see next question).
2726

2827
What if I find some images have undergone some pre-processing already (e.g., my T1w image is already skull-stripped)?
2928
---------------------------------------------------------------------------------------------------------------------
30-
3129
These images imply an unknown level of preprocessing (e.g. was it already bias-field corrected?),
3230
which makes it difficult to decide on best-practices for further processing.
3331
Hence, supporting such images was considered very low priority for *fMRIPrep*.
@@ -40,7 +38,6 @@ reverting to the original, defaced, T1w images to ensure more uniform preprocess
4038

4139
My *fMRIPrep* run is hanging...
4240
-------------------------------
43-
4441
When running on Linux platforms (or containerized environments, because they are built around
4542
Ubuntu), there is a Python bug that affects *fMRIPrep* that drives the Linux kernel to kill
4643
processes as a response to running out of memory.
@@ -62,7 +59,6 @@ Additionally, consider using the ``--low-mem`` flag, which will make some memory
6259

6360
ERROR: it appears that ``recon-all`` is already running
6461
-------------------------------------------------------
65-
6662
When running FreeSurfer_'s ``recon-all``, an error may say *it appears it is already running*.
6763
FreeSurfer creates files (called ``IsRunning.{rh,lh,lh+rh}``, under the ``scripts/`` folder)
6864
to determine whether it is already executing ``recon-all`` on that particular subject
@@ -117,7 +113,6 @@ In general, please be cautious of deleting files and mindful why a file may exis
117113

118114
Running subjects in parallel
119115
----------------------------
120-
121116
When running several subjects in parallel, and depending on your settings, fMRIPrep may
122117
fall into race conditions.
123118
A symptomatic output looks like: ::
@@ -155,7 +150,6 @@ number of CPUs divided by the number of subjects is most efficient.
155150

156151
A new version of *fMRIPrep* has been published, when should I upgrade?
157152
----------------------------------------------------------------------
158-
159153
We follow a philosophy of releasing very often, although the pace is slowing down
160154
with the maturation of the software.
161155
It is very likely that your version gets outdated over the extent of your study.
@@ -169,3 +163,16 @@ using the latest version of the tool.
169163
In any case, if you can find your release listed as *flagged* in `this file
170164
of our repo <https://github.com/poldracklab/fmriprep/blob/master/.versions.json>`__,
171165
then please update as soon as possible.
166+
167+
What is *TemplateFlow* for?
168+
---------------------------
169+
*TemplateFlow* enables *fMRIPrep* to generate preprocessed outputs spatially normalized to
170+
a number of different neuroimaging templates (e.g. MNI).
171+
For further details, please check `its documentation section <spaces.html#templateflow>`__.
172+
173+
I'm running *fMRIPrep* via Singularity containers - how can I troubleshoot problems?
174+
------------------------------------------------------------------------------------
175+
We have extended `this documentation <singularity.html>`__ to cover some of the most
176+
frequent issues other Singularity users have been faced with.
177+
Generally, users have found it hard to `get TemplateFlow and Singularity to work
178+
together <singularity.html#singularity-tf>`__.

0 commit comments

Comments
 (0)