aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/matplotlib-inline/README.md
diff options
context:
space:
mode:
authornkozlovskiy <nmk@ydb.tech>2023-09-29 12:24:06 +0300
committernkozlovskiy <nmk@ydb.tech>2023-09-29 12:41:34 +0300
commite0e3e1717e3d33762ce61950504f9637a6e669ed (patch)
treebca3ff6939b10ed60c3d5c12439963a1146b9711 /contrib/python/matplotlib-inline/README.md
parent38f2c5852db84c7b4d83adfcb009eb61541d1ccd (diff)
downloadydb-e0e3e1717e3d33762ce61950504f9637a6e669ed.tar.gz
add ydb deps
Diffstat (limited to 'contrib/python/matplotlib-inline/README.md')
-rw-r--r--contrib/python/matplotlib-inline/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/contrib/python/matplotlib-inline/README.md b/contrib/python/matplotlib-inline/README.md
new file mode 100644
index 0000000000..21c64188ce
--- /dev/null
+++ b/contrib/python/matplotlib-inline/README.md
@@ -0,0 +1,38 @@
+# Matplotlib Inline Back-end for IPython and Jupyter
+
+This package provides support for matplotlib to display figures directly inline in the Jupyter notebook and related clients, as shown below.
+
+## Installation
+
+With conda:
+
+```bash
+conda install -c conda-forge matplotlib-inline
+```
+
+With pip:
+
+```bash
+pip install matplotlib-inline
+```
+
+## Usage
+
+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.
+
+This will produce a figure immediately below:
+
+```python
+%matplotlib inline
+
+import matplotlib.pyplot as plt
+import numpy as np
+
+x = np.linspace(0, 3*np.pi, 500)
+plt.plot(x, np.sin(x**2))
+plt.title('A simple chirp');
+```
+
+## License
+
+Licensed under the terms of the BSD 3-Clause License, by the IPython Development Team (see `LICENSE` file).