Skip to content

Commit 8f4f80a

Browse files
LeengitLee Newberg
andauthored
7 update documentation to indicate availability of itk spcn via py pi (#8)
* DOC: Update documentation to indicate availability of itk-spcn via PyPI Co-authored-by: Lee Newberg <[email protected]>
1 parent 5155890 commit 8f4f80a

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

README.rst

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,8 @@ The lead developer of InsightSoftwareConsortium/ITKColorNormalization is `Lee Ne
3838
Installation for python
3939
-----------------------
4040

41-
From the web page https://github.com/InsightSoftwareConsortium/ITKColorNormalization/actions, click on a recently
42-
successfully built workflow. This takes you to a page of \"Build, test, package\" and a list of Artifacts, such as
43-
WindowWheel3.8, WindowWheel3.7, WindowWheel3.6, WindowWheel3.5, MacOSWheels, LinuxWheel38, LinuxWheel37, LinuxWheel36, and
44-
LinuxWheel35. Click on the artifact that matches your operating system and version of python, to download a zip file. Find
45-
the downloaded zip file, perhaps within your Downloads folder, and unzip it. This gives you a file with a name like
46-
itk_spcn-0.1.0-cp38-cp38-manylinux1_x86_64.whl.
47-
48-
In a terminal session, create a python virtual environment with a command like
41+
To install the package into a python virtual environment, first create a python virtual environment in a terminal
42+
session with a command like
4943

5044
.. code-block:: shell
5145
@@ -58,13 +52,13 @@ with a single \".\" followed by a space.
5852
5953
. /tmp/venv/bin/activate
6054
61-
Install the wheel in the virtual environment with a command like
55+
Whether or not you are using a virtual environment, install the package with a command like
6256

6357
.. code-block:: shell
6458
65-
/tmp/venv/bin/pip install itk_spcn-0.1.0-cp38-cp38-manylinux1_x86_64.whl
59+
pip install itk-spcn
6660
67-
You can stop using the virtual environment in your terminal session with the following command.
61+
You can suspend using the virtual environment in your terminal session with the following command.
6862

6963
.. code-block:: shell
7064
@@ -73,15 +67,15 @@ You can stop using the virtual environment in your terminal session with the fol
7367
Usage
7468
-----
7569

76-
If you have not done so already, make your current terminal session use the previously created virtual environment with a
77-
command like the following. Note that the line begins with a single \".\" followed by a space.
70+
If you are using a virtual python environment and you have not done so already, make your current terminal session use the
71+
previously created virtual environment with a command like the following. Note that the line begins with a single \".\"
72+
followed by a space.
7873

7974
.. code-block:: shell
8075
8176
. /tmp/venv/bin/activate
8277
83-
Launch python using your virtual environment with \`python\` or \`python3\`. In python, type the following to load the itk
84-
package and two images:
78+
Launch python. In python, type the following to load the itk package and two images:
8579

8680
.. code-block:: python
8781

0 commit comments

Comments
 (0)