Skip to content

Commit 21efc15

Browse files
vferatoesteban
authored andcommitted
Add a HPC troubleshooting section
1 parent 9c784c9 commit 21efc15

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

docs/source/usage.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,53 @@ on ds030 of OpenfMRI:
140140
the 1-task example, a rule of thumb may be that each task takes around
141141
1GB of memory.
142142

143+
Known issues with HPC
144+
.....................
145+
146+
#. No internet access
147+
148+
The container needs to download the templates from the internet.
149+
If the container does not have internet access, you can download the
150+
templates manually using the templateflow library:
151+
152+
.. code-block:: python
153+
154+
import templateflow.api
155+
templateflow.api.TF_S3_ROOT = 'http://templateflow.s3.amazonaws.com'
156+
templateflow.api.get('MNI152NLin2009cAsym') # change template if needed
157+
158+
159+
then provide the templates to the container by mounting the ``TEMPLATEFLOW_HOME`` folder and setting the ``TEMPLATEFLOW_HOME`` environment variable:
160+
161+
.. code-block:: bash
162+
163+
apptainer run -v /path/to/templates:/path/to/templateflow --env TEMPLATEFLOW_HOME=/path/to/templateflow ...
164+
165+
#. Socket error:
166+
167+
When running multiple instances of MRIQC on HPC, you may encounter the following error:
168+
169+
.. code-block:: python
170+
171+
OSError: [Errno 98] Address already in use
172+
173+
To solve this issue, you can try to isolate the container network from the host network by using the ``--network none`` option.
174+
175+
.. code-block:: bash
176+
177+
apptainer run --net --network none ...
178+
179+
This solution might prevent the container from accessing the internet and downloading templates.
180+
In this case, you can download the templates manually and mount provide access to the templates as explained in the previous section.
181+
182+
.. code-block:: bash
183+
184+
apptainer run --net --network none -v /path/to/templates:/path/to/templateflow --env TEMPLATEFLOW_HOME=/path/to/templateflow ...
185+
186+
187+
188+
189+
143190
.. topic:: References
144191

145192
.. [BIDS] `Brain Imaging Data Structure <http://bids.neuroimaging.io/>`_

0 commit comments

Comments
 (0)