Skip to content

Repository files navigation

quantem.widget

TestPyPI

Interactive, GPU-accelerated visualization widgets for 4D-STEM and electron microscopy. Use them in Jupyter notebooks, as local HTML files, or from the command line. NumPy, PyTorch, CuPy, CUDA, Apple Silicon, and browser WebGPU workflows are supported.

Show4DSTEM WebGPU demo with a diffraction pattern and live virtual detector image

Demo: Show4DSTEM HTML with WebGPU. Explore live diffraction-pattern and virtual-detector views locally in a browser on a personal laptop or supported phone, without a Python kernel or remote compute server. Thanks to Serin Lee for sharing this liquid-cell Au nanoparticle 4D-STEM dataset. Check Serin's 4D-STEM and 5D-STEM segmentation and clustering work (paper) and the source data (Zenodo).

Start with the documentation to load ARINA 4D-STEM data in Jupyter, open Show4DSTEM, and explore the interactive widgets.

quantem.widget is currently a prototype on TestPyPI and is built on the quantem core.

Install

pip install -i https://test.pypi.org/simple/ \
  --extra-index-url https://pypi.org/simple/ quantem.widget

See the installation guide for backend setup, Colab instructions, and verification.

Widgets

Widget Use it for Learn more
Show1D Scientific traces, reconstruction metrics, and live monitors API
Show2D Images, contrast, FFTs, ROIs, profiles, and scale bars tutorial · API
Show3D Scrub and play through image or volume stacks tutorial · API
Show3DSlices Inspect orthogonal slices through a 3D volume tutorial · API
Show4DSTEM Live virtual detectors, multi-dataset review, and WebGPU HTML export tutorial · export guide · API
ShowPtycho Interactive SSB phase and aberration review API
ShowDiffraction Measure diffraction spots, rings, spacing, and angles tutorial · API
ChooseLattice Select an origin and lattice vectors API
ShowEDS Explore linked EDS/EELS maps and spectra
ShowFolder Browse, group, and select microscopy session files tutorial · API

Documentation

Visit the quantem.widget documentation for installation, tutorials, API references, command-line workflows, data I/O, HTML sharing, and WebGPU export guidance.

quantem.widget bridges scientific data and computational algorithms. We recommend agent-assisted development so researchers can spend less time writing interface code and more time discovering scientific insight. Start with the copyable agent-assisted development prompts for opening ARINA data, designing a widget, or preparing a pull request.

Citing quantem.widget

If the quantEM interactive framework—including quantem.widget, GPU-accelerated I/O, analysis, or reconstruction workflows on MPS or CUDA—contributed to your research, please consider citing Lee et al., Interactive Framework for Real-Time 4DSTEM Analysis and Reconstruction, Microscopy and Microanalysis 32 (Supplement 1), ozag053.941 (2026), https://doi.org/10.1093/mam/ozag053.941.

Contributing

Contributions are welcome. Read CONTRIBUTING.md for setup, tests, documentation standards, and the pull-request workflow. That workflow follows the reproducible scientific-software procedures described by scikit-package.

Questions and bug reports belong in the issue tracker.

About

Bring human interactivity into data, compute, physics: 60 fps+ on multidimensional datasets

Topics

Resources

Contributing

Stars

4 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages