https://github.com/simpleitk/simpleitkpythonpackage
A setup script to generate a Python Wheels
https://github.com/simpleitk/simpleitkpythonpackage
Last synced: about 1 year ago
JSON representation
A setup script to generate a Python Wheels
- Host: GitHub
- URL: https://github.com/simpleitk/simpleitkpythonpackage
- Owner: SimpleITK
- Created: 2016-08-31T07:28:29.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-01-09T18:29:52.000Z (about 1 year ago)
- Last Synced: 2025-01-09T19:39:04.853Z (about 1 year ago)
- Language: CMake
- Size: 48.8 KB
- Stars: 17
- Watchers: 7
- Forks: 11
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SimpleITKPythonPackage
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 is 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 --no-binary :all: SimpleITK
```
### Prerequisites
The build requirements are specified in the pyproject.toml file via [PEP 518](https://peps.python.org/pep-0518/). The requirements should be automatically downloaded when using a [PEP 517](https://peps.python.org/pep-0517/) compliant build front-end.
Additionally building *requires*:
* Git
* C++ Compiler - Platform specific requirements are summarized in [scikit-build documentation](http://scikit-build.readthedocs.io).
* Python
* pip >= 9.0.0
Please ensure that `pip` is up to date.
```bash
python -m pip install --upgrade pip
```
### 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).
## Automated wheels building with scripts
Steps required to build wheels on Linux, MacOSX and Windows have been automated. The
following sections outline how to use the associated scripts.
### Linux
On any linux distribution with `docker` and `bash` installed, running the script
`dockcross-manylinux-build-wheels.sh` will create 32 and 64-bit wheels for both
python 2.x and python 3.x in the `dist` directory.
For example:
```bash
$ git clone git://github.com/SimpleITK/SimpleITKPythonPackage.git
[...]
$ ./scripts/dockcross-manylinux-build-wheels.sh
[...]
$ ls -1 dist/
SimpleITK-0.11.0-cp27-cp27m-manylinux1_i686.whl
SimpleITK-0.11.0-cp27-cp27m-manylinux1_x86_64.whl
SimpleITK-0.11.0-cp27-cp27mu-manylinux1_i686.whl
SimpleITK-0.11.0-cp27-cp27mu-manylinux1_x86_64.whl
SimpleITK-0.11.0-cp33-cp33m-manylinux1_i686.whl
SimpleITK-0.11.0-cp33-cp33m-manylinux1_x86_64.whl
SimpleITK-0.11.0-cp34-cp34m-manylinux1_i686.whl
SimpleITK-0.11.0-cp34-cp34m-manylinux1_x86_64.whl
SimpleITK-0.11.0-cp35-cp35m-manylinux1_i686.whl
SimpleITK-0.11.0-cp35-cp35m-manylinux1_x86_64.whl
```
## Prerequisites
Building wheels requires:
* [CMake](https://cmake.org)
* Git
* C++ Compiler - Platform specific requirements are summarized in [scikit-build documentation](http://scikit-build.readthedocs.io).
* Python
## Detailed build instructions
### Building SimpleITK Python wheels
Build the SimpleITK Python wheel with the following command:
```
python -m build .
```
### Building Source Distribution
The Python [build](https://pypa-build.readthedocs.io/en/latest/) package should be used to build the source distribution:
```
python -m build --sdist .
```
### Efficiently building wheels for different version of python
If on a given platform you would like to build wheels for different version of python, you can build the SimpleITK core libraries first and reuse them when building each wheel.
Here are the steps:
1. Build `SimpleITKPythonPackage` with `SimpleITKPythonPackage_BUILD_PYTHON` set to `OFF`
2. Build "flavor" of package using:
```
python setup.py bdist_wheel -- \
-DSimpleITK_DIR:PATH=/path/to/SimpleITKPythonPackage-core-build/SimpleITK-superbuild/SimpleITK-build \
-DSWIG_EXECUTABLE:PATH=/path/to/SimpleITKPythonPackage-core-build/SimpleITK-superbuild/Swig/bin/swig
```
## Miscellaneous
Written by Jean-Christophe Fillion-Robin from Kitware Inc.
It is covered by the Apache License, Version 2.0:
http://www.apache.org/licenses/LICENSE-2.0
For more information about SimpleITK, visit http://simpleitk.org
For more information about ITK, visit http://itk.org