Mievformer

Getting Started

  • Installation
    • Requirements
      • Optional Dependencies
    • Installation via pip
    • Installation from source
    • GPU Support
    • Docker Installation
      • Building the Docker Image
      • Running with GPU Support
      • Running the Tutorial
      • Interactive Mode
    • Troubleshooting
      • NumPy Compatibility
      • Missing igraph/leidenalg
      • TensorBoard Not Found
    • Verifying Installation
  • Getting Started: Single-Slice Analysis
    • 1. Create spatial data
    • 2. Learn microenvironments and identify niches
    • 3. Compare cell-state-dependent niche preferences
    • 4. Map conditional population probabilities
    • 5. Find expression signatures associated with colocalization
  • Multi-Batch Analysis
    • Prepare the AnnData object
    • Learn microenvironments across slices
    • Explore shared niches and sample differences
    • Retain sample information for reproducibility

User Guide

  • Probabilistic Coupling of Cell States and Microenvironments
    • Defining a microenvironment through continuous cell states
    • Learning the context-state relationship
    • Biological analyses from the same probabilistic coupling
      • Cell state to niche: preferences within a cell population
      • Tissue context to population: conditional population probabilities
      • Linking molecular variation to local tissue organization
    • Multiple spatial slices
  • API Reference
    • Core Model Functions
      • optimize_nicheformer()
      • calculate_wb_ez()
    • Niche Density Ratio and Membership
      • calculate_niche_density_ratio()
      • calculate_niche_cluster_membership()
    • Downstream Analysis
      • estimate_population_density()
      • analyze_density_correlation()
      • analyze_niche_membership()
    • Representation and Stored Outputs

About

  • Release Notes
    • Version 0.3.0 (2026)
      • Changed
      • Added
      • Removed
      • Compatibility
    • Version 0.2.0 (2026)
      • Changed (Breaking — API rename for semantic clarity)
      • Fixed
      • Preserved
      • Added
    • Version 0.1.0 (2025)
      • Features
      • Documentation
  • References
    • Citing Mievformer
    • Related Work
      • Spatial Transcriptomics Methods
      • Deep Learning Frameworks
      • Single-Cell Analysis
    • Contact
Mievformer
  • Index
  • Edit on GitHub

Index

A | C | E | O

A

  • analyze_density_correlation() (in module mievformer)
  • analyze_niche_membership() (in module mievformer)

C

  • calculate_niche_cluster_membership() (in module mievformer)
  • calculate_niche_density_ratio() (in module mievformer)
  • calculate_wb_ez() (in module mievformer)

E

  • estimate_population_density() (in module mievformer)

O

  • optimize_nicheformer() (in module mievformer)

© Copyright 2025, NicheDynamics.

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