Skip to content

Commit ae4595a

Browse files
authored
Merge pull request #490 from zivy/updateMarkdowns
Update markdowns.
2 parents 6de75ee + af8c35c commit ae4595a

File tree

4 files changed

+14
-16
lines changed

4 files changed

+14
-16
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ driver for both the Python and R notebooks. Testing relies on several Python
1818
packages listed in the [requirements_dev.txt](requirements_dev.txt) file. Please
1919
install these packages. Note that we use the pyenchant
2020
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`).
2222

2323
When you add a new notebook, you will need to add it to the relevant list of
2424
notebooks found in the [test_notebooks.py](tests/test_notebooks.py). These

Python/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# SimpleITK Python Notebooks
22

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).
44

55
## Setting Up a Python Environment
66

77
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.
88

99
### 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:
1111
```
1212
conda env create -f environment.yml
1313
```

R/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@
1010

1111
### Install SimpleITK
1212

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.
1414

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).
1616

1717

1818
### Downloading Data
1919

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.
2121

22-
Alternatively, to download all the data before hand:
22+
Alternatively, to download all the data before hand (assumes Python is available):
2323

2424
cd SimpleITK-Notebooks
2525
./downloaddata.py Data/ Data/manifest.json

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
77

88

9-
[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.
1010

1111
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.
1212

@@ -24,13 +24,13 @@ created with SimpleITK and Python (the [script](Utilities/intro_animation.py) us
2424

2525
# Getting Started
2626

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)).
2828

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.
3030

3131
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.
3232

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).
3434

3535
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:
3636
```
@@ -49,21 +49,19 @@ found in `C:\Users\[your_user_name]\.jupyter\custom\custom.css`.
4949

5050
Before you clone the repository to your computer you may want to try it out, kick the tires so to speak.
5151

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)
5353
you can try out the Python notebooks without installing a thing.
5454

5555
Some caveats:
5656

5757
1. This is a free public service with limited resources, so may not always be available.
5858
2. Some of our notebooks require significant computational
5959
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.
6361

6462
After you launch binder, go to the Python directory and select the notebook of interest:
6563

66-
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/InsightSoftwareConsortium/SimpleITK-Notebooks/master)
64+
[![BinderHub](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/InsightSoftwareConsortium/SimpleITK-Notebooks/main)
6765

6866
# Contributions from the Community
6967

0 commit comments

Comments
 (0)