Skip to content

Commit 1222a5e

Browse files
thewtexthewtex
committed
ENH: Add 'all' package extras and use in examples
A default that 'just works' across all environments.
1 parent 339b0ee commit 1222a5e

15 files changed

+48
-30
lines changed

‎README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,18 @@ Interactive widgets to visualize images, point sets, and 3D geometry on the web.
99

1010
## Installation
1111

12+
To install for all environments:
13+
14+
```bash
15+
pip install 'itkwidgets[all]>=1.0a16'
16+
```
17+
1218
### Jupyter Notebook
1319

1420
To install the widgets for the Jupyter Notebook with pip:
1521

1622
```bash
17-
pip install 'itkwidgets[notebook]>=1.0a8'
23+
pip install 'itkwidgets[notebook]>=1.0a16'
1824
```
1925

2026
Then look for the ImJoy icon at the top in the Jupyter Notebook:
@@ -26,7 +32,7 @@ Then look for the ImJoy icon at the top in the Jupyter Notebook:
2632
For Jupyter Lab 3 run:
2733

2834
```bash
29-
pip install 'itkwidgets[lab]>=1.0a8'
35+
pip install 'itkwidgets[lab]>=1.0a16'
3036
```
3137

3238
Then look for the ImJoy icon at the top in the Jupyter Notebook:
@@ -38,7 +44,7 @@ Then look for the ImJoy icon at the top in the Jupyter Notebook:
3844
For Google Colab run:
3945

4046
```bash
41-
pip install 'itkwidgets>=1.0a8'
47+
pip install 'itkwidgets>=1.0a16'
4248
```
4349

4450
## Example Notebooks

‎docs/quick_start_guide.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,18 @@
22

33
## Installation
44

5+
To install for all environments:
6+
7+
```bash
8+
pip install 'itkwidgets[all]>=1.0a16'
9+
```
10+
511
### Jupyter Notebook
612

713
To install the widgets for the Jupyter Notebook with pip:
814

915
```bash
10-
pip install 'itkwidgets[notebook]>=1.0a8'
16+
pip install 'itkwidgets[notebook]>=1.0a16'
1117
```
1218

1319
Then look for the ImJoy icon at the top in the Jupyter Notebook:
@@ -19,7 +25,7 @@ Then look for the ImJoy icon at the top in the Jupyter Notebook:
1925
For Jupyter Lab 3 run:
2026

2127
```bash
22-
pip install 'itkwidgets[lab]>=1.0a8'
28+
pip install 'itkwidgets[lab]>=1.0a16'
2329
```
2430

2531
Then look for the ImJoy icon at the top in the Jupyter Notebook:
@@ -31,7 +37,7 @@ Then look for the ImJoy icon at the top in the Jupyter Notebook:
3137
For Google Colab run:
3238

3339
```bash
34-
pip install 'itkwidgets>=1.0a8'
40+
pip install 'itkwidgets>=1.0a16'
3541
```
3642

3743
## Example Notebooks

‎examples/Hello3DWorld.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"source": [
1010
"import sys\n",
1111
"\n",
12-
"!{sys.executable} -m pip install -q imageio \"itkwidgets>=1.0a6\""
12+
"!{sys.executable} -m pip install -q imageio \"itkwidgets[all]>=1.0a16\""
1313
]
1414
},
1515
{
@@ -130,7 +130,7 @@
130130
"name": "python",
131131
"nbconvert_exporter": "python",
132132
"pygments_lexer": "ipython3",
133-
"version": "3.7.12"
133+
"version": "3.10.5"
134134
}
135135
},
136136
"nbformat": 4,

‎examples/NumPyArrayPointSet.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"source": [
1010
"import sys\n",
1111
"\n",
12-
"!{sys.executable} -m pip install -q \"itkwidgets>=1.0a6\""
12+
"!{sys.executable} -m pip install -q \"itkwidgets[all]>=1.0a16\""
1313
]
1414
},
1515
{
@@ -135,7 +135,7 @@
135135
"name": "python",
136136
"nbconvert_exporter": "python",
137137
"pygments_lexer": "ipython3",
138-
"version": "3.8.10"
138+
"version": "3.10.5"
139139
}
140140
},
141141
"nbformat": 4,

‎examples/integrations/MONAI/transform_visualization.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"# Install dependencies for this example\n",
1111
"import sys\n",
1212
"\n",
13-
"!{sys.executable} -m pip install -q \"monai-weekly[nibabel, matplotlib, tqdm]\" \"itkwidgets>=1.0a6\""
13+
"!{sys.executable} -m pip install -q \"monai-weekly[nibabel, matplotlib, tqdm]\" \"itkwidgets[all]>=1.0a16\""
1414
]
1515
},
1616
{
@@ -239,7 +239,7 @@
239239
"name": "python",
240240
"nbconvert_exporter": "python",
241241
"pygments_lexer": "ipython3",
242-
"version": "3.8.10"
242+
"version": "3.10.5"
243243
}
244244
},
245245
"nbformat": 4,

‎examples/integrations/PyImageJ/ImageJImgLib2.ipynb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
"# Install dependencies for this example\n",
2525
"import sys\n",
2626
"\n",
27-
"!conda install --yes --prefix {sys.prefix} -c conda-forge pyimagej"
27+
"!conda install --yes --prefix {sys.prefix} -c conda-forge pyimagej\n",
28+
"!{sys.executable} -m pip install -q \"itkwidgets[all]>=1.0a16\""
2829
]
2930
},
3031
{
@@ -147,7 +148,7 @@
147148
"name": "python",
148149
"nbconvert_exporter": "python",
149150
"pygments_lexer": "ipython3",
150-
"version": "3.8.10"
151+
"version": "3.10.5"
151152
}
152153
},
153154
"nbformat": 4,

‎examples/integrations/PyVista/LiDAR.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"# Install dependencies for this example\n",
1111
"import sys\n",
1212
"\n",
13-
"!{sys.executable} -m pip install -q pyvista \"itkwidgets>=1.0a6\""
13+
"!{sys.executable} -m pip install -q pyvista \"itkwidgets[all]>=1.0a16\""
1414
]
1515
},
1616
{
@@ -135,7 +135,7 @@
135135
"name": "python",
136136
"nbconvert_exporter": "python",
137137
"pygments_lexer": "ipython3",
138-
"version": "3.8.10"
138+
"version": "3.10.5"
139139
}
140140
},
141141
"nbformat": 4,

‎examples/integrations/PyVista/UniformGrid.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"# Install dependencies for this example\n",
1111
"import sys\n",
1212
"\n",
13-
"!{sys.executable} -m pip install -q pyvista \"itkwidgets>=1.0a6\""
13+
"!{sys.executable} -m pip install -q pyvista \"itkwidgets[all]>=1.0a16\""
1414
]
1515
},
1616
{
@@ -176,7 +176,7 @@
176176
"name": "python",
177177
"nbconvert_exporter": "python",
178178
"pygments_lexer": "ipython3",
179-
"version": "3.8.10"
179+
"version": "3.10.5"
180180
}
181181
},
182182
"nbformat": 4,

‎examples/integrations/dask/DaskArray.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"import sys\n",
1212
"\n",
1313
"!{sys.executable} -m pip install -q --upgrade --pre itk-io\n",
14-
"!{sys.executable} -m pip install -q 'dask[diagnostics]' toolz scikit-image pooch matplotlib \"itkwidgets>=1.0a6\""
14+
"!{sys.executable} -m pip install -q 'dask[diagnostics]' toolz scikit-image pooch matplotlib \"itkwidgets[all]>=1.0a16\""
1515
]
1616
},
1717
{
@@ -344,7 +344,7 @@
344344
"name": "python",
345345
"nbconvert_exporter": "python",
346346
"pygments_lexer": "ipython3",
347-
"version": "3.9.13"
347+
"version": "3.10.5"
348348
}
349349
},
350350
"nbformat": 4,

‎examples/integrations/itk/3DImage.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"# Install dependencies for this example\n",
1010
"import sys\n",
1111
"\n",
12-
"!{sys.executable} -m pip install -q --upgrade --pre itk-io \"itkwidgets>=1.0a6\""
12+
"!{sys.executable} -m pip install -q --upgrade --pre itk-io \"itkwidgets[all]>=1.0a16\""
1313
]
1414
},
1515
{
@@ -122,7 +122,7 @@
122122
"name": "python",
123123
"nbconvert_exporter": "python",
124124
"pygments_lexer": "ipython3",
125-
"version": "3.9.13"
125+
"version": "3.10.5"
126126
}
127127
},
128128
"nbformat": 4,

0 commit comments

Comments
 (0)