API Reference#
sc_tools follows the scanpy API pattern.
Import the package as import sc_tools as st and access modules via
st.pp, st.pl, st.tl, st.qc, st.memory, st.utils.
Module |
Description |
|---|---|
Preprocessing — normalization, batch integration, dimensionality reduction, clustering. |
|
Plotting — spatial plots, heatmaps, QC plots, enrichment dot plots. |
|
Tools — signature scoring, gene set loading, ORA/GSEA, deconvolution, colocalization. |
|
Quality control — QC metrics, spot filtering, sample classification, HTML reports. |
|
Ingestion — batch manifests, modality loaders (Visium/HD/Xenium/IMC), SLURM helpers. |
|
Validation — checkpoint metadata contracts (Architecture.md Section 2.2). |
|
Pipeline DAG — phase specs, dependency graph, available-next queries. |
|
Benchmarking — integration comparison, segmentation quality metrics. |
|
Storage — fsspec URI abstraction for local, S3, SFTP, GCS, Azure, Box. |
|
Registry — SQLAlchemy project/dataset/job tracking (SQLite or PostgreSQL). |
|
Memory / GPU — GPU detection, memory profiling, aggressive cleanup. |
|
Utilities — signature helpers, versioned save paths. |