Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

vn-os/fastplotlib_python_fast_plot_quick_usage

 
 

Repository files navigation

fastplotlib

Gitter

A fast plotting library built using the pygfx render engine utilizing Vulkan via WGPU, so it is very fast! fastplotlib is focussed on very fast interactive plotting in the notebook using an expressive API. It also works within desktop applications using glfw or Qt.

fastplotlib is currently in the early alpha stage with breaking changes every ~week, but you're welcome to try it out or contribute! See our Roadmap for 2023.

Questions, ideas? Post an issue or chat on gitter.

epic

Examples

See the examples directory. Start out with simple.ipynb.

Neuroscience usecase demonstrating some of fastplotlib's capabilities

neuroscience_usecase.mp4

Simple image plot

from fastplotlib import Plot
import numpy as np

plot = Plot()

data = np.random.rand(512, 512)
plot.add_image(data=data)

plot.show()

image

Fast image updates

from fastplotlib import Plot
import numpy as np

plot = Plot()

data = np.random.rand(512, 512)
image = plot.image(data=data)

def update_data():
    new_data = np.random.rand(512, 512)
    image.data = new_data

plot.add_animations(update_data)

plot.show()

out

Interactivity

interact

This is all in the notebook and non-blocking!

Image widget

Interactive visualization of large imaging datasets in the notebook.

zfish

Installation

Install directly from GitHub using pip.

pip install git+https://github.com/kushalkolar/fastplotlib.git

Note: do not download the version that is currently on PYPI (i.e. don't just do pip install fastplotlib, it is outdated (we're waiting for the next release of pygfx)

Installing simplejpeg is recommended for faster plotting in notebooks using rfb. You will need C compilers setup on your computer to install it:

pip install simplejpeg

Clone or download the repo to try the examples

# clone the repo
git clone https://github.com/kushalkolar/fastplotlib.git

# cd into examples and launch jupyter lab
cd fastplotlib/examples
jupyter lab

You will need a GPU that supports Vulkan (iGPUs in CPUs should be fine). Generally if your GPU is from 2017 or later it should support Vulkan. See the section on "Install Vulkan drivers" below for more information.

For Development

git clone https://github.com/kushalkolar/fastplotlib.git
cd fastplotlib
pip install -r requirements.txt
pip install -e .

# try the examples
cd examples
jupyter lab

Install Vulkan drivers

For more information see: https://github.com/pygfx/wgpu-py#platform-requirements

Windows:

Vulkan should be installed by default on Windows 11, but you will need to install your GPU manufacturer's driver package (Nvidia or AMD). If you have an integrated GPU within your CPU, you might still need to install a driver package too, check your CPU manufacturer's info.

Linux:

Debian based distros:

sudo apt install mesa-vulkan-drivers
# for better performance with the remote frame buffer install libjpeg-turbo
sudo apt install libjpeg-turbo

For other distros install the appropriate vulkan driver package, and optionally the corresponding libjpeg-turbo package for better remote-frame-buffer performance in jupyter notebooks.

Mac OSX:

You will need at least MacOSX v10.13, not sure how to install Vulkan drivers on Mac. If anyone knows you can add instructions here!

Gallery

Extremely fast image updates, 5 x 5 gridplot

https://www.youtube.com/embed/-_0Gp_EqepI

Very fast image updates with some synced controllers

fpl_fast_image_updates.mp4

4x Grid of Scatter plots, 1.2 million points each

https://user-images.githubusercontent.com/9403332/165677576-a0aa2d0f-a201-4e0e-91bd-aed800f775ee.mp4

Lineplot

fpl_lineplot.mp4

About

A fast plotting library

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%
Morty Proxy This is a proxified and sanitized view of the page, visit original site.