Add a GUI guide with screenshots to README and docs#35
Merged
Conversation
README gains "A tour of the GUI" — loading images, background subtraction with model switching, the FFT viewer, and the Feature finder, each with a screenshot — plus a link to the new docs/gui.md, which walks through the same workflows step by step in the style of the CLI guide and points at ROIs, measurements, spectroscopy, and export. Screenshots are captured from the real widgets rendered offscreen against test_data fixtures by scripts/generate_gui_screenshots.py; rerun it after UI changes to refresh docs/images/. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This was referenced Jun 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents the GUI in the same task-oriented style as the CLI guide, with screenshots of the real widgets.
docs/gui.mdadded to the Documentation list.featuresextra, plus pointers to ROIs, measurements, spectroscopy, and provenance-carrying export.test_datafixtures and writesdocs/images/*.png(~720 KB total), so the screenshots can be regenerated after UI changes. Fixtures are copied to a temp dir (sidecars write next to scans) and the user's~/.probeflow_config.jsonis left untouched.Screenshot subjects: terraced topograph for the viewer and background dialog (clear step edges, visible residual structure), the moiré
.sxmfor FFT (hexagonal superlattice spots) and the Feature finder (minima detection marking each moiré site).Verification
ruff check probeflow tests scriptsclean; full suite 2449 passed, 3 skipped.🤖 Generated with Claude Code