matplotlib / matplotlib/ipympl

ipympl when jupyter and ipython kernel are in different conda environment

Offen
#34 10 Kommentare 6 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Jupyter Notebook
Sterne
1.7k
Forks
234
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Überprüfung der README des Repositorys sowie der in diesem Issue erwähnten dokumentierten Befehle für conda, den Jupyter-Kernel und nbextension. Kläre, welche Teile von ipympl in die Kernel-Umgebung und welche in die Jupyter-Umgebung gehören, und dokumentiere die erforderliche Einrichtung und die Symptome bei Fehlern. Bewerte außerdem, ob eine Aufteilung des conda-Pakets umsetzbar ist; als erledigt gilt die Aufgabe, wenn der Workflow mit separaten Umgebungen klar erklärt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter-notebook
Bereich
documentation, tooling
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.