You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/_sources/user/cpac.rst
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,9 @@ cpac (Python package)
3
3
4
4
`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.
5
5
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.
7
9
8
10
cpac requires Python 3.6 or greater. To get cpac, simply
9
11
@@ -17,7 +19,7 @@ As a quick example, in order to run C-PAC in participant mode, for one participa
17
19
18
20
cpac run /Users/You/local_bids_data /Users/You/some_folder_for_outputs participant
19
21
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.
21
23
22
24
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:
23
25
@@ -84,4 +86,8 @@ Note that any of the optional arguments above will over-ride any pipeline settin
84
86
85
87
* 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.
86
88
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