GUI Walkthrough#
A screenshot-driven tour through the PhenoTypic hub — from a fresh sandbox to a finished run with viewable results. Each page is short and focused on a single workflow so you can jump to whichever step you need.
The walkthrough uses a small synthetic yeast plate dataset (3 plates, 8 × 12
grid each, generated with phenotypic.data.make_synthetic_plate) so you can
follow along without your own data. The accompanying capture script
scripts/capture_gui_tutorial_screenshots.py
regenerates the synthetic plates, runs the CLI to produce real output, and
takes every screenshot in this guide — re-run it after a GUI change to keep
the images aligned with the implementation.
What’s covered#
Page |
Goal |
|---|---|
Generate the synthetic dataset and launch the hub. |
|
Deep-zoom the raw input images under a source root with cascading dropdowns and a metadata panel. |
|
Flip Browse to Timeline mode and navigate a folder/EXIF matrix with arrow keys to find a starting time and deep-zoom any frame. |
|
Navigate the sandbox sidebar and read capability badges. |
|
Compose a pipeline.json with the fixed linear port map, side loader, and zoom controls. |
|
Submit a local subprocess run and tail the dashboard. |
|
Fill in SLURM resources and ship a submission to a cluster. |
|
Open the results viewer against a finished CLI output. |
|
Curate detected colonies manually with the in-builder point picker. |
|
Compose |
|
Fill operation-typed parameters (e.g. |
|
Configure |
|
Pick a measurement and walk through time on a plate to spot edge / contamination patterns. |
|
Select a gold side port, watch it turn green, and fill it with a compatible palette operation. |
|
Fill a side value with |
|
Triage the toolbar issue badge, fix missing side values, and understand unsupported development DAG states. |
|
Switch the QC tab to Review; walk worst-first groups for a module, curate in the tile gallery, mark reviewed, and watch the metric recompute in place. |
|
Open the |
|
Rank the measurements that separate an error category from the good baseline, read off a cutoff, and copy a filter spec. |
|
Open the results-viewer Timeline tab, pick a Y grouping + a monotonic X time column, scan one plate’s overlay time-course, and deep-zoom any plate. |
Prerequisites#
PhenoTypic installed via
uv sync --group dev(see Getting Started).Playwright with Chromium installed if you want to regenerate the screenshots yourself:
uv run playwright install chromium.
For a comprehensive reference of every panel, store, and admonition in the hub, see the GUI hub guide. This walkthrough is the “happy path”; the reference is the manual.