Skip to content

docs: add interoperability page - #1180

Merged
LucaMarconato merged 2 commits into
scverse:mainfrom
jan-glx:docs/interoperability
Aug 19, 2026
Merged

docs: add interoperability page#1180
LucaMarconato merged 2 commits into
scverse:mainfrom
jan-glx:docs/interoperability

Conversation

@jan-glx

@jan-glx jan-glx commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

Closes #1176. Preview: https://scverse-spatialdata--1180.org.readthedocs.build/en/1180/interoperability.html

Adds a short Interoperability page listing the non-Python interfaces to the SpatialData on-disk format, following the structure of the equivalent page in mudata and the one in anndata, as requested by @Zethson so the style is consistent across the three data structures.

Sections: R (spatialdataR), JavaScript and TypeScript (SpatialData.js, Vitessce), and a short File format note (to be expanded into its osn tab later).

napari-spatialdata is not listed as it's python, relies on the spatialdata python package and does not read on-disk data directly

@codecov

codecov Bot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.41%. Comparing base (21abd1e) to head (8b9ba34).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1180   +/-   ##
=======================================
  Coverage   92.41%   92.41%           
=======================================
  Files          52       52           
  Lines        7874     7874           
=======================================
  Hits         7277     7277           
  Misses        597      597           
Files with missing lines Coverage Δ
src/spatialdata/_io/io_zarr.py 92.38% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jan-glx
jan-glx marked this pull request as draft August 18, 2026 16:05
@jan-glx

jan-glx commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator Author

Updated: the file-format section now links scverse/spatialdata-spec directly, as originally suggested, alongside the pointer to design_doc.md.

Flagging for visibility: that repository is still private, so the link will 404 for anyone outside the org until it is made public. The design-document link next to it keeps the section useful in the meantime.

Closes scverse#1176.

Adds a short Interoperability page listing non-Python interfaces to the
SpatialData on-disk format, mirroring the equivalent pages in anndata and
mudata so the style is consistent across the three data structures.

Also notes that the format builds on OME-NGFF and points at the design
document for the current on-disk layout.
@jan-glx
jan-glx force-pushed the docs/interoperability branch from aa81aa9 to 9c26df3 Compare August 18, 2026 16:43
@jan-glx
jan-glx marked this pull request as ready for review August 18, 2026 16:46

@LucaMarconato LucaMarconato left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@LucaMarconato
LucaMarconato enabled auto-merge (squash) August 19, 2026 09:33
@LucaMarconato
LucaMarconato merged commit 4d1020f into scverse:main Aug 19, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add interoperability documentation page

2 participants