Skip to content

Commit bfe71c1

Browse files
committed
DOC: Describe JupyterLite deployment
1 parent b1194d3 commit bfe71c1

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

docs/deployments.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
11
# Deployments
22

3+
## JupyterLite
4+
5+
<a href="./_static/lab/index.html">
6+
Try it!
7+
8+
![Jupyterlite](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)
9+
</a>
10+
11+
[JupyterLite](https://jupyterlite.readthedocs.io/en/latest/) is a JupyterLab distribution that runs entirely in the browser built from the ground-up using JupyterLab components and extensions.
12+
13+
To use itkwidgets in a JupyterLite deployment, install the
14+
[imjoy-jupyterlab-extension](https://pypi.org/project/imjoy-jupyterlab-extension/)
15+
JupyterLab 3 federated extension. Optionally, pre-install the itkwidgets wheel
16+
and its dependency. In the Pyodide notebook,
17+
18+
```python
19+
import piplite
20+
piplite.install("itkwidgets==1.0a5")
21+
```
22+
23+
Here we are installing the specific pre-release version pre-installed. See
24+
also [the JupyterLite configuration used for this documentation](https://github.com/InsightSoftwareConsortium/itkwidgets/blob/main/docs/jupyterlite_config.json) and the
25+
[Sphinx / ReadTheDocs
26+
configuration](https://github.com/InsightSoftwareConsortium/itkwidgets/blob/main/docs/conf.py)
27+
used for this documentation.
28+
329
## Colab
430

5-
Google Colab is a free-to-use hosted Jupyter notebook service that provides
31+
[Google Colab](https://research.google.com/colaboratory/) is a free-to-use hosted Jupyter notebook service that provides
632
computing resources including GPUs and itkwidgets is now supported in Colab
733
notebooks! You can get started with a demo notebook: [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/InsightSoftwareConsortium/itkwidgets/blob/main/examples/Hello3DWorld.ipynb)
834

@@ -13,8 +39,7 @@ Or visit the [welcome page](https://colab.research.google.com/?utm_source=scs-in
1339
Notebooks can be uploaded from a repository, Google Drive, or your local machine.
1440

1541

16-
Jupyter Notebook
17-
----------------
42+
## Jupyter Notebook
1843

1944
To use itkwidgets locally first [install Jupyter Notebook](https://jupyter.org/install#jupyter-notebook) and start Jupyter:
2045

@@ -26,14 +51,13 @@ jupyter notebook
2651
If you'd rather interact with remotely hosted notebooks you can also open them
2752
in Binder: [![Open in Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/InsightSoftwareConsortium/itkwidgets/main?urlpath=%2Fnotebooks%2Fexamples%2F)
2853

29-
Jupyterlab
30-
----------
54+
## JupyterLab
3155

3256
To use itkwidgets locally first [install JupyterLab](https://jupyter.org/install#jupyterlab) and start Jupyter:
3357

3458
```bash
3559
pip install jupyterlab
36-
jupyter-lab
60+
jupyter lab
3761
```
3862

3963
If you'd rather interact with remotely hosted notebooks in JupyterLab you can

0 commit comments

Comments
 (0)