Matplotlib aware interact functions
Project description
mpl-interactions
This library provides helpful ways to interact with Matplotlib plots. There are three submodules:
jupyter
Provides a different approach than ipywidgets.interact to making sliders that affect a matplotlib plot. When using interact you are responsible for:
- Defining the function to plot
f(x,...) => y - Handling the plotting logic (
plt.plot,fig.cla,ax.set_ylim, etc)
In contrast, with mpl-interactions you only need provide f(x, ...) => y and the plotting and updating boilerplate are handled for you.
x = np.linspace(0,6,100)
beta = np.linspace(0,5*np.pi)
def f(x, beta):
return np.sin(x*4+beta)
interactive_plot(f, x=x, beta=beta)
While this will work with any backend except for %matplotlib inline you should try to use these with %matplotlib ipympl which uses ipympl as this will have the best performance and UX in a notebook.
generic
Ways to interact with matplotlib that will work outside of a jupyter notebook and should work equally well with any backend.
- A very niche (but very cool) way to compare 2D heatmaps
- scroll to zoom
- middle click to pan
utils
utility functions that make things just the little bit easier
ioffas a context manager
from mpl_interactions.utils import ioff
with ioff:
# interactive mode will be off
fig = plt.figure()
# other stuff
# interactive mode will be on
figurethat accepts a scalar forfigsize- this will scale the default dimensions
from mpl_interactions.utils import figure
fig = figure(3)
# the default figsize is [6.4, 4.8], this figure will have figsize = [6.4*3, 4.8*3]
nearest_idx- avoid ever having to writenp.argmin(np.abs(arr - value))again.
Installation
pip install mpl_interactions
# if using jupyterlab
conda install -c conda-forge nodejs>10
jupyter labextension install @jupyter-widgets/jupyterlab-manager
If you use jupyterlab make sure you follow the full instructions in the ipympl readme https://github.com/matplotlib/ipympl#install-the-jupyterlab-extension in particular installing jupyterlab-manager.
Contributing / feature requests / roadmap
I use the Github issues to keep track of ideas I have, looking through those should serve as a roadmap of sorts. For the most part I add to the library when I create a function that is useful for the science I am doing. If you create somethign that seems useful a PR would be most welcome so we can share it easily with more people. I'm also open to feature requests if you have an idea.
Documentation
Definitely a work in progress - I would recommend checking out the examples directory for now. https://mpl-interactions.readthedocs.io/en/latest/
Examples with GIFs!
Tragically neither github nor the sphinx documentation render the actual moving plots so here are gifs of the functions. The code for these can be found in the notebooks in the examples directory.
interactive_plot
Easily make a line plot interactive:
heatmap_slicer
Compare vertical and horizontal slices across multiple heatmaps:
scrolling zoom + middle click pan
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mpl_interactions-0.2.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 41767bcb258831adc910a9d24159a73930f3692592766980d0459aafd1e50e9b |
|
| MD5 | adc7f3b82a9601c2ba687933eaa221fe |
|
| BLAKE2b-256 | ad740b40b33ea4b8d85ef1fa340212a98c39391e57e1c4d3475a60df1e5929a3 |
