Skip to content

Commit fbdb320

Browse files
authored
how to run via apptainer
1 parent 4db49fd commit fbdb320

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

docs/installation.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ Therefore, once specified the container options and the image to be run
3232
the command line is the same as for the *bare-metal* installation but dropping
3333
the ``petprep`` executable name.
3434

35-
Containerized execution (Docker and Singularity)
35+
Containerized execution (Docker and Apptainer)
3636
================================================
3737
*PETPrep* is a *NiPreps* application, and therefore follows some overarching principles
3838
of containerized execution drawn from the BIDS-Apps protocols.
3939
For detailed information of containerized execution of *NiPreps*, please visit the corresponding
4040
`Docker <https://www.nipreps.org/apps/docker/>`__
41-
or `Singularity <https://www.nipreps.org/apps/singularity/>`__ subsections.
41+
or `Apptainer / Singularity <https://www.nipreps.org/apps/singularity/>`__ subsections.
4242
The *NiPreps* portal also contains
4343
`extended details of execution with the Docker wrapper <https://www.nipreps.org/apps/docker/#running-a-niprep-with-a-lightweight-wrapper>`__.
4444

@@ -51,6 +51,25 @@ Then run the ``petprep-docker`` command-line as if you were running
5151

5252
$ petprep-docker <input_bids_path> <derivatives_path> <analysis_level> <named_options>
5353

54+
Alternatively, you can install using a pre-built image using::
55+
56+
$ docker pull ghcr.io/nipreps/petprep:main
57+
58+
or::
59+
60+
$ apptainer build petprep.sif docker ://ghcr.io/nipreps/petprep:main
61+
62+
Then run petprep via apptainer as follows::
63+
64+
$ apptainer run \
65+
--bind /path_to_data:/data:ro \
66+
--bind /path_to_output:/out \
67+
--bind /path_to_freesurfer/license.txt:/license \
68+
/path_to_sif/petprep.sif /data /out participant or group \
69+
--participant-label sub-ID \
70+
--fs-license-file /license \
71+
--work-dir /out/work
72+
5473

5574
Manually Prepared Environment (Python 3.10+)
5675
============================================

0 commit comments

Comments
 (0)