when running additonal jupyter kernels, jupyterlab extension must be installed in the default environment

[surchs]

Currently, the docs for jupyterlab support (e.g. here or here) imply that the user installs both jupyter, plotly, and the jupyterlab-plotly extension in the same python environment.

In jupyter, users can register existing python environments that are then available as additional kernels to run notebooks on. This helps users avoid running jupyter notebooks on the python environment serving the jupyterlab instance or to install jupyter in every python instance they want to run jupyter notebooks in. In my experience, users often have one environment to start the jupyter server in, and then several different kernels for different projects they are working on.

If a user is expecting to install and use plotly in such a setup (1 python environment for jupyter, a separate one to run plotly in) then she needs to install the jupyterlab-plotly extension (and therefore jupyter itself) in both environments. This is not necessarily intuitive and doesn't fail in a very explicit way if done incorrectly (e.g. here).

edit: This is not actually true. Only the environment running the jupyter server needs the jupyterlab-plotly extension. The environment executing inside jupyterlab only needs nbformat as an additional dependency. This is correctly raised by ValueError: Mime type rendering requires nbformat>=4.2.0 but it is not installed. So the only case that may be unintuitive is if the user, incorrectly, installs the jupyterlab-plotly extension in the environment used to execute inside jupyter but not in the one serving jupyter. In this case, figures remain blank.

Setup

I set up 4 conda environments that either have or do not have the jupyterlab-plotly extension installed: 2 to run the jupyter server and 2 to install and run plotly inside a jupyter lab instance:
edit: the below example is not correct. Only the server environment needs the jupyterlab-plotly extension. The processing environment needs nbformat, but no extensions.

serv-no

Plain jupyter server environment as it might be installed by following the jupyter docs

conda create -n serv-no jupyter jupyterlab -y

serv-yes

Same as serv-no, but also includes the jupyterlab-plotly extension

conda create -n serv-yes jupyter jupyterlab "ipywidgets=7.5" -y
conda activate serv-yes
jupyter labextension install [email protected]
conda deactivate

proc-no

plain environment with plotly installed, but no jupyterlab-plotly extension. Needs ipykernel to register the kernel with the jupyter notebook server. Needs python=3.8 because ipykernel not yet available for 3.9.

conda create -n proc-no python=3.8 -y
conda install -n proc-no -c plotly plotly=4.12.0 ipykernel pandas -y
conda activate proc-no
python -m ipykernel install --user --name procno --display-name "proc-no"
conda deactivate

proc-yes

Same as proc-no, but also installed jupyterlab and jupyterlab-plotly extension edit: nbformat

conda create -n proc-yes python=3.8 -y
conda install -n proc-yes -c plotly plotly=4.12.0 ipykernel pandas jupyterlab -y
conda activate proc-yes
python -m ipykernel install --user --name procyes --display-name "proc-yes"

jupyter labextension install [email protected]

edit: this environment only needs nbformat to work as expected. The reason the above example works is because installing jupyter also installs nbformat. But jupyter is not needed in the processing environment. This is correctly explained by raised ValueError. So instead we can just do:

conda install nbformat -y

Reproduce

1. source server environment, e.g.: conda activate serv-no
2. start jupyterlab jupyter lab
3. select a kernel, e.g. proc-yes
4. run any plotting example from the plotly docs, e.g.

import plotly.express as px
df = px.data.iris()
fig = px.scatter(df, x="sepal_width", y="sepal_length", color="species")
fig.show()

edit: this example fails, but only because the server environment is missing the jupyterlab-plotly extension.

Outcome

	proc-no does not have extension edit: nbformat	proc-yes has extension edit: nbformat
serv-no does not have extension	🤷‍♀️ (doesn't work, not expected to, edit: but the error message also doesn't point to the underlying problem): ValueError: Mime type rendering requires nbformat>=4.2.0 but it is not installed	😭 (doesn't work, probably not expected to edit: user got the installation backwards): Blank Figure / Doesn't get rendered / no error message
serv-yes has extension	😭 (doesn't work, could reasonably be expected to work): ValueError: Mime type rendering requires nbformat>=4.2.0 but it is not installed edit: all that is needed to fix is in the error message	👍 All is good

I think two possible fixes would be:
1. Add a warning or note to the docs, that the installation instructions assume that jupyter, the extension, and plotly are installed in the same environment and that things can break if not
2. Add a section to the docs for multi-kernel setups that clarifies that the installation of jupyter and the extension needs to also be done in the environment that will run plotly edit: that the extension must be installed for the server environment for plotly to work correctly.

[nyngwang]

@surchs Hi, your detailed report finally helps someone like me two years(and more) later:

• I installed the nbformat on the kernel-env according to the error message.
  • At this stage, the code did run but only a blank cell was presented as you had reported.
• I executed the command jupyter labextension install jupyterlab-plotly you provide on the server jupyter-env. It works now: