@@ -9,37 +9,46 @@ implement scientific workflows that use a mix of shell commands and Python funct
99Pydra is developed as an open-source project in the neuroimaging community,
1010but it is designed as a general-purpose dataflow engine to support any scientific domain.
1111
12- See the :ref: `Design philosophy ` for more an explanation of the design
13- philosophy and goals of Pydra.
12+ See :ref: `Design philosophy ` for more an explanation of the design of Pydra.
1413
1514Installation
1615------------
1716
1817Pydra itself is a pure-Python package, which has only a handful of dependencies,
19- therefore, it is straightforward to install via pip
18+ therefore, it is straightforward to install via pip for Python >= 3.11
2019
2120.. code-block :: bash
2221
2322 $ pip install pydra
2423
25- Of course, if you use Pydra to execute shell-commands tools, you will need to either have
26- those commands installed on the execution machine, or use software containers
27- (e.g., Docker or Singularity) to run them.
24+ Pre-designed tasks are available under the `pydra.tasks.* ` package namespace. These tasks
25+ are implemented within separate packages that are typically specific to a given shell-command toolkit such as FSL _, AFNI _ or ANTs _,
26+ or a collection of related tasks/workflows (e.g. `niworkflows `_). Pip can be used to
27+ install these packages as well:
28+
29+
30+ .. code-block :: bash
31+
32+ $ pip install pydra-fsl pydra-ants
33+
34+ Of course, if you use Pydra to execute commands within toolkits, you will need to
35+ either have those commands installed on the execution machine, or use containers
36+ environments (see [Environments](../explanation/environments.html)) to run them.
2837
2938
3039Tutorials
3140---------
3241
3342* :ref: `Getting started `
34- * :ref: `Execution options `
43+ * :ref: `Advanced execution `
3544* :ref: `Python-tasks `
3645* :ref: `Shell-tasks `
3746* :ref: `Workflows `
3847
3948Examples
4049--------
4150
42- * :ref: `Real-world example `
51+ * :ref: `T1w MRI preprocessing `
4352
4453How-to Guides
4554-------------
@@ -55,6 +64,7 @@ Indices and tables
5564
5665.. toctree ::
5766 :maxdepth: 2
67+ :caption: Execution
5868 :hidden:
5969
6070 tutorial/getting-started
@@ -75,7 +85,7 @@ Indices and tables
7585 :caption: Examples
7686 :hidden:
7787
78- examples/real-example
88+ examples/t1w-preprocess
7989
8090.. toctree ::
8191 :maxdepth: 2
@@ -92,10 +102,10 @@ Indices and tables
92102
93103 explanation/design-approach
94104 explanation/splitting-combining
105+ explanation/conditional-lazy
95106 explanation/typing
96107 explanation/hashing-caching
97- explanation/conditional-lazy
98- explanation/provenance
108+ explanation/environments
99109
100110
101111.. toctree ::
@@ -104,3 +114,8 @@ Indices and tables
104114 :hidden:
105115
106116 reference/api
117+
118+ .. _FSL : https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FSL
119+ .. _ANTs : http://stnava.github.io/ANTs/
120+ .. _AFNI : https://afni.nimh.nih.gov/
121+ .. _niworkflows : https://niworkflows.readthedocs.io/en/latest/
0 commit comments