Skip to content

Commit

Permalink
Update readme with information for users to install
Browse files Browse the repository at this point in the history
  • Loading branch information
blowekamp committed Apr 13, 2017
1 parent bdc00b9 commit 2857404
Showing 1 changed file with 53 additions and 1 deletion.
54 changes: 53 additions & 1 deletion README.md
@@ -1,6 +1,58 @@
# SimpleITKPythonPackage

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

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.

To install SimpleITK:

```bash
pip install SimpleITK
```

## Installing SimpleITK for Python from the Python Packaging Source

```bash
pip install SimpleITK
```

### Prerequisites

Building requires:
* [CMake](https://cmake.org)
* Git
* C++ Compiler - Platform specific requirements are summarized in [scikit-build documentation](http://scikit-build.readthedocs.io).
* Python
** pip >= 9.0.0
** setuptools >= 28.0.0

Please ensure that `pip` and `setuptools` are up to date and are a recent version.

There is also the implicit requirement of `scikit-build`, which will be automatically be temporarily installed with the recommended installation methods.

The CMake and optional Ninja build tool can dependencies be provided through pip if needed:

```bash
pip install cmake ninja
```

### Compilations and Installation from Github

SimpleITK can be compiled and install directly from the github repository:

```bash
pip install git+https://github.com/SimpleITK/SimpleITKPythonPackage.git -v
```

### Compilation and Installation from Source Distribution

Alternatively, SimpleITK for Python can be compiled and installed from the SimpleITKPythonPackage python source distribution.

``bash
pip install SimpleITKPythonPackage-1.0.0.tar.gz
```
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.
## Automated wheels building with scripts
Expand Down

0 comments on commit 2857404

Please sign in to comment.