-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update installation documentation for Github Release page usage
- Loading branch information
Showing
1 changed file
with
11 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,17 +32,22 @@ Build Status | |
Installation | ||
------------ | ||
|
||
Download wheel from `Github Actions`_ under the latest master build in the | ||
"python-package" artifacts. Then install:: | ||
|
||
python -m pip install sitkibex-0.0.1-py3-none-any.whl | ||
The Python module is distributed as a `wheel`_ binary package. Download the latest tagged release from the | ||
`Github Releases`_ page. Then install:: | ||
|
||
python -m pip install sitkibex-0.1-py3-none-any.whl | ||
|
||
Wheels from the master branch can be download wheel from `Github Actions`_ in the | ||
"python-package" artifact. | ||
|
||
SITK-IBEX requires SimpleITK version 2.0 which is still under development. | ||
For now, use the `latest`_ development version of SimpleITK:: | ||
|
||
python -m pip install --upgrade --pre SimpleITK --find-links https://github.com/SimpleITK/SimpleITK/releases/tag/latest | ||
|
||
Other dependencies are conventionally specified in `setup.py` and `requirements.txt`. | ||
Other dependencies are conventionally specified in `setup.py` and `requirements.txt` and therefore installed as | ||
dependencies when the wheel is installed. | ||
|
||
Data | ||
---- | ||
|
@@ -114,3 +119,5 @@ Additionally, we can be emailed at: [email protected] Please include | |
.. _OME TIFF: https://docs.openmicroscopy.org/ome-model/latest/ome-tiff/ | ||
.. _latest: https://github.com/SimpleITK/SimpleITK/releases | ||
.. _GitHub Issues: https://github.com/niaid/sitk-ibex | ||
.. _wheel: https://www.python.org/dev/peps/pep-0427/ | ||
.. _Github Releases: https://github.com/niaid/sitk-ibex/releases |