Skip to content

Commit 2857404

Browse files
committed
Update readme with information for users to install
1 parent bdc00b9 commit 2857404

File tree

1 file changed

+53
-1
lines changed

1 file changed

+53
-1
lines changed

README.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,58 @@
11
# SimpleITKPythonPackage
22

3-
This project provides a `setup.py` script that build SimpleITK Python wheel. [SimpleITK](http://www.simpleitk.org) is a simplified programming layer on top of the [Insight Segmentation and Registration Toolkit](https://itk.org) (ITK). ITK is an open-source, cross-platform system that provides developers with an extensive suite of software tools for image analysis.
3+
This project provides a `setup.py` script that can build, install, and package SimpleITK for Python. [SimpleITK](http://www.simpleitk.org) is a simplified programming layer on top of the [Insight Segmentation and Registration Toolkit](https://itk.org) (ITK). ITK is an open-source, cross-platform system that provides developers with an extensive suite of software tools for image analysis.
4+
5+
SimpleITK is available for binary downloads from [PyPI](https://pypi.python.org/pypi/SimpleITK) for many common platforms. Also a source distribution available of this repository which may be used when an appropriate binary [wheel](http://pythonwheels.com) is not available.
6+
7+
To install SimpleITK:
8+
9+
```bash
10+
pip install SimpleITK
11+
```
12+
13+
## Installing SimpleITK for Python from the Python Packaging Source
14+
15+
```bash
16+
pip install SimpleITK
17+
```
18+
19+
### Prerequisites
20+
21+
Building requires:
22+
* [CMake](https://cmake.org)
23+
* Git
24+
* C++ Compiler - Platform specific requirements are summarized in [scikit-build documentation](http://scikit-build.readthedocs.io).
25+
* Python
26+
** pip >= 9.0.0
27+
** setuptools >= 28.0.0
28+
29+
Please ensure that `pip` and `setuptools` are up to date and are a recent version.
30+
31+
There is also the implicit requirement of `scikit-build`, which will be automatically be temporarily installed with the recommended installation methods.
32+
33+
The CMake and optional Ninja build tool can dependencies be provided through pip if needed:
34+
35+
```bash
36+
pip install cmake ninja
37+
```
38+
39+
### Compilations and Installation from Github
40+
41+
SimpleITK can be compiled and install directly from the github repository:
42+
43+
```bash
44+
pip install git+https://github.com/SimpleITK/SimpleITKPythonPackage.git -v
45+
```
46+
47+
### Compilation and Installation from Source Distribution
48+
49+
Alternatively, SimpleITK for Python can be compiled and installed from the SimpleITKPythonPackage python source distribution.
50+
51+
``bash
52+
pip install SimpleITKPythonPackage-1.0.0.tar.gz
53+
```
54+
55+
The source distributions are available from [PyPI](https://pypi.python.org/pypi/SimpleITK) and [Source Forge](https://sourceforge.net/projects/simpleitk/files/SimpleITK/1.0.0/Python). They are labeled as `SimpleITKPythonPackages` in the Python sub-directory as opposed to just `SimpleITK` for the source archive of the general SimpleITK repository.
456
557
## Automated wheels building with scripts
658

0 commit comments

Comments
 (0)