Skip to content

Commit 3024f98

Browse files
authored
Merge pull request #4606 from plotly/jupyterlab-clarification
Clarify Jupyterlab install
2 parents cd7fc3f + 7816992 commit 3024f98

File tree

1 file changed

+11
-25
lines changed

1 file changed

+11
-25
lines changed

Diff for: doc/python/getting-started.md

+11-25
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ jupyter:
66
extension: .md
77
format_name: markdown
88
format_version: '1.3'
9-
jupytext_version: 1.14.1
9+
jupytext_version: 1.16.1
1010
kernelspec:
11-
display_name: Python 3
11+
display_name: Python 3 (ipykernel)
1212
language: python
1313
name: python3
1414
language_info:
@@ -20,7 +20,7 @@ jupyter:
2020
name: python
2121
nbconvert_exporter: python
2222
pygments_lexer: ipython3
23-
version: 3.8.8
23+
version: 3.10.14
2424
plotly:
2525
description: Getting Started with Plotly for Python.
2626
has_thumbnail: false
@@ -96,8 +96,7 @@ IFrame(snippet_url + 'getting-started', width='100%', height=1200)
9696

9797
#### JupyterLab Support
9898

99-
For use in [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), install the `jupyterlab` and `ipywidgets`
100-
packages using `pip`:
99+
To use `plotly` in [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), install the `jupyterlab` and `ipywidgets` packages in the same environment as you installed `plotly`, using `pip`:
101100

102101
```
103102
$ pip install "jupyterlab>=3" "ipywidgets>=7.6"
@@ -109,21 +108,16 @@ or `conda`:
109108
$ conda install "jupyterlab>=3" "ipywidgets>=7.6"
110109
```
111110

112-
You'll need `jupyter-dash` to add widgets such as sliders, dropdowns, and buttons to Plotly charts in JupyterLab.
113-
114-
Install [`jupyter-dash`](https://github.com/plotly/jupyter-dash) using `pip`:
115-
116-
```
117-
$ pip install jupyter-dash
118-
```
111+
The `plotly` jupyterlab extension is included when you install `plotly` using `pip` or `conda`. When you run Jupyter Lab, ensure you are running it in the same environment that you installed `plotly` in so it has access to the `plotly` jupyterlab extension.
119112

120-
or `conda`:
113+
**JupyterLab 2 or earlier** does not support the prebuilt extensions installed using `pip` and `conda`. If you are using JupyterLab 2, run the following command to install the required JupyterLab extensions (note that this will require [`node`](https://nodejs.org/) to be installed):
121114

122115
```
123-
$ conda install -c conda-forge -c plotly jupyter-dash
116+
# JupyterLab 2.x renderer support
117+
jupyter labextension install [email protected] @jupyter-widgets/jupyterlab-manager
124118
```
125119

126-
These packages contain everything you need to run JupyterLab...
120+
Launch JupyterLab with:
127121

128122
```
129123
$ jupyter lab
@@ -148,18 +142,10 @@ fig_widget = go.FigureWidget(fig)
148142
fig_widget
149143
```
150144

151-
The instructions above apply to JupyterLab 3.x. **For JupyterLab 2 or earlier**, run the following commands to install the required JupyterLab extensions (note that this will require [`node`](https://nodejs.org/) to be installed):
152-
153-
```
154-
# JupyterLab 2.x renderer support
155-
jupyter labextension install [email protected] @jupyter-widgets/jupyterlab-manager
156-
```
157-
158-
Please check out our [Troubleshooting guide](/python/troubleshooting/) if you run into any problems with JupyterLab, particularly if you are using multiple python environments inside Jupyter.
159-
160-
161145
See [_Displaying Figures in Python_](/python/renderers/) for more information on the renderers framework, and see [_Plotly FigureWidget Overview_](/python/figurewidget/) for more information on using `FigureWidget`.
162146

147+
See the [Troubleshooting guide](/python/troubleshooting/) if you run into any problems with JupyterLab, particularly if you are using multiple Python environments inside Jupyter.
148+
163149

164150

165151
#### Jupyter Notebook Support

0 commit comments

Comments
 (0)