From 51645affbcac8576af7b2afad84805113786e197 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Tue, 11 Aug 2026 06:56:30 -0700 Subject: [PATCH 1/2] docs: add ARINA Show4DSTEM Jupyter notebook quick start --- README.md | 37 ++++--------------------------------- docs/intro.md | 27 +++++++++++++++++++++------ 2 files changed, 25 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index b5e6d08c..b7c47749 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,10 @@ and 5D-STEM segmentation and clustering work ([paper](https://academic.oup.com/mam/article-abstract/32/3/ozag044/8701498)) and the source data ([Zenodo](https://zenodo.org/records/18167694)). +**[Start with the documentation](https://electronmicroscopy.github.io/quantem.widget/)** +to load ARINA 4D-STEM data in Jupyter, open `Show4DSTEM`, and explore the +interactive widgets. + > `quantem.widget` is currently a prototype on > [TestPyPI](https://test.pypi.org/project/quantem-widget/) and is built on the > [`quantem`](https://github.com/electronmicroscopy/quantem) core. @@ -31,39 +35,6 @@ pip install -i https://test.pypi.org/simple/ \ See the [installation guide](https://electronmicroscopy.github.io/quantem.widget/install.html) for backend setup, Colab instructions, and verification. -## Quick start - -Open an image or microscopy dataset without writing a notebook: - -```bash -quantem show image.tif -quantem show3d ./frames/ -quantem show4dstem ./masters/ -``` - -Or construct widgets directly in Python: - -```python -import numpy as np -from quantem.widget import Show2D, Show4DSTEM - -Show2D(np.random.random((512, 512))) -Show4DSTEM(np.random.random((64, 64, 128, 128))) -``` - -For real 4D-STEM data, load a master file onto the available GPU: - -```python -from quantem.gpu.io import load -from quantem.widget import Show4DSTEM - -Show4DSTEM(load("scan_master.h5")) -``` - -The [command-line guide](https://electronmicroscopy.github.io/quantem.widget/cli.html) -and [tutorials](https://electronmicroscopy.github.io/quantem.widget/tutorials/download_data.html) -cover data loading, HTML export, public example datasets, and complete workflows. - ## Widgets | Widget | Use it for | Learn more | diff --git a/docs/intro.md b/docs/intro.md index e35d2369..7e10a367 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -13,15 +13,30 @@ and 5D-STEM segmentation and clustering work ([paper](https://academic.oup.com/mam/article-abstract/32/3/ozag044/8701498)) and the source data ([Zenodo](https://zenodo.org/records/18167694)). +## Start with ARINA 4D-STEM in Jupyter + +The demo above is the same `Show4DSTEM` workflow you can use at the microscope. +After [installing](install), open a Jupyter notebook, load a completed ARINA +`*_master.h5` file, and pass the result directly to the widget: + ```python from quantem.gpu.io import load -from quantem.widget import Show1D, Show2D, Show3D, Show3DSlices, Show4DSTEM, ShowPtycho, ShowEDS, ShowDiffraction, ShowFolder +from quantem.widget import Show4DSTEM + +data = load("/data/session/scan_000_master.h5") +viewer = Show4DSTEM(data) +viewer ``` -## Quickest start: no notebook needed +`load(...)` selects CUDA or Apple Metal automatically. Leave `viewer` as the +final line, then move through scan positions or drag the detector to update the +virtual image. Continue with the [Show4DSTEM tutorial](tutorials/show4dstem) or +[Load and I/O](api/io). + +## Prefer the command line? -After [installing](install), point the `quantem` command at a file or folder and -it renders the right viewer in your browser: +Point the `quantem` command at a file or folder when you want the same viewers +without writing a notebook: ```bash quantem show2d image.tif # an image -> Show2D @@ -29,8 +44,8 @@ quantem show3d ./frames/ # a folder of frames -> Show3D scrub quantem show4dstem ./masters/ # 4D-STEM master(s) -> live viewer (or --html) ``` -It saves to `~/Downloads`, opens automatically, and picks the GPU (CUDA / Apple -Metal) for you. Full details on [the command line](cli) page. +It saves to `~/Downloads`, opens automatically, and picks the GPU for you. Full +details are on [the command line](cli) page. ## Built for two platforms From f6f7802b44f12b04621bb1879f87852692423e47 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Tue, 11 Aug 2026 07:07:16 -0700 Subject: [PATCH 2/2] docs: simplify pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 52 +++++++++++++++----------------- 1 file changed, 25 insertions(+), 27 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a1fc1bf6..f2678903 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,40 +1,36 @@ - -## Summary +### What should reviewer(s) do? - + -## Verification +### Verification + ---