Skip to content

Commit 2ac49d3

Browse files
committed
🔀 Merge docs/cpac-pull into docs/nested-config
2 parents d293760 + f283506 commit 2ac49d3

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

docs/_sources/user/cpac.rst

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,39 @@ cpac requires Python 3.6 or greater. To get cpac, simply
1313
1414
pip install cpac
1515
16-
As a quick example, in order to run C-PAC in participant mode, for one participant, using a BIDS dataset stored on your machine or server, and using the container image's default pipeline configuration:
16+
Download / Upgrade C-PAC with cpac
17+
``````````````````````````````````
18+
19+
To download or upgrade a particular C-PAC image,
20+
21+
.. code-block:: console
22+
23+
cpac pull
24+
25+
or
26+
27+
.. code-block:: console
28+
29+
cpac upgrade
30+
31+
When downloading/upgrading, the ``--platform``, ``--image``, and ``--tag`` let you specify platform (Docker or Singularity), image (Docker image name or URL to image in repository), and tag (version tag, currently only for Docker repositories), respectively.
32+
33+
For example, a development Docker image can be downloaded with
34+
35+
.. code-block:: console
36+
37+
cpac --platform docker --tag nightly pull
38+
39+
Or a Singularity image built from that Docker image can be downloaded with
40+
41+
.. code-block:: console
42+
43+
cpac --platform singularity --tag nightly pull
44+
45+
Run C-PAC with cpac
46+
```````````````````
47+
48+
To run C-PAC in participant mode for one participant, using a BIDS dataset stored on your machine or server and using the container image's default pipeline configuration:
1749

1850
.. code-block:: console
1951

0 commit comments

Comments
 (0)