Skip to content

Commit 5b4bcd7

Browse files
committed
Merge pull request #1080 from Leoniela/test
WIP_adding_glossary_to_tutorial
2 parents 6d08709 + ea204f4 commit 5b4bcd7

File tree

2 files changed

+33
-4
lines changed

2 files changed

+33
-4
lines changed

doc/quickstart.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,13 @@ Developer guides
5050
devel/gitwash/index
5151

5252
.. include:: links_names.txt
53+
54+
Useful links for beginners
55+
===========================
56+
57+
Getting started with Python - Tutorials. `Available here`__
58+
59+
Python for Beginners `Available here`__
60+
61+
__ http://www.codecademy.com/en/tracks/python
62+
__ https://www.python.org/about/gettingstarted/

doc/users/tutorial_101.rst

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,15 +99,15 @@ This results in a workflow containing two isolated nodes:
9999

100100
**5. Connecting nodes to each other**
101101

102-
We want to connect the output produced by realignment to the input of
103-
smoothing. This is done as follows.
102+
We want to connect the output produced by the node realignment to the input of
103+
the node smoothing. This is done as follows.
104104

105105
.. testcode::
106106

107107
workflow.connect(realigner, 'realigned_files', smoother, 'in_files')
108108

109-
or alternatively, a more flexible notation can be used. Although not shown here,
110-
the following notation can be used to connect multiple outputs from one node to
109+
110+
Although not shown here, the following notation can be used to connect multiple outputs from one node to
111111
multiple inputs (see step 7 below).
112112

113113
.. testcode::
@@ -189,3 +189,22 @@ inside which are three folders: realign, smooth and artdetect (the names
189189
of the nodes). The outputs of these routines are in these folders.
190190

191191
.. include:: ../links_names.txt
192+
193+
.. glossary::
194+
195+
pipeline
196+
Connected series of processes (processes can be run parallel and or sequential)
197+
198+
workflow
199+
(kind of synonymous to pipeline) = hosting the nodes
200+
201+
node
202+
= switching-point within a pipeline, you can give it a name (in the above example e.g. realigner),
203+
a node usually requires an or several inputs and will produce an or several outputs
204+
205+
interface
206+
= specific software (e.g. FSL, SPM ...) are wrapped in interfaces, within a node instances of an
207+
interface can be run
208+
209+
modules
210+
for each interface the according modules have to be imported in the usual pythonic manner

0 commit comments

Comments
 (0)