Skip to content

WIP_adding_glossary_to_tutorial #1080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 1, 2015
Merged

WIP_adding_glossary_to_tutorial #1080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
312b96c
fixed typo
Leoniela Apr 9, 2015
16edac5
update
Leoniela Apr 9, 2015
7efc818
Update quickstart.rst
Leoniela Apr 9, 2015
b48d2c3
update
Leoniela Apr 9, 2015
ea204f4
Adding glossary, some other changes
Leoniela Apr 10, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion doc/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Downloading and installing
Beginner's guide
================

Beginner's tutorials (IPython Notebooks). `Availible here`__
Beginner's tutorials (IPython Notebooks). `Available here`__

Michael Notter's Nipype guide. `Available here`__

Expand Down Expand Up @@ -50,3 +50,13 @@ Developer guides
devel/gitwash/index

.. include:: links_names.txt

Useful links for beginners
===========================

Getting started with Python - Tutorials. `Available here`__

Python for Beginners `Available here`__

__ http://www.codecademy.com/en/tracks/python
__ https://www.python.org/about/gettingstarted/
27 changes: 23 additions & 4 deletions doc/users/tutorial_101.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,15 @@ This results in a workflow containing two isolated nodes:

**5. Connecting nodes to each other**

We want to connect the output produced by realignment to the input of
smoothing. This is done as follows.
We want to connect the output produced by the node realignment to the input of
the node smoothing. This is done as follows.

.. testcode::

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

or alternatively, a more flexible notation can be used. Although not shown here,
the following notation can be used to connect multiple outputs from one node to

Although not shown here, the following notation can be used to connect multiple outputs from one node to
multiple inputs (see step 7 below).

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

.. include:: ../links_names.txt

.. glossary::

pipeline
Connected series of processes (processes can be run parallel and or sequential)

workflow
(kind of synonymous to pipeline) = hosting the nodes

node
= switching-point within a pipeline, you can give it a name (in the above example e.g. realigner),
a node usually requires an or several inputs and will produce an or several outputs

interface
= specific software (e.g. FSL, SPM ...) are wrapped in interfaces, within a node instances of an
interface can be run

modules
for each interface the according modules have to be imported in the usual pythonic manner