You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ driver for both the Python and R notebooks. Testing relies on several Python
18
18
packages listed in the [requirements_dev.txt](requirements_dev.txt) file. Please
19
19
install these packages. Note that we use the pyenchant
20
20
spell checker which is only available by using the pip package manager
21
-
(no conda). This spell checker relies on the [enchant](https://abiword.github.io/enchant/) library (`brew install enchant`, `sudo apt-get install enchant`).
21
+
(no conda). This spell checker relies on the [enchant](https://rrthomas.github.io/enchant/) library (`brew install enchant`, `sudo apt-get install enchant`).
22
22
23
23
When you add a new notebook, you will need to add it to the relevant list of
24
24
notebooks found in the [test_notebooks.py](tests/test_notebooks.py). These
Copy file name to clipboardExpand all lines: Python/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
# SimpleITK Python Notebooks
2
2
3
-
As of this writing, SimpleITK version >=2.2.0 or newer is required to run these notebooks. This version is available from [PyPi](https://pypi.python.org/pypi/SimpleITK) and [Anaconda Cloud](https://anaconda.org/simpleitk/simpleitk).
3
+
As of this writing, SimpleITK version >=2.2.0 or newer is required to run these notebooks. This version is available from [PyPi](https://pypi.python.org/pypi/SimpleITK) and [Conda Forge](https://anaconda.org/conda-forge/simpleitk).
4
4
5
5
## Setting Up a Python Environment
6
6
7
7
We recommend setting up a separate Python virtual environment to run through these notebooks as a tutorial. Use either the Anaconda Python distribution or a plain Python distribution.
8
8
9
9
### Anaconda
10
-
With [Anaconda](https://www.continuum.io/) you can set up a virtual environment, named sitkpy, and install all dependencies including SimpleITK using a single command:
10
+
With [Anaconda](https://www.anaconda.com/docs/main) you can set up a virtual environment, named sitkpy, and install all dependencies including SimpleITK using a single command:
Copy file name to clipboardExpand all lines: R/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,16 +10,16 @@
10
10
11
11
### Install SimpleITK
12
12
13
-
A devtools based installer is [available on github](https://github.com/SimpleITK/SimpleITKRInstaller). It requires that you have the [CMake tool](https://cmake.org/) and the git version control system installed on your machine.
13
+
A remotes based installer is [available on github](https://github.com/SimpleITK/SimpleITKRInstaller). It requires that you have the [CMake tool](https://cmake.org/) and the [git version control system](https://git-scm.com/) installed on your machine.
14
14
15
-
The manual approach to compiling and installing SimpleITK with the R wrapping turned on is described [here](https://simpleitk.readthedocs.io/en/master/building.html).
15
+
A manual approach to compiling and installing SimpleITK with the R wrapping turned on is described [here](https://simpleitk.readthedocs.io/en/latest/building.html).
16
16
17
17
18
18
### Downloading Data
19
19
20
-
The data can be automatically downloaded to the "Data" directory when you execute the notebooks.
20
+
The data is automatically downloaded to the "Data" directory when you execute the notebooks.
21
21
22
-
Alternatively, to download all the data before hand:
22
+
Alternatively, to download all the data before hand (assumes Python is available):
[SimpleITK](https://itk.org/Wiki/SimpleITK) is an abstraction layer and wrapper around the Insight Segmentation and Registration Toolkit [(ITK)](http://www.itk.org). It is available in the following programming languages: C++, Python, R, Java, C#, Lua, Tcl and Ruby.
9
+
[SimpleITK](https://simpleitk.org) is an abstraction layer and wrapper around the Insight Segmentation and Registration Toolkit [(ITK)](http://www.itk.org). It is available in the following programming languages: C++, Python, R, Java, C#, Lua, Tcl and Ruby.
10
10
11
11
This repository contains a collection of Jupyter Notebooks illustrating the use of SimpleITK for educational and research activities. The notebooks demonstrate the use of SimpleITK for interactive image analysis using the Python and R programming languages.
12
12
@@ -24,13 +24,13 @@ created with SimpleITK and Python (the [script](Utilities/intro_animation.py) us
24
24
25
25
# Getting Started
26
26
27
-
Note that currently SimpleITK with R is only available on Linux and Mac.
27
+
Note that currently SimpleITK with R is only available on Linux and Mac (see the [remotes based installer](https://github.com/SimpleITK/SimpleITKRInstaller)).
28
28
29
-
1. Language specific details for installing the notebooks is given in the README files in the respective directories ([Python](Python/README.md), [R](R/README.md)). For general information about installing SimpleITK please see the [SimpleITK read-the-docs](https://simpleitk.readthedocs.io/en/master/) pages.
29
+
1. Language specific details for installing the notebooks is given in the README files in the respective directories ([Python](Python/README.md), [R](R/README.md)). For general information about installing SimpleITK please see the [SimpleITK read-the-docs](https://simpleitk.readthedocs.io/en/latest/) pages.
30
30
31
31
2. The [SimpleITK API documentation](https://simpleitk.org/doxygen/latest/html/index.html) is based on the C++ implementation which is readily mapped to your language of choice.
32
32
33
-
3. Learn the general concepts underlying the implementations of segmentation and registration by reading the ([ITK book](https://itk.org/ItkSoftwareGuide)). The relevant portion is "Book 2: Design and Functionality". The ITK API is significantly different from the SimpleITK one, but the general concepts are the same (e.g. combination of optimizer and similarity metric for registration).
33
+
3. Learn the general concepts underlying the implementations of segmentation and registration by reading the ([ITK book](https://itk.org/ITKSoftwareGuide/html/)). The relevant portion is "Book 2: Design and Functionality". The ITK API is significantly different from the SimpleITK one, but the general concepts are the same (e.g. combination of optimizer and similarity metric for registration).
34
34
35
35
4. General notebook setup. By default the contents of the Jupyter notebooks do not occupy the full browser window width. To take advantage of the full window width you can either configure each notebook independently by adding the following into a code cell:
36
36
```
@@ -49,21 +49,19 @@ found in `C:\Users\[your_user_name]\.jupyter\custom\custom.css`.
49
49
50
50
Before you clone the repository to your computer you may want to try it out, kick the tires so to speak.
51
51
52
-
Thanks to the awesome people from the [Binder Project](https://github.com/jupyterhub/binderhub)
52
+
Thanks to the awesome people from the [BinderHub Project](https://github.com/jupyterhub/binderhub)
53
53
you can try out the Python notebooks without installing a thing.
54
54
55
55
Some caveats:
56
56
57
57
1. This is a free public service with limited resources, so may not always be available.
58
58
2. Some of our notebooks require significant computational
59
59
resources which may not be available.
60
-
3. All cells that use the sitk.Show() command will generate an exception because they
61
-
require a Fiji installation. Either ignore this or modify the code
62
-
for the session.
60
+
3. All cells that use the sitk.Show() command will generate an exception because they require a Fiji installation. Either ignore this or modify the code for the session.
63
61
64
62
After you launch binder, go to the Python directory and select the notebook of interest:
0 commit comments