Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: make it clear pyviz_comms need to be installed next to Jupyter #5980

Merged
merged 2 commits into from
Dec 5, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ pip install panel

::::

:::{important}
Is Panel installed together with JupyterLab/Jupyter Notebook in your working environment? If not, you need to make sure that `pyviz_comms` is explicitly installed next to JupyterLab/Jupyter Notebook (`conda install pyviz_comms` or `pip install pyviz-comms`) for bi-directional communication to be fully working.
maximlt marked this conversation as resolved.
Show resolved Hide resolved
:::

:::{seealso}
If you intend to work with Panel in a non-Jupyter notebook environment such as VSCode have a quick at the [relevant how-to section](../how_to/notebook/other_nb.md).
:::
Expand Down
9 changes: 9 additions & 0 deletions doc/how_to/notebook/notebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ This guide addresses how to display output in Jupyter and non-Jupyter based note

Once you have installed Panel it should automatically set up class Jupyter notebook and JupyterLab extensions for rendering Panel output and configuring communication channels to ensure the rendered output syncs bi-directionally with the Python process.

## Run Panel in another notebook kernel

You generally have two ways to install JupyterLab/Jupyter Notebook:

1. directly in your working environment that contains all the dependencies you need to run your project
2. in another environment, maybe a central environment or an environment dedicated to Jupyter, in which case when you run a notebook you should pick the kernel of your project environment

When in the second setup, you need to ensure that `pyviz_comms` is explicitly installed next to JupyterLab/Jupyter Notebook (with `conda install pyviz_comms` or `pip install pyviz-comms`) for bi-directional communication to be fully working.
maximlt marked this conversation as resolved.
Show resolved Hide resolved

## Loading the extension

The first step when working in a notebook environment should always be to load the `panel.extension`:
Expand Down
Loading