Skip to content

Commit 8bbdfdf

Browse files
committed
📝 Clarify Singularity restriction
1 parent 25ac48f commit 8bbdfdf

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/_sources/user/cpac.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ cpac (Python package)
33

44
`cpac <https://pypi.org/project/cpac/>`_ is available so that you can easily run analyses without needing interact with the container platform that allows you to run C-PAC without installing all of the underlying software.
55

6-
Currently the cpac supports Singularity (version ≥ 2.5 ≤ 3.0) and Docker.
6+
.. note::
7+
8+
Currently the cpac wrapper supports Singularity (version ≥ 2.5 < 3.0) [*]_ and Docker.
79

810
cpac requires Python 3.6 or greater. To get cpac, simply
911

@@ -17,7 +19,7 @@ As a quick example, in order to run C-PAC in participant mode, for one participa
1719
1820
cpac run /Users/You/local_bids_data /Users/You/some_folder_for_outputs participant
1921
20-
By default, the cpac will try Docker first and fall back to Singularity if Docker fails. If both fail, an exception is raised.
22+
By default, cpac (the wrapper) will try Docker first and fall back to Singularity if Docker fails. If both fail, an exception is raised.
2123

2224
You can specify a platform with the ``--platform docker`` or ``--platform singularity``. If you specify a platform without specifying an image, these are the defaults, using the first successfully found image:
2325

@@ -84,4 +86,8 @@ Note that any of the optional arguments above will over-ride any pipeline settin
8486

8587
* The ``participant_label`` and ``participant_ndx`` arguments allow the user to specify which of the many datasets should be processed, which is useful when parallelizing the run of multiple participants.
8688

87-
* If you want to pass runtime options to your container plaform (Docker or Singularity), you can pass them with ``-o`` or ``--container_options``.
89+
* If you want to pass runtime options to your container plaform (Docker or Singularity), you can pass them with ``-o`` or ``--container_options``.
90+
91+
.. rubric:: Footnotes
92+
93+
.. [*] The version restrictions for Singularity are specific to cpac the convenience wrapper. C-PAC itself should :doc:`run on Singularity <singularity>` 2 or 3.

0 commit comments

Comments
 (0)