matplotlib / matplotlib/ipympl
ipympl when jupyter and ipython kernel are in different conda environment
- Dominant language
- Jupyter Notebook
- Stars
- 1.7k
- Forks
- 234
- PR merge metrics
- No merged PRs in 30d
Description
Hi,
## Some context
I typically install the jupter notebook in a conda environment, and create a shortcut on the desktop to launch jupyter-notebook.exe (windows 10 64 bits). Then I create an ipython kernel with all dependencies I want to work with in an other environment, and I register this kernel-in-a-conda-environment with the command
```
ipython kernel install --user --name NameOfMyNewKernel
```
I find this workflow relatively clean because I can chose when I want to update either my kernel (bleeding edge or very old depending on this situation) independently from the notebook itself.
## The problem
As far as I understand `ipympl` is really 2 packages.
- One is a python package called ```ipympl``` that must be installed together with your `ipython` kernel, because you need to write `import ipympl` in your notebook.
- The other one is a javascript package (I supposed it is called also ipympl) that must be installed together with the jupyter notebook application. I don't know if the python package is required or not. You also need to make sure that the javascript package is registered as an _extension_ (`jupyter nbextension enable --py --sys-prefix ipympl`) by jupyter.
If this is documented somewhere it is well hidden ;-)
## The workaround
I installed 2 times the ipympl package, one in my kernel environment, the other in the jpuyter environment. For the latter case, because the python package is also shipped in the ipympl conda package, matplotlib is installed but I think that is useless. With this, everyting works, I am able to see interactive plots in my notebook.
Before figuring out that I needed to install `ipympl` in the jupyter environment, I received weird error messages without really explaining what the problem was.
## Proposal
1. Document the problem. I suppose that this repository README coud explain this, but I suppose it should be also documented somewhere in matplotlib and/or jupyter documentation. I must admit I find the jupyter documentation really hard to navigate though.
2. Split ipympl conda package in two: one that contains the python package and the other one containing the javascript package.
Thanks
Contributor guide
Research direction
Start by reviewing the repository README and the documented conda, Jupyter kernel, and nbextension commands mentioned in the issue. Clarify which parts of ipympl belong in the kernel environment versus the Jupyter environment, and document the required setup and failure symptoms. Also assess whether splitting the conda package is feasible; done means the separate-environment workflow is clearly explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100