Skip to content

Commit 2ea6da3

Browse files
committed
DOC: Installation tweaks
1 parent 1dd1a00 commit 2ea6da3

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

docs/quick_start_guide.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,37 @@
22

33
## Installation
44

5+
### Jupyter Notebook
6+
57
To install the widgets for the Jupyter Notebook with pip:
68

79
```bash
8-
pip install itkwidgets imjoy-jupyter-extension
10+
pip install 'itkwidgets>=1.0a5' imjoy-jupyter-extension
911
```
1012

11-
For Jupyter Lab, additionally, run:
13+
Then look for the ImJoy icon at the top in the Jupyter Notebook:
14+
15+
![ImJoy Icon in Jupyter Notebook](images/imjoy-notebook.png)
16+
17+
### Jupyter Lab
18+
19+
For Jupyter Lab 3 run:
1220

1321
```bash
14-
jupyter labextension install imjoy-jupyter-extension
22+
pip install 'itkwidgets>=1.0a5' imjoy-jupyterlab-extension
1523
```
1624

1725
Then look for the ImJoy icon at the top in the Jupyter Notebook:
1826

19-
![ImJoy Icon in Jupyter Notebook](images/imjoy-notebook.png)
27+
![ImJoy Icon in Jupyter Lab](images/imjoy-lab.png)
2028

21-
Or Jupyter Lab:
29+
### Google Colab
2230

23-
![ImJoy Icon in Jupyter Lab](images/imjoy-lab.png)
31+
For Google Colab run:
32+
33+
```bash
34+
pip install 'itkwidgets>=1.0a5'
35+
```
2436

2537
## Example Notebooks
2638

@@ -33,7 +45,7 @@ git clone -b main https://github.com/InsightSoftwareConsortium/itkwidgets.git
3345
Then navigate into the examples directory:
3446

3547
```bash
36-
cd <path-to-itkwidgets>/examples
48+
cd itkwidgets/examples
3749
```
3850

3951
## Usage

0 commit comments

Comments
 (0)