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.

Sign up for GitHub

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

Jump to bottom

Add versions table #217

Merged
merged 1 commit into from
May 18, 2020
Merged

Add versions table #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 41 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,56 @@ magic:

```bash
conda install -c conda-forge ipympl

# If using JupyterLab
conda install -c conda-forge nodejs
jupyter labextension install @jupyter-widgets/jupyterlab-manager jupyter-matplotlib
```

### With pip:

```bash
pip install ipympl
```

# If using JupyterLab
# Install nodejs: https://nodejs.org/en/download/
jupyter labextension install @jupyter-widgets/jupyterlab-manager jupyter-matplotlib
### Install the JupyterLab extension

In order to install the JupyterLab extension `jupyter-matplotlib`, you will first need to install `nodejs`, you can install it with `conda` doing

```bash
conda install -c conda-forge nodejs
```

Starting from ipympl `0.5.6`, **you do not need to manually install the JupyterLab extension**, but you still need to install the JupyterLab widget manager:
```bash
jupyter labextension install @jupyter-widgets/jupyterlab-manager

# If you already installed the @jupyter-widgets/jupyterlab-manager extension, you will still need to rebuild JupyterLab after you installed ipympl
jupyter lab build
```

#### Install an old JupyterLab extension

You will need to install the right `jupyter-matplotlib` version, according to the `ipympl` and `jupyterlab` versions you installed.
For example, if you installed ipympl `0.5.1`, you need to install jupyter-matplotlib `0.7.0`, and this version is only compatible with JupyterLab `1`.

```bash
const install -c conda-forge ipympl==0.5.1
jupyter labextension install @jupyter-widgets/jupyterlab-manager [email protected]
```

Versions lookup table:


| `ipympl` | `jupyter-matplotlib` | `JupyterLab version` |
|----------|----------------------|----------------------|
| 0.5.6 | 0.7.2 | 1 or 2 |
| ... | ... | ... |
| 0.5.3 | 0.7.2 | 1 or 2 |
| 0.5.2 | 0.7.1 | 1 |
| 0.5.1 | 0.7.0 | 1 |
| 0.5.0 | 0.6.0 | 1 |
| 0.4.0 | 0.5.0 | 1 |
| 0.3.3 | 0.4.2 | 1 |
| 0.3.2 | 0.4.1 | 1 |
| 0.3.1 | 0.4.0 | 0 or 1 |

### For a development installation (requires nodejs):

```bash
Expand Down