Skip to content

Commit bbac8d5

Browse files
authored
Merge pull request miykael#112 from miykael/grammar_correction
ENH: corrects grammar in files [skip ci]
2 parents 07a1694 + 0d59d8f commit bbac8d5

40 files changed

+257
-266
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
This is the Nipype Tutorial in Jupyter Notebook format. You can access the tutorial in two ways:
1313

1414
1. [Nipype Tutorial Homepage](https://miykael.github.io/nipype_tutorial/): This website contains a static, read-only version of all the notebooks.
15-
2. [Nipype Tutorial Docker Image](https://miykael.github.io/nipype_tutorial/notebooks/introduction_docker.html): This guide explains how to use docker to run the notebooks interactively on your own computer. The nipype tutorial docker image is the best interactive way to learn Nipype.
15+
2. [Nipype Tutorial Docker Image](https://miykael.github.io/nipype_tutorial/notebooks/introduction_docker.html): This guide explains how to use Docker to run the notebooks interactively on your own computer. The nipype tutorial docker image is the best interactive way to learn Nipype.
1616

1717

1818
# Feedback, Help & Support
1919

20-
If you want to help with this tutorial or have any questions, fell free to fork the repo of the [Notebooks](https://github.com/miykael/nipype_tutorial) or interact with other contributors on the slack channel [brainhack.slack.com/messages/nipype/](https://brainhack.slack.com/messages/nipype/). If you have any questions or found a problem, open a new [issue on github](https://github.com/miykael/nipype_tutorial/issues).
20+
If you want to help with this tutorial or have any questions, feel free to fork the repo of the [Notebooks](https://github.com/miykael/nipype_tutorial) or interact with other contributors on the slack channel [brainhack.slack.com/messages/nipype/](https://brainhack.slack.com/messages/nipype/). If you have any questions or found a problem, open a new [issue on github](https://github.com/miykael/nipype_tutorial/issues).
2121

2222

2323
# Thanks and Acknowledgment

index.ipynb

Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"cells": [
33
{
44
"cell_type": "code",
5-
"execution_count": null,
5+
"execution_count": 1,
66
"metadata": {
77
"scrolled": false
88
},
@@ -24,8 +24,8 @@
2424
" you everything so that you can start creating your own workflows in no time. We recommend that you start with\n",
2525
" the introduction section to familiarize yourself with the tools used in this tutorial and then move on to the\n",
2626
" basic concepts section to learn everything you need to know for your everyday life with Nipype. The workflow\n",
27-
" examples section shows you a real example how you can use Nipype to analyze an actual dataset. For a very \n",
28-
" quick non-imaging introduction, you can check the Nipype Quickstart notebooks in the introduciton section.\n",
27+
" examples section shows you a real example of how you can use Nipype to analyze an actual dataset. For a very \n",
28+
" quick non-imaging introduction, you can check the Nipype Quickstart notebooks in the introduction section.\n",
2929
" </p><p>\n",
3030
" All of the notebooks used in this tutorial can be found on <a href=\"https://github.com/miykael/nipype_tutorial\">github.com/miykael/nipype_tutorial</a>.\n",
3131
" But if you want to have the real experience and want to go through the computations by yourself, we highly\n",
@@ -39,9 +39,9 @@
3939
" with working Python 3 software (including Nipype, dipy, matplotlib, nibabel, nipy, numpy, pandas, scipy, seaborn and more),\n",
4040
" FSL, ANTs and SPM12 (no license needed). We used <a href=\"https://github.com/kaczmarj/neurodocker\">Neurodocker</a> to create this docker image.\n",
4141
" </p><p>\n",
42-
" If you do not want to run tutorial locally, you can also use \n",
42+
" If you do not want to run the tutorial locally, you can also use \n",
4343
" <a href=\"https://mybinder.org/v2/gh/miykael/nipype_tutorial/master\">Binder service</a>. \n",
44-
" Binder automatically launch the Docker container for you and you have access to all of the notebooks. \n",
44+
" Binder automatically launches the Docker container for you and you have access to all of the notebooks. \n",
4545
" Note, that Binder provides between 1G and 4G RAM memory, some notebooks from Workflow Examples might not work. \n",
4646
" All notebooks from Introduction and Basic Concepts parts should work.\n",
4747
" </p><p>\n",
@@ -70,7 +70,7 @@
7070
" <a class=\"subject-link pure-u-1-4\" target=\"_blank\" href=\"notebooks/introduction_quickstart_non-neuroimaging.ipynb\">Nipype Quickstart (non-neuroimaging examples)</a>\n",
7171
" </div>\n",
7272
" <p>This section is meant as a general overview. It should give you a short introduction to the main topics that\n",
73-
" you need to understand to use Nipype and this tutorial. The section also contains a very short neuroimaging showcase, as well as as quick non-imaging introduction to Nipype workflows.</p>\n",
73+
" you need to understand to use Nipype and this tutorial. The section also contains a very short neuroimaging showcase, as well as quick non-imaging introduction to Nipype workflows.</p>\n",
7474
"\n",
7575
" <h2 class=\"domain-header color02\"><a class=\"domain-title\">Basic Concepts</a></h2>\n",
7676
" <div class=\"pure-g domain-table-container color02\">\n",
@@ -105,7 +105,7 @@
105105
" <a class=\"subject-link pure-u-1-4\" target=\"_blank\" href=\"notebooks/handson_preprocessing.ipynb\">Hands-on 1: Preprocessing</a>\n",
106106
" <a class=\"subject-link pure-u-1-4\" target=\"_blank\" href=\"notebooks/handson_analysis.ipynb\">Hands-on 1: Analysis</a>\n",
107107
" </div>\n",
108-
" <p>In this section you will find some practical examples and hands-on that show you how to use Nipype in a \"real world\" scenario.</p>\n",
108+
" <p>In this section, you will find some practical examples and hands-on that show you how to use Nipype in a \"real world\" scenario.</p>\n",
109109
"\n",
110110
" <h2 class=\"domain-header color04\"><a class=\"domain-title\">Advanced Concepts</a></h2>\n",
111111
" <div class=\"pure-g domain-table-container color04\">\n",
@@ -137,7 +137,7 @@
137137
" <a class=\"subject-link pure-u-1-4\" target=\"_blank\" href=\"https://www.mindboggle.info/\">Mindboggle</a>\n",
138138
" <a class=\"subject-link pure-u-1-4\" target=\"_blank\" href=\"https://timvanmourik.github.io/Porcupine/\">PORcupine</a>\n",
139139
" </div>\n",
140-
" <p>This section will give you helpful links and resources, so that you always know where to go to learn more.</p>\n",
140+
" <p>This section will give you helpful links and resources so that you always know where to go to learn more.</p>\n",
141141
"\n",
142142
" </div>\n",
143143
" </article>\n",
@@ -190,8 +190,8 @@
190190
" you everything so that you can start creating your own workflows in no time. We recommend that you start with\n",
191191
" the introduction section to familiarize yourself with the tools used in this tutorial and then move on to the\n",
192192
" basic concepts section to learn everything you need to know for your everyday life with Nipype. The workflow\n",
193-
" examples section shows you a real example how you can use Nipype to analyze an actual dataset. For a very \n",
194-
" quick non-imaging introduction, you can check the Nipype Quickstart notebooks in the introduciton section.\n",
193+
" examples section shows you a real example of how you can use Nipype to analyze an actual dataset. For a very \n",
194+
" quick non-imaging introduction, you can check the Nipype Quickstart notebooks in the introduction section.\n",
195195
" </p><p>\n",
196196
" All of the notebooks used in this tutorial can be found on <a href=\"https://github.com/miykael/nipype_tutorial\">github.com/miykael/nipype_tutorial</a>.\n",
197197
" But if you want to have the real experience and want to go through the computations by yourself, we highly\n",
@@ -205,9 +205,9 @@
205205
" with working Python 3 software (including Nipype, dipy, matplotlib, nibabel, nipy, numpy, pandas, scipy, seaborn and more),\n",
206206
" FSL, ANTs and SPM12 (no license needed). We used <a href=\"https://github.com/kaczmarj/neurodocker\">Neurodocker</a> to create this docker image.\n",
207207
" </p><p>\n",
208-
" If you do not want to run tutorial locally, you can also use \n",
208+
" If you do not want to run the tutorial locally, you can also use \n",
209209
" <a href=\"https://mybinder.org/v2/gh/miykael/nipype_tutorial/master\">Binder service</a>. \n",
210-
" Binder automatically launch the Docker container for you and you have access to all of the notebooks. \n",
210+
" Binder automatically launches the Docker container for you and you have access to all of the notebooks. \n",
211211
" Note, that Binder provides between 1G and 4G RAM memory, some notebooks from Workflow Examples might not work. \n",
212212
" All notebooks from Introduction and Basic Concepts parts should work.\n",
213213
" </p><p>\n",
@@ -236,7 +236,7 @@
236236
" <a class=\"subject-link pure-u-1-4\" target=\"_blank\" href=\"notebooks/introduction_quickstart_non-neuroimaging.ipynb\">Nipype Quickstart (non-neuroimaging examples)</a>\n",
237237
" </div>\n",
238238
" <p>This section is meant as a general overview. It should give you a short introduction to the main topics that\n",
239-
" you need to understand to use Nipype and this tutorial. The section also contains a very short neuroimaging showcase, as well as as quick non-imaging introduction to Nipype workflows.</p>\n",
239+
" you need to understand to use Nipype and this tutorial. The section also contains a very short neuroimaging showcase, as well as quick non-imaging introduction to Nipype workflows.</p>\n",
240240
"\n",
241241
" <h2 class=\"domain-header color02\"><a class=\"domain-title\">Basic Concepts</a></h2>\n",
242242
" <div class=\"pure-g domain-table-container color02\">\n",
@@ -271,7 +271,7 @@
271271
" <a class=\"subject-link pure-u-1-4\" target=\"_blank\" href=\"notebooks/handson_preprocessing.ipynb\">Hands-on 1: Preprocessing</a>\n",
272272
" <a class=\"subject-link pure-u-1-4\" target=\"_blank\" href=\"notebooks/handson_analysis.ipynb\">Hands-on 1: Analysis</a>\n",
273273
" </div>\n",
274-
" <p>In this section you will find some practical examples and hands-on that show you how to use Nipype in a \"real world\" scenario.</p>\n",
274+
" <p>In this section, you will find some practical examples and hands-on that show you how to use Nipype in a \"real world\" scenario.</p>\n",
275275
"\n",
276276
" <h2 class=\"domain-header color04\"><a class=\"domain-title\">Advanced Concepts</a></h2>\n",
277277
" <div class=\"pure-g domain-table-container color04\">\n",
@@ -303,7 +303,7 @@
303303
" <a class=\"subject-link pure-u-1-4\" target=\"_blank\" href=\"https://www.mindboggle.info/\">Mindboggle</a>\n",
304304
" <a class=\"subject-link pure-u-1-4\" target=\"_blank\" href=\"https://timvanmourik.github.io/Porcupine/\">PORcupine</a>\n",
305305
" </div>\n",
306-
" <p>This section will give you helpful links and resources, so that you always know where to go to learn more.</p>\n",
306+
" <p>This section will give you helpful links and resources so that you always know where to go to learn more.</p>\n",
307307
"\n",
308308
" </div>\n",
309309
" </article>\n",
@@ -332,19 +332,12 @@
332332
"</p>\n",
333333
"To inspect the html code of this page, click: <form action=\"javascript:code_toggle()\"><input type=\"submit\" value=\"Show HTML code\"></form>"
334334
]
335-
},
336-
{
337-
"cell_type": "code",
338-
"execution_count": null,
339-
"metadata": {},
340-
"outputs": [],
341-
"source": []
342335
}
343336
],
344337
"metadata": {
345338
"anaconda-cloud": {},
346339
"kernelspec": {
347-
"display_name": "Python 3",
340+
"display_name": "Python [default]",
348341
"language": "python",
349342
"name": "python3"
350343
},
@@ -358,7 +351,7 @@
358351
"name": "python",
359352
"nbconvert_exporter": "python",
360353
"pygments_lexer": "ipython3",
361-
"version": "3.6.3"
354+
"version": "3.6.5"
362355
}
363356
},
364357
"nbformat": 4,

notebooks/advanced_create_interfaces.ipynb

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@
218218
"cell_type": "markdown",
219219
"metadata": {},
220220
"source": [
221-
"Now, we have a Python object ``nipype_ls`` that is a runnable nipype interface. After execution, Nipype interface return a result object. We can retrieve the output of our ``ls`` invocation from the ``result.runtime`` property:"
221+
"Now, we have a Python object ``nipype_ls`` that is a runnable nipype interface. After execution, Nipype interface returns a result object. We can retrieve the output of our ``ls`` invocation from the ``result.runtime`` property:"
222222
]
223223
},
224224
{
@@ -237,7 +237,7 @@
237237
"source": [
238238
"## Create your own `CommandLine` interface\n",
239239
"\n",
240-
"Let's create a Nipype Interface for a very simple tool called ``antsTransformInfo`` from the [ANTs](http://stnava.github.io/ANTs/) package. This tool is so simple it does not even have an usage description for bash. Using it with a file, gives us the following result: "
240+
"Let's create a Nipype Interface for a very simple tool called ``antsTransformInfo`` from the [ANTs](http://stnava.github.io/ANTs/) package. This tool is so simple it does not even have a usage description for bash. Using it with a file, gives us the following result: "
241241
]
242242
},
243243
{
@@ -295,7 +295,7 @@
295295
"source": [
296296
"### Specifying the inputs\n",
297297
"\n",
298-
"However, the ``args`` argument is too generic and does not deviate much from just running it in bash, or directly using ``subprocess.Popen``. Let's define the intputs specification for the interface, extending the ``nipype.interfaces.base.CommandLineInputSpec`` class.\n",
298+
"However, the ``args`` argument is too generic and does not deviate much from just running it in bash, or directly using ``subprocess.Popen``. Let's define the inputs specification for the interface, extending the ``nipype.interfaces.base.CommandLineInputSpec`` class.\n",
299299
"\n",
300300
"The inputs are implemented using the Enthought traits package. For now, we'll use the ``File`` trait extension of nipype:"
301301
]
@@ -374,7 +374,7 @@
374374
"cell_type": "markdown",
375375
"metadata": {},
376376
"source": [
377-
"Nipype will make sure that the parameters fullfil their prescribed attributes. For instance ``in_file`` is mandatory. An error is issued if we build the command line or try to run this interface without it:"
377+
"Nipype will make sure that the parameters fulfill their prescribed attributes. For instance, ``in_file`` is mandatory. An error is issued if we build the command line or try to run this interface without it:"
378378
]
379379
},
380380
{
@@ -489,7 +489,7 @@
489489
"cell_type": "markdown",
490490
"metadata": {},
491491
"source": [
492-
"We need to complete the functionallity of the ``run()`` member of our interface to parse the standard output. This is done extending its ``_run_interface()`` member.\n",
492+
"We need to complete the functionality of the ``run()`` member of our interface to parse the standard output. This is done extending its ``_run_interface()`` member.\n",
493493
"\n",
494494
"When we define outputs, generally they need to be explicitly wired in the ``_list_outputs()`` member of the core class. Let's see how we can *complete* those:"
495495
]
@@ -697,7 +697,7 @@
697697
"\n",
698698
"`CommandLine` interface is great, but my tool is already in Python - can I wrap it natively?\n",
699699
"\n",
700-
"Sure. Let's solve the following problem: Let's say we have a Python function that takes an input image and a list of three translations (x, y, z) in mm, and than writes a resampled image after the translation has been applied:"
700+
"Sure. Let's solve the following problem: Let's say we have a Python function that takes an input image and a list of three translations (x, y, z) in mm, and then writes a resampled image after the translation has been applied:"
701701
]
702702
},
703703
{
@@ -790,7 +790,7 @@
790790
"source": [
791791
"## Quick approach - ``Function`` interface\n",
792792
"\n",
793-
"Don't reinvent the wheel if it's not necessary. If, like in this case, we have a well-defined function we want to run with Nipype, it is fairly easy to solve it with the ``Function`` interface:"
793+
"Don't reinvent the wheel if it's not necessary. If like in this case, we have a well-defined function we want to run with Nipype, it is fairly easy to solve it with the ``Function`` interface:"
794794
]
795795
},
796796
{
@@ -816,9 +816,9 @@
816816
"\n",
817817
"***Note***: The inputs and outputs do not pass any kind of conformity checking: the function node will take any kind of data type for their inputs and outputs.\n",
818818
"\n",
819-
"There are some other limitations for the ``Function`` interface when used inside workflows. Additionally, the function must be totally self-contained, since it will run with no global context. In practice, it means that **all the imported modules and variables must be defined within the context of the function**.\n",
819+
"There are some other limitations to the ``Function`` interface when used inside workflows. Additionally, the function must be totally self-contained, since it will run with no global context. In practice, it means that **all the imported modules and variables must be defined within the context of the function**.\n",
820820
"\n",
821-
"For more, checkout the [Function Node](basic_function_nodes.ipynb) notebook."
821+
"For more, check out the [Function Node](basic_function_nodes.ipynb) notebook."
822822
]
823823
},
824824
{
@@ -868,7 +868,7 @@
868868
"\n",
869869
"Now, we face the problem of interfacing something different from a command line. Therefore, the ``CommandLine`` base class will not help us here. The specification of the inputs and outputs, though, will work the same way.\n",
870870
"\n",
871-
"Let's start from that point. Our Python function takes in three inputs: (1) the input image, (2) the translation and (3) an output image.\n",
871+
"Let's start from that point on. Our Python function takes in three inputs: (1) the input image, (2) the translation and (3) an output image.\n",
872872
"\n",
873873
"The specification of inputs and outputs must be familiar to you at this point. Please note that now, input specification is derived from ``BaseInterfaceInputSpec``, which is a bit thinner than ``CommandLineInputSpec``. The output specification can be derived from ``TraitedSpec`` as before:"
874874
]
@@ -1116,7 +1116,7 @@
11161116
" total = sum(data(:) > 0)\n",
11171117
" ```\n",
11181118
" \n",
1119-
"The following example, uses ``scipy.io.savemat`` to convert the input image to `MATLAB` format. Once the file is loaded we can quickly extract the estimated total volume.\n",
1119+
"The following example uses ``scipy.io.savemat`` to convert the input image to `MATLAB` format. Once the file is loaded we can quickly extract the estimated total volume.\n",
11201120
"\n",
11211121
"***Note:*** For the purpose of this example, we will be using the freely available `MATLAB` alternative `Octave`. But the implementation of a `MATLAB` interface will be identical."
11221122
]

0 commit comments

Comments
 (0)