Skip to content

Commit e125342

Browse files
authored
📝 Document cpac extras (gradients and tsconcat) (#311)
2 parents 2c84e44 + 75b8317 commit e125342

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

.circleci/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ commands:
3636
deactivate
3737
python -m venv /home/circleci/simple
3838
source /home/circleci/simple/bin/activate
39-
pip install git+https://github.com/FCP-INDI/cpac.git@81c33b52d72478bef54ccfdce05577d52ebf714c semver
39+
pip install cpac semver
4040
deactivate
4141
4242
run-cpac-commands:

docs/_sources/user/cpac.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,26 @@ 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-
cpac requires Python 3.6 or greater. To get cpac, simply
6+
``cpac`` requires Python 3.8 or greater. To get cpac, simply
77

88
.. code-block:: console
99
1010
pip install cpac
1111
12+
Run extra packages with cpac
13+
````````````````````````````
14+
Beginning with v1.8.5, ``cpac`` can run |ba_timeseries_gradients|_ and/or |tsconcat|_ in addition to C-PAC. If either package is already installed, ``cpac`` will use the installed version. You can install them with the relevant extras, like one of the following lines:
15+
16+
.. code-block:: console
17+
18+
pip install cpac[ba_timeseries_gradients]
19+
pip install cpac[tsconcat]
20+
pip install cpac[ba_timeseries_gradients,tsconcat]
21+
22+
.. note::
23+
24+
``ba_timeseries_gradients`` and ``tsconcat`` may have more specific dependency requirements than C-PAC. If you run into unclear installation issues when installing these extras, please see the documentation for those packages.
25+
1226
Download / Upgrade C-PAC with cpac
1327
``````````````````````````````````
1428

@@ -117,4 +131,13 @@ Note that any of the optional arguments above will over-ride any pipeline settin
117131
* 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.
118132

119133
* If you want to pass runtime options to your container plaform (Docker or Singularity), you can pass them with ``-o`` or ``--container_options``.
134+
120135
.. TODO: Update cpac to handle `-`s and `_`s like C-PAC
136+
137+
.. |ba_timeseries_gradients| replace:: ``ba_timeseries_gradients``
138+
139+
.. _ba_timeseries_gradients: https://cmi-dair.github.io/ba-timeseries-gradients/ba_timeseries_gradients.html
140+
141+
.. |tsconcat| replace:: ``tsconcat``
142+
143+
.. _tsconcat: https://cmi-dair.github.io/tsconcat/tsconcat.html

0 commit comments

Comments
 (0)