Skip to content

Commit 4b9ca8d

Browse files
committed
Update README install/description.
List correct package in installation instructions and provide updated description, clarifying `%matplotlib inline` magic isn't needed anymore in default clients.
1 parent 3347d0f commit 4b9ca8d

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
11
# Matplotlib Inline Back-end for IPython and Jupyter
22

3+
This package provides support for matplotlib to display figures directly inline in the Jupyter notebook and related clients, as shown below.
4+
35
## Installation
46

57
With conda:
68

79
```bash
8-
conda install -c conda-forge notebook matplotlib
10+
conda install -c conda-forge matplotlib-inline
911
```
1012

1113
With pip:
1214

1315
```bash
14-
pip install notebook matplotlib
16+
pip install matplotlib-inline
1517
```
1618

1719
## Usage
1820

19-
This package is included in IPython and can be used in a Jupyter Notebook:
21+
Note that in current versions of JupyterLab and Jupyter Notebook, the explicit use of the `%matplotlib inline` directive is not needed anymore, though other third-party clients may still require it.
22+
23+
This will produce a figure immediately below:
2024

2125
```python
2226
%matplotlib inline
@@ -28,3 +32,7 @@ x = np.linspace(0, 3*np.pi, 500)
2832
plt.plot(x, np.sin(x**2))
2933
plt.title('A simple chirp');
3034
```
35+
36+
## License
37+
38+
Licensed under the terms of the BSD 3-Clause License, by the IPython Development Team (see `LICENSE` file).

0 commit comments

Comments
 (0)