pyXenium#

Nine canonical sections for Xenium I/O, multimodal analysis, CCI, pathway topology, contour geometry, GMI inference, mechanostress analysis, and external workflow bridges.

pyXenium is a Python toolkit for 10x Genomics Xenium organized around nine major sections: pyXenium.io, pyXenium.multimodal, pyXenium.cci, pyXenium.pathway, pyXenium.contour, pyXenium.gmi, pyXenium.mechanostress, the external AI pathology bridge via spatho, and the Perturb-seq handoff bridge via pyXenium.perturb. This site keeps those sections visible first, then maps them to tutorials, guides, workflows, and API pages.

pyXenium nine-feature overview figure

pyXenium’s nine-feature overview connects Xenium data loading, multimodal spatial analysis, topology-aware biology, contour-native inference, mechanostress analysis, and optional external workflow bridges.#

Version & Build#

PyPI version Read the Docs CI Python versions License

Nine core sections#

Xenium I/O

Load Xenium exports, recover partial bundles, round-trip XeniumSlide, and export compat stores.

Xenium data loading
Multimodal Analysis

Work with the canonical pyXenium.multimodal surface for RNA + protein preparation and joint analysis.

Multimodal overview
Cell-Cell Interaction

Walk through topology-native cell-cell interaction analyses and compare Atera breast benchmark outputs.

pyXenium.cci
Pathway Topology

Connect pathway topology scoring to cell-state programs on the same Xenium study.

pyXenium.pathway Tutorial
Contour Geometry

Generate HistoSeg-backed annotations, contour-level transcript summaries, and boundary-aware density profiles.

pyXenium.contour
GMI Inference

Build contour pseudo-bulk matrices and run GMI main-effect, interaction, and validation workflows.

Contour-GMI guide
Mechanostress

Compute fibroblast axis strength, tumor-stroma growth patterning, and cell polarity from Xenium morphology.

pyXenium.mechanostress Atera/PDC tutorial
AI-Driven Spatial Pathologist

Call the external spatho workflow on Xenium cases structured by pyXenium XeniumSlide.

AI-Driven Spatial Pathologist via spatho
SpatialPerturb Bridge

Generate handoff specs for Perturb-seq reference projection with the external SpatialPerturb CLI.

SpatialPerturb Bridge

Documentation entry points#

Installation / Quickstart

Install pyXenium, set up the docs environment, and run your first Xenium workflow.

Installation and quickstart
Tutorials hub

Browse notebook-style walkthroughs for all nine sections, including the optional external bridges.

Tutorials
User guide

Read focused guides for Xenium I/O, multimodal preparation, contour analysis, and contour GMI inference.

User guide
Workflows

Run packaged renal and Atera workflows with standardized artifact bundles and report-ready outputs.

Workflows
API reference

Browse curated autosummary pages for the canonical pyXenium namespaces and the SpatialPerturb bridge helpers.

API reference
Changelog

Track documentation, branding, and package-level changes.

Changelog

Feature areas#

  • pyXenium.io: Xenium artifact loading, partial export recovery, XeniumSlide store I/O, and slide export.

  • pyXenium.multimodal: canonical RNA + protein loading, immune-resistance scoring, joint analyses, and packaged multimodal workflows.

  • pyXenium.cci: topology-native cell-cell interaction analysis primitives.

  • pyXenium.pathway: pathway topology analysis and pathway activity scoring.

  • pyXenium.contour: GeoJSON contour import and contour-aware density profiling around polygon annotations.

  • pyXenium.gmi: contour-level GMI modeling for sparse main-effect and interaction discovery in spatial transcriptomics.

  • pyXenium.mechanostress: morphology-derived mechanical stress states from cell/nucleus boundaries and tumor-stroma context.

  • AI-Driven Spatial Pathologist via spatho: optional external AI pathology review workflow built on pyXenium’s XeniumSlide case structure, not a pyXenium runtime dependency.

  • pyXenium.perturb: SpatialPerturb Bridge for optional Perturb-seq reference projection onto Xenium tissue through the external SpatialPerturb package.