From 31b5bfb3c5efa7f125550c3c970919c4eb493b8d Mon Sep 17 00:00:00 2001 From: Bradley Lowekamp Date: Thu, 23 Jul 2020 16:20:35 -0400 Subject: [PATCH] Update installation documentation for Github Release page usage --- README.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index cafd678..6915f82 100644 --- a/README.rst +++ b/README.rst @@ -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: bioinformatics@niaid.nih.gov 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