revise-svc

Start Here

  • Concepts
    • What Is an SVC?
    • Route Selection
    • Confounding Factors
    • Inputs and Outputs
    • Where to Go Next
  • Quick Start
    • Install
    • Download Data
    • Run sp-SVC for hST
    • Run sc-SVC for iST
    • Run a Benchmark Case
    • Use the Python API
    • Validate a Development Checkout
    • Next Steps
  • Installation
    • Prerequisites
    • Stable Release
    • Development Install
    • Documentation Build
    • Data Layout

Run REVISE

  • Application mode
    • Choose an Application Route
    • sp-SVC Application
    • sc-SVC Application
    • Advanced Application Profiles
  • Benchmark mode
    • At a Glance
    • Supported Confounding Factors
    • Command-Line Usage
    • Python API
    • Benchmark Notebooks
      • segmentation benchmark
        • Plot seg benchmark
        • bin2cell
      • spot size benchmark
      • batch effect benchmark
        • HVG
        • All genes
      • imputation benchmark
  • Configuration
    • Mental Model
    • Resolution Order
    • Profiles
    • Router
    • Override Examples
    • Locked Parameters
    • Output Layout

Gallery

  • Application cases
    • Prepare Data
    • Application Case Notebooks
      • sp-SVC Visium HD
        • Notebook Guide
        • First glimpse at raw data
        • Spatial Autocorrelation
        • Prerequisites
        • Clustering metric
        • Input And Cache Checks
        • Plot summary ARI and NMI
        • Metric Comparison
        • Plot spatial correlation
        • Analysis CAF surrounded tumor in P1CRC
        • Dotplot analysis to visualize marker specificity
        • Marker Program Visualization
      • sc-SVC T cells
        • Notebook Guide
        • Load Reconstructed SVCs
        • Spatial Subtype Maps
        • bioinfo analysis
        • Marker And Differential Programs
      • sc-SVC Monocyte
        • Notebook Guide
        • Load Reconstructed SVCs
        • Spatial Subtype Maps
        • bioinfo analysis
        • Marker And Differential Programs
        • CCI
      • sc-SVC Fibroblast
        • Notebook Guide
        • Load Reconstructed SVCs
        • Spatial Subtype Maps
        • Marker gene analysis
        • Marker And Differential Programs
        • sc_SVC subclusters bioinformatical analysis
        • sc-SVC subtypes analysis
        • Pseudotime analysis
      • sc-SVC Visium mouse brain
        • Notebook Guide
        • Case Design And Assumptions
        • 1. Configure Paths
        • 2. Fetch The Input Files
        • 3. Load Data And Audit Contents
        • 4. Build REVISE-Ready Input Objects
        • 5. Allocate Virtual Cells From Transcript Abundance
        • 6. Save Prepared Inputs And The Virtual-Cell Prior
        • 7. Run REVISE Reconstruction
        • 8. Inspect The Reconstructed SVC Object
        • 9. Spatial Layout Of Reconstructed Cell Types
        • 10. Representative Reconstructed Gene Maps
        • 11. Expression-Space Overview
        • 12. Output Checklist

Reference

  • Architecture
    • System Map
    • Public Entry Point
    • Configuration Surface
    • Unified Lifecycle
    • Registries and Plugins
    • Run Artifacts
    • Extension Checklist
  • API
    • Pipeline
      • revise.framework.REVISEPipeline
        • REVISEPipeline
      • revise.recon.context.PipelineContext
        • PipelineContext
      • revise.recon.pipeline.UnifiedReconstructionPipeline
        • UnifiedReconstructionPipeline
      • revise.svc.SVC
        • SVC
    • Facade Helpers
      • revise.recon.facade.sp_svc
        • sp_svc()
      • revise.recon.facade.sc_svc
        • sc_svc()
    • Configuration
      • revise.config.runner_conf.ApplicationSpConf
        • ApplicationSpConf
      • revise.config.runner_conf.ApplicationScConf
        • ApplicationScConf
      • revise.config.runner_conf.ApplicationScSrConf
        • ApplicationScSrConf
      • revise.config.runner_conf.BenchmarkSrConf
        • BenchmarkSrConf
      • revise.config.runner_conf.BenchmarkSegConf
        • BenchmarkSegConf
      • revise.config.runner_conf.BenchmarkImputeConf
        • BenchmarkImputeConf
    • Analysis Services
      • revise.analysis.ScSVCAnalysisService
        • ScSVCAnalysisService
      • revise.analysis.SpSVCAnalysisService
        • SpSVCAnalysisService
      • revise.analysis.compute_metric
        • compute_metric()
      • revise.analysis.compute_clustering_metrics
        • compute_clustering_metrics()
    • Registries and Plugins
      • revise.backend.registry.StrategyRegistry
        • StrategyRegistry
      • revise.backend.registry.PluginRegistry
        • PluginRegistry
      • revise.backend.contracts.LocalRefinementStrategy
        • LocalRefinementStrategy
      • revise.backend.contracts.PlatformAdapter
        • PlatformAdapter
      • revise.backend.contracts.CFStrategy
        • CFStrategy
      • revise.backend.contracts.OTSolver
        • OTSolver
    • Backend Compatibility Runners
      • revise.backend.runners.sp_svc_application.SpSVC
        • SpSVC
      • revise.backend.runners.sc_svc_application.ScSVC
        • ScSVC
      • revise.backend.runners.sc_svc_sr_application.ScSVCSr
        • ScSVCSr
      • revise.backend.runners.sp_svc_benchmark.SpSVC
        • SpSVC
      • revise.backend.runners.sc_svc_sr_benchmark.ScSVCSr
        • ScSVCSr
      • revise.backend.runners.sc_svc_impute_benchmark.ScSVCImpute
        • ScSVCImpute
revise-svc
  • Gallery
  • View page source

Gallery

The gallery collects rendered notebooks for REVISE paper-facing application cases. Use Application Mode for the command-line routes that generate application outputs, then use the notebooks below to inspect downstream biological analyses and figures.

Prepare Data

Before opening the application case notebooks, download the REVISE data archive from Zenodo:

https://zenodo.org/record/17607778

The archive contains the Sim2Real-ST benchmark data, intermediate results, and final predictions generated for REVISE. Download Result.zip from the Zenodo record and extract it at the repository root so the notebook paths resolve to the expected local folders, including raw_data/ and generated output directories.

For application case notebooks, the relevant inputs are the real application data and the notebook-compatible outputs produced by the application wrappers:

raw_data/Real_application/
output/sp_SVC_case/
output/sc_SVC_case/

If you rerun the wrappers in Application Mode, keep these paths or update the notebook variables before executing the analysis cells.

Application Case Notebooks

sp-SVC · hST

Visium HD spatial refinement

Run the high-definition tissue case and inspect the reconstructed sp-SVC output used by downstream spatial analyses.

sc-SVC · Xenium

T cell molecular completion

Analyze reconstructed T-cell expression and spatial outputs for the P2CRC Xenium application workflow.

sc-SVC · Xenium

Monocyte state analysis

Explore monocyte-focused sc-SVC outputs, downstream cell states, and spatial patterns from the paper case.

sc-SVC · Xenium

Fibroblast spatial programs

Inspect fibroblast reconstruction outputs and downstream analyses for pathway activity and spatial organization.

sc-SVC · Visium

Mouse brain Visium example

Open the spot-based Visium mouse cortex case that runs through the public REVISEPipeline API and saves notebook QC figures.

Previous Next

© Copyright 2025-2026, Yushuai Wu and Yifeng Jiao.

Built with Sphinx using a theme provided by Read the Docs.