matplotlib / matplotlib/ipympl

ipympl when jupyter and ipython kernel are in different conda environment

Đang mở
#34 10 bình luận 6 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Jupyter Notebook
Star
1.7k
Fork
234
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng việc xem xét README của repository và các lệnh conda, Jupyter kernel và nbextension được ghi lại trong issue. Làm rõ những phần nào của ipympl thuộc về môi trường kernel và những phần nào thuộc về môi trường Jupyter, đồng thời ghi lại thiết lập cần thiết và các triệu chứng khi gặp lỗi. Ngoài ra, hãy đánh giá xem việc tách gói conda có khả thi hay không; được coi là hoàn tất khi workflow sử dụng các môi trường riêng biệt được giải thích rõ ràng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
jupyter-notebook
Lĩnh vực
documentation, tooling
Loại issue
Tài liệu
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.