You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+76-1Lines changed: 76 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,4 +4,79 @@
4
4
5
5
Interactive widgets to visualize images, point sets, and 3D geometry on the web.
6
6
7
-
Check out the [Quick Start Guide](https://itkwidgets.readthedocs.io/en/latest/quick_start_guide.html) if you're ready to get started or visit the [docs](https://itkwidgets.readthedocs.io/en/latest/) for more information.
7
+
# Getting Started
8
+
9
+
## Installation
10
+
11
+
### Jupyter Notebook
12
+
13
+
To install the widgets for the Jupyter Notebook with pip:
14
+
15
+
```bash
16
+
pip install 'itkwidgets[notebook]>=1.0a8'
17
+
```
18
+
19
+
Then look for the ImJoy icon at the top in the Jupyter Notebook:
20
+
21
+

22
+
23
+
### Jupyter Lab
24
+
25
+
For Jupyter Lab 3 run:
26
+
27
+
```bash
28
+
pip install 'itkwidgets[lab]>=1.0a8'
29
+
```
30
+
31
+
Then look for the ImJoy icon at the top in the Jupyter Notebook:
32
+
33
+

34
+
35
+
### Google Colab
36
+
37
+
For Google Colab run:
38
+
39
+
```bash
40
+
pip install 'itkwidgets>=1.0a8'
41
+
```
42
+
43
+
## Example Notebooks
44
+
45
+
Example Notebooks can be accessed locally by cloning the repository:
46
+
47
+
```bash
48
+
git clone -b main https://github.com/InsightSoftwareConsortium/itkwidgets.git
49
+
```
50
+
51
+
Then navigate into the examples directory:
52
+
53
+
```bash
54
+
cd itkwidgets/examples
55
+
```
56
+
57
+
## Usage
58
+
59
+
In Jupyter, import the view function:
60
+
61
+
```python
62
+
from itkwidgets import view
63
+
```
64
+
65
+
Then, call the view function at the end of a cell, passing in the image to examine:
66
+
67
+
```python
68
+
view(image)
69
+
```
70
+
71
+
For information on additional options, see the view function docstring:
72
+
73
+
```python
74
+
view?
75
+
```
76
+
77
+
See the [deployments](deployments.md) section for a more detailed overview of additional notebook
78
+
options as well as other ways to run and interact with your notebooks.
79
+
80
+
# Learn more
81
+
82
+
Visit the [docs](https://itkwidgets.readthedocs.io/en/latest/) for more information on supported notebooks and integrations.
0 commit comments