Skip to content

Commit 03546ed

Browse files
committed
more restructuring of new docs
1 parent 6f1c8e3 commit 03546ed

File tree

5 files changed

+46
-20
lines changed

5 files changed

+46
-20
lines changed

new-docs/source/examples/real-example.ipynb renamed to new-docs/source/examples/t1w-preprocess.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Real-world example"
7+
"# T1w MRI preprocessing"
88
]
99
},
1010
{
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Containers and environments
2+
===========================
3+
4+
Work in progress...

new-docs/source/explanation/provenance.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

new-docs/source/index.rst

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,37 +9,46 @@ implement scientific workflows that use a mix of shell commands and Python funct
99
Pydra is developed as an open-source project in the neuroimaging community,
1010
but 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

1514
Installation
1615
------------
1716

1817
Pydra 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

3039
Tutorials
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

3948
Examples
4049
--------
4150

42-
* :ref:`Real-world example`
51+
* :ref:`T1w MRI preprocessing`
4352

4453
How-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/

new-docs/source/tutorial/advanced-execution.ipynb

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,39 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Execution options"
7+
"# Advanced execution"
88
]
99
},
1010
{
1111
"cell_type": "markdown",
1212
"metadata": {},
1313
"source": [
14-
"## Execution plugins"
14+
"## Plugins"
1515
]
1616
},
1717
{
1818
"cell_type": "markdown",
1919
"metadata": {},
2020
"source": [
21-
"## Cache locations"
21+
"## Caching results\n",
22+
"\n",
23+
"See [Caching and hashing](../explanation/hashing-caching.html) for more details."
2224
]
2325
},
2426
{
2527
"cell_type": "markdown",
2628
"metadata": {},
2729
"source": [
28-
"## Environments"
30+
"## Environments (containers)\n",
31+
"\n",
32+
"See [Containers and Environments](../explanation/environments.rst) for more details."
33+
]
34+
},
35+
{
36+
"cell_type": "markdown",
37+
"metadata": {},
38+
"source": [
39+
"## Provenance"
2940
]
3041
},
3142
{

0 commit comments

Comments
 (0)