8000 unpinning JupyterLab 1 from instructions · samaffolter/plotly.py@b51abcb · GitHub
[go: up one dir, main page]
Skip to content

Commit b51abcb

Browse files
nicolaskruchtennicolaskruchten
committed
unpinning JupyterLab 1 from instructions
1 parent c94047a commit b51abcb

File tree

3 files changed

+33
-50
lines changed

3 files changed

+33
-50
lines changed

‎README.md

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -112,44 +112,27 @@ For use in JupyterLab, install the `jupyterlab` and `ipywidgets`
112112
packages using pip...
113113

114114
```
115-
pip install jupyterlab==1.2 "ipywidgets==7.5"
115+
pip install jupyterlab "ipywidgets=7.5"
116116
```
117117

118118
or conda.
119119

120120
```
121-
conda install jupyterlab=1.2
122-
conda install "ipywidgets=7.5"
121+
conda install jupyterlab "ipywidgets=7.5"
123122
```
124123

125124
Then run the following commands to install the required JupyterLab extensions (note that this will require [`node`](https://nodejs.org/) to be installed):
126125

127126
```
128-
# Avoid "JavaScript heap out of memory" errors during extension installation
129-
# (OS X/Linux)
130-
export NODE_OPTIONS=--max-old-space-size=4096
131-
# (Windows)
132-
set NODE_OPTIONS=--max-old-space-size=4096
127+
# Basic JupyterLab renderer support
128+
jupyter labextension install jupyterlab-plotly@4.7.0
133129
134-
# Jupyter widgets extension
135-
jupyter labextension install @jupyter-widgets/jupyterlab-manager@1.1 --no-build
136-
137-
# FigureWidget support
138-
jupyter labextension install plotlywidget@4.7.0 --no-build
139-
140-
# and jupyterlab renderer support
141-
jupyter labextension install jupyterlab-plotly@4.7.0 --no-build
142-
143-
# Build extensions (must be done to activate extensions since --no-build is used above)
144-
jupyter lab build
145-
146-
# Unset NODE_OPTIONS environment variable
147-
# (OS X/Linux)
148-
unset NODE_OPTIONS
149-
# (Windows)
150-
set NODE_OPTIONS=
130+
# OPTIONAL: Jupyter widgets extension for FigureWidget support
131+
jupyter labextension install @jupyter-widgets/jupyterlab-manager plotlywidget@4.7.0
151132
```
152133

134+
Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab.
135+
153136
### Static Image Export
154137

155138
plotly.py supports static image export using the `to_image` and `write_image`

‎doc/python/getting-started.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -134,29 +134,11 @@ $ conda install "ipywidgets=7.5"
134134
Then run the following commands to install the required JupyterLab extensions (note that this will require [`node`](https://nodejs.org/) to be installed):
135135

136136
```
137-
# Avoid "JavaScript heap out of memory" errors during extension installation
138-
# (OS X/Linux)
139-
export NODE_OPTIONS=--max-old-space-size=4096
140-
# (Windows)
141-
set NODE_OPTIONS=--max-old-space-size=4096
137+
# JupyterLab renderer support
138+
jupyter labextension install jupyterlab-plotly@4.7.0
142139
143-
# Jupyter widgets extension
144-
jupyter labextension install @jupyter-widgets/jupyterlab-manager@1.1 --no-build
145-
146-
# jupyterlab renderer support
147-
jupyter labextension install jupyterlab-plotly@4.7.0 --no-build
148-
149-
# FigureWidget support
150-
jupyter labextension install plotlywidget@4.7.0 --no-build
151-
152-
# Build extensions (must be done to activate extensions since --no-build is used above)
153-
jupyter lab build
154-
155-
# Unset NODE_OPTIONS environment variable
156-
# (OS X/Linux)
157-
unset NODE_OPTIONS
158-
# (Windows)
159-
set NODE_OPTIONS=
140+
# OPTIONAL: Jupyter widgets extension
141+
jupyter labextension install @jupyter-widgets/jupyterlab-manager plotlywidget@4.7.0
160142
```
161143

162144
These packages contain everything you need to run JupyterLab...
@@ -175,14 +157,16 @@ fig = go.Figure(data=go.Bar(y=[2, 3, 1]))
175157
fig.show()
176158
```
177159

178-
or using `FigureWidget` objects.
160+
or using `FigureWidget` objects (if the "OPTIONAL" step above was executed).
179161

180162
```python
181163
import plotly.graph_objects as go
182164
fig = go.FigureWidget(data=go.Bar(y=[2, 3, 1]))
183165
fig
184166
```
185167

168+
Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab.
169+
186170
<!-- #region -->
187171

188172
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`.

‎doc/python/troubleshooting.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,30 @@ To list your current extensions, run the following command in a terminal shell:
7575
$ jupyter labextension list
7676
```
7777

78-
To uninstall your `plotly` extensions, run the following commands in a terminal shell before reinstalling them by following the instructions in the [Getting Started guide](/python/getting-started):
78+
To uninstall your Plotly extensions, run the following commands in a terminal shell before reinstalling them by following the instructions in the [Getting Started guide](/python/getting-started):
7979

8080
```bash
8181
$ jupyter labextension uninstall jupyterlab-plotly
8282
$ jupyter labextension uninstall plotlywidget
8383
```
8484
<!-- #endregion -->
8585

86-
```python
86+
If you run into "out of memory" problems while installing the extensions, try running these commands before running `jupyter labextension install`...
87+
88+
```
89+
# Avoid "JavaScript heap out of memory" errors during extension installation
90+
# (OS X/Linux)
91+
export NODE_OPTIONS=--max-old-space-size=4096
92+
# (Windows)
93+
set NODE_OPTIONS=--max-old-space-size=4096
94+
```
95+
96+
...and these commands afterwards.
8797

8898
```
99+
# Unset NODE_OPTIONS environment variable
100+
# (OS X/Linux)
101+
unset NODE_OPTIONS
102+
# (Windows)
103+
set NODE_OPTIONS=
104+
```

0 commit comments

Comments
 (0)
0