matplotlib / matplotlib/ipympl

Docs request (feature request?): Using ipympl when Jupyter and kernel are in different environments

Open
#486 5 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
1.7k
Forks
234
PR merge metrics
No merged PRs in 30d

Description

## Describe the issue

This issue is a continuation from https://github.com/matplotlib/ipympl/issues/112.

A very common use case involves a centrally-installed Jupyter instance running Jupyter kernels in various task-specific environments.

Examples include a shared Jupyterlab instance installed by a server administrator, or a single user with a highly-customized personal Jupyter configuration.

In these situations, it's usually undesirable (and sometimes impossible) for users to install and run Jupyter within their task-specific environment in order to make use of ipympl as per the official recommendation to use `pip install ipympl` for both the server/kernel-side package and the client/frontend-side extension.

What are the correct instructions for installing the "frontend" and "backend" components of ipympl separately, so that they can be used in two different environments?

If this is not currently a supported use case, consider this issue a much-desired feature request!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked ipympl issue 112 and the current official installation recommendation. Determine whether Jupyter and kernel environments can be supported separately, then document the correct frontend/backend instructions or clearly state that this use case is unsupported.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.