Metadata-Version: 2.4
Name: fastplotlib-ndwidget-checkpoint
Version: 0.6.1.post194
Summary: Unofficial checkpoint build of the fastplotlib ndwidget branch (0.6.1+194 commits, a75b6bf) packaged for downstream pinning. Installs as `fastplotlib`.
Keywords: visualization,science,interactive,pygfx,webgpu,wgpu,vulkan,gpu
Author: Kushal Kolar, Caitlin Lewis
Maintainer-email: Flynn OConnell <flynnoconnell@gmail.com>
Requires-Python: >= 3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2.1.0
Requires-Dist: pygfx==0.16.0
Requires-Dist: wgpu
Requires-Dist: cmap>=0.1.3
Requires-Dist: fastplotlib-ndwidget-checkpoint[docs, notebook, tests, imgui] ; extra == "dev"
Requires-Dist: sphinx ; extra == "docs"
Requires-Dist: sphinx-gallery ; extra == "docs"
Requires-Dist: pydata-sphinx-theme ; extra == "docs"
Requires-Dist: glfw ; extra == "docs"
Requires-Dist: ipywidgets>=8.0.0,<9 ; extra == "docs"
Requires-Dist: sphinx-copybutton ; extra == "docs"
Requires-Dist: sphinx-design ; extra == "docs"
Requires-Dist: pandoc ; extra == "docs"
Requires-Dist: imageio[ffmpeg] ; extra == "docs"
Requires-Dist: matplotlib ; extra == "docs"
Requires-Dist: scikit-learn ; extra == "docs"
Requires-Dist: ome-zarr ; extra == "docs"
Requires-Dist: wgpu[imgui] ; extra == "imgui"
Requires-Dist: jupyterlab ; extra == "notebook"
Requires-Dist: jupyter-rfb>=0.5.1 ; extra == "notebook"
Requires-Dist: ipywidgets>=8.0.0,<9 ; extra == "notebook"
Requires-Dist: sidecar ; extra == "notebook"
Requires-Dist: simplejpeg ; extra == "notebook"
Requires-Dist: pytest ; extra == "tests"
Requires-Dist: nbmake ; extra == "tests"
Requires-Dist: black ; extra == "tests"
Requires-Dist: scipy ; extra == "tests"
Requires-Dist: imageio[ffmpeg] ; extra == "tests"
Requires-Dist: scikit-learn ; extra == "tests"
Requires-Dist: tqdm ; extra == "tests"
Requires-Dist: ome-zarr ; extra == "tests"
Project-URL: Documentation, https://www.fastplotlib.org/
Project-URL: Homepage, https://github.com/flynnoconnell/fastplotlib-ndwidget-checkpoint
Project-URL: Repository, https://github.com/flynnoconnell/fastplotlib-ndwidget-checkpoint
Project-URL: Upstream, https://github.com/fastplotlib/fastplotlib
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: imgui
Provides-Extra: notebook
Provides-Extra: tests

> ### Unofficial checkpoint fork
>
> This is **not** the official fastplotlib. It is an unmodified snapshot of the
> [fastplotlib/fastplotlib](https://github.com/fastplotlib/fastplotlib) `ndwidget` **branch** at commit
> [`a75b6bf`](https://github.com/fastplotlib/fastplotlib/commit/a75b6bf) (2026-09-18), which is v0.6.1 plus 194 commits.
> It exists only so that downstream projects can pin a released version instead of a
> git SHA, because `NDWidget` and friends live on that branch and are in no upstream release.
>
> **The only changes to upstream are packaging metadata** (distribution name, version,
> URLs). No library code is modified.
>
> **This installs as `fastplotlib`.** It provides the same top-level `fastplotlib`
> package as the real thing, so the two cannot coexist in one environment:
>
> ```bash
> pip uninstall -y fastplotlib
> pip install fastplotlib-ndwidget-checkpoint
> ```
>
> Use the [official fastplotlib](https://github.com/fastplotlib/fastplotlib) unless you specifically need this checkpoint.
> This fork will be retired once upstream releases these features.

---

<p align="center">
<img src="https://github.com/fastplotlib/fastplotlib/blob/main/docs/source/fastplotlib_logo.svg" height="220" alt="logo">
</p>

---

<p align="center">
  <a href="https://github.com/fastplotlib/fastplotlib/actions/workflows/ci.yml"><img src="https://github.com/fastplotlib/fastplotlib/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
  <a href="https://badge.fury.io/py/fastplotlib"><img src="https://badge.fury.io/py/fastplotlib.svg" alt="PyPI version"></a>
  <a href="https://fastplotlib.org/ver/dev/"><img src="https://github.com/fastplotlib/fastplotlib/actions/workflows/docs-deploy.yml/badge.svg" alt="Deploy docs"></a>
  <a href="https://zenodo.org/doi/10.5281/zenodo.13365890"><img src="https://zenodo.org/badge/485481453.svg" alt="DOI"></a>
</p>

<p align="center">
  <a href="https://github.com/fastplotlib/fastplotlib#installation"><b>Installation</b></a> |
  <a href="https://github.com/kushalkolar/fastplotlib#graphics-drivers"><b>GPU Drivers</b></a> |
  <a href="https://github.com/fastplotlib/fastplotlib#documentation"><b>Documentation</b></a> |
  <a href="https://github.com/kushalkolar/fastplotlib#examples"><b>Examples</b></a> |
  <a href="https://github.com/kushalkolar/fastplotlib#heart-contributing"><b>Contributing</b></a>
</p>

Next-gen plotting library built using the [`pygfx`](https://github.com/pygfx/pygfx) rendering engine that utilizes [Vulkan](https://en.wikipedia.org/wiki/Vulkan), [DX12](https://en.wikipedia.org/wiki/DirectX#DirectX_12), or [Metal](https://developer.apple.com/metal/) via WGPU, so it is very fast! `fastplotlib` is an expressive plotting library that enables rapid prototyping for large scale exploratory scientific visualization.

<div align="center">
  <img src=https://github.com/user-attachments/assets/5c6bede6-e0cb-4867-bb9b-f86cc5e98619 width="1000" /> 
</div>

> **Note:**
> `fastplotlib` is currently in the **late alpha stage**, but you're welcome to use it or contribute! See our [Roadmap](https://github.com/kushalkolar/fastplotlib/issues/55). Also, see this for a discussion on API stability: https://github.com/fastplotlib/fastplotlib/issues/121

# What are *some* things I can do with `fastplotlib`?

- GPU-accelerated visualization

- interactive visualization via an intuitive and expressive API

- rapid prototyping and algorithm design

- easy exploration and fast rendering of large-scale data

- design, develop, evaluate, and ship machine learning models

- create visualizations for real-time acquisition systems for scientific instruments (cameras, etc.)

# Supported frameworks

`fastplotlib` can run on anything that [`pygfx`](https://github.com/pygfx/pygfx) can also run, this includes:

:heavy_check_mark: `Jupyter lab`, using [`jupyter_rfb`](https://github.com/vispy/jupyter_rfb)\
:heavy_check_mark: `PyQt` and `PySide`\
:heavy_check_mark: `glfw`\
:heavy_check_mark: `wxPython`

Write your code once and run it anywhere. Whether you are using `Qt`, `glfw`, `jupyter lab`, or doing offscreen rendering, `fastplotlib` works across all major platforms (Linux, Windows, Mac OS X) :smile: See the [FAQ](https://www.fastplotlib.org/ver/dev/user_guide/faq.html) for more details on where and how you can use `fastplotlib`.

# Documentation

http://www.fastplotlib.org/ver/dev

Questions, issues, ideas? You are welcome to post an [issue](https://github.com/fastplotlib/fastplotlib/issues) or post on the [discussion forum](https://github.com/fastplotlib/fastplotlib/discussions)! :smiley: 

# Installation

To install use pip:

### With imgui support (recommended)

Without jupyterlab support, install desired GUI framework such as glfw, PyQt6, or PySide6 separately.

    pip install -U "fastplotlib[imgui]"

With jupyterlab support.

    pip install -U "fastplotlib[notebook,imgui]"

### Without imgui

Minimal, install desired GUI library such as PyQt6, PySide6, or glfw separately.

    pip install fastplotlib

With jupyterlab support only.

    pip install -U "fastplotlib[notebook]"

Fastplotlib is also available on conda-forge. For imgui support you will need to separately install `imgui-bundle`, and for jupyterlab you will need to install `jupyter-rfb` and `simplejpeg` which are all available on conda-forge.


> **Note:**
> `fastplotlib` and `pygfx` are fast evolving projects, the version available through pip might be outdated, you will need to follow the "For developers" instructions below if you want the latest features. You can find the release history here: https://github.com/fastplotlib/fastplotlib/releases

### For developers

Make sure you have [git-lfs](https://github.com/git-lfs/git-lfs#installing) installed.

```bash
git clone https://github.com/fastplotlib/fastplotlib.git
cd fastplotlib

# install all extras in place
pip install -e ".[notebook,docs,tests,imgui]"

# install latest pygfx
pip install git+https://github.com/pygfx/pygfx.git@main
```

See [Contributing](https://github.com/fastplotlib/fastplotlib?tab=readme-ov-file#heart-contributing) for more details on development

# Examples

Examples gallery: http://fastplotlib.org/ver/dev/_gallery/index.html

User guide: http://fastplotlib.org/ver/dev/user_guide/guide.html

`fastplotlib` code is identical across notebook (`jupyterlab`), and desktop use with `Qt`/`PySide` or `glfw`. 

**Notebooks**

The `quickstart.ipynb` tutorial notebook is a great way to get familiar with the API: https://github.com/fastplotlib/fastplotlib/tree/main/examples/notebooks/quickstart.ipynb

# GPU drivers and requirements

Generally if your GPU is from 2017 or later it should be fine. Modern integrated graphics are usually fine for many use cases. The exact requirements will depend on how complex your visualization is and how many objects you need to render.

More detailed information on GPUs and drivers is here: http://fastplotlib.org/ver/dev/user_guide/gpu.html

For more detailed information, such as use on cloud computing infrastructure, see the WGPU docs: https://wgpu-py.readthedocs.io/en/stable/start.html#cloud-compute

# Contributing :heart:

We welcome contributions! See the contributing guide: https://github.com/fastplotlib/fastplotlib/blob/main/CONTRIBUTING.md

You can also take a look at our [**Roadmap for 2026**](https://github.com/fastplotlib/fastplotlib/issues/55) and [**Issues**](https://github.com/fastplotlib/fastplotlib/issues) for ideas on how to contribute!

# Developers :brain:

- [**Kushal Kolar**](https://github.com/kushalkolar)

- [**Caitlin Lewis**](https://github.com/clewis7)

- [**Almar Klein**](https://github.com/almarklein)

- [**Amol Pasarkar**](https://github.com/apasarkar)

A special thanks to all of the `pygfx` developers and the amazing work they have done. 

# Sponsors

Fastplotlib is free and open source. We would like to thank the following institutions for helping to support fastplotlib over the past few years.

- UNC Chapel Hill, Giovannucci Lab & Hantman Lab
- NYU & Flatiron Institute CCN, Williams lab & Chklovskii Lab
- Duke University, Pearson Lab
- Columbia University, Paninski lab

We are always open to new sponsors that can help further develop and improve the library.

