Skip to content

Add Visium card to Examples in gallery#657

Merged
timtreis merged 3 commits into
mainfrom
feat/gallery-add-visium-card
May 11, 2026
Merged

Add Visium card to Examples in gallery#657
timtreis merged 3 commits into
mainfrom
feat/gallery-add-visium-card

Conversation

@timtreis
Copy link
Copy Markdown
Member

@timtreis timtreis commented May 11, 2026

Summary

Adds the Visium mouse-brain notebook to the gallery's Examples section as a card with thumbnail. Reframes the Tutorials/Examples split to make it explicit:

  • Tutorials: entry-point material for learning the API on synthetic data (currently: getting_started on `blobs`).
  • Examples: worked examples on real datasets you'd actually analyse (currently: Visium mouse brain via `squidpy.datasets.visium_hne_sdata`).

Drops the now-stale "no examples yet" placeholder note from the Examples section.

Changes

File Change
`docs/gallery.md` Reframe section descriptions; replace placeholder with a Visium card (`grid-item-card` with `:img-top:` thumbnail).
`docs/_static/gallery/visium_mouse_brain.png` New 156 KB thumbnail (Mbp expression overlay on H&E, `figsize=(4,4)` at 80 DPI).

No new dependencies. Local docs build verified clean under `-W`.

Dependency

Depends on scverse/spatialdata-plot-notebooks#2 which moves `visium_mouse_brain.ipynb` from `tutorials/` to `examples/`. The card on this PR links to `notebooks/examples/visium_mouse_brain`, which only resolves once #2 merges and the next docs build pulls fresh notebooks main (`post_checkout: git submodule update --init --remote --recursive`).

The Visium mouse-brain notebook moved from tutorials/ to examples/ in
spatialdata-plot-notebooks (matching the convention: tutorials teach
the API on synthetic data, examples demonstrate it on real datasets).
Add the corresponding card + thumbnail to the gallery's Examples grid;
drop the "no examples yet" placeholder note that's now stale.

Tutorials section reframed to make the split explicit ("entry-point
material for learning the API on synthetic data" vs Examples'
"worked examples on real datasets you'd actually analyse").

Depends on scverse/spatialdata-plot-notebooks#2 for the file move; CI
will fail on this PR until that merges and the lib's submodule pull
catches up.
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.07%. Comparing base (6687b87) to head (0ce6980).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #657   +/-   ##
=======================================
  Coverage   77.07%   77.07%           
=======================================
  Files          11       11           
  Lines        3280     3280           
  Branches      774      774           
=======================================
  Hits         2528     2528           
  Misses        454      454           
  Partials      298      298           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis timtreis merged commit 84e5da7 into main May 11, 2026
7 of 8 checks passed
@timtreis timtreis deleted the feat/gallery-add-visium-card branch May 11, 2026 17:51
timtreis added a commit that referenced this pull request May 12, 2026
PR #657 added the card originally; the placeholder note slipped back
in during a later rebase. Restores the card and ships the refreshed
thumbnail from the updated notebook (publication-style figure
colouring spots by Mbp expression on the H&E tissue).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants