Skip to main content

MSP logo: distinct cell populations sharing sample colors

MSP: Multi-Sample Pipeline

Find recurring noise and annotate cell types across samples.

Python 3.10 or newer MIT license Part of the ECA-RSI ecosystem

Why MSP   ·   Workflow   ·   Get started   ·   Results   ·   Documentation

MSP uses cross-sample integration to identify recurring noisy populations and annotate cell types in single-cell RNA-seq data. It combines Harmony, cluster structure, and QC evidence in a browser report, with optional AI agents for inspection and annotation. Start from OSP outputs or your own compatible H5AD files.

Why review samples together?

Outliers are scarce within one sample, but similar noisy cells can recur across many samples. After integration, they can accumulate into dense groups, separating from the main populations while retaining traces of their cell-type identity. This repeated core-and-satellite pattern, or fractal structure, makes noise that was scattered within samples easier to locate and assess together. Recurrence across samples can therefore reveal shared technical effects as well as shared biology.

From structure to noise filtering

MSP locates separated fragments within broad cell populations and compares their QC profiles with core cells. Contamination, doublet, stress, mitochondrial, and inherited QC evidence contribute removal candidates. AI inspection checks markers, sample composition, and cluster structure; annotation applies removals and records their sources. A detached group needs supporting evidence before being interpreted as noise.

How it works

Integration builds the shared map and finds fragments. Inspection reviews quality and biological evidence. Annotation assigns broad and fine labels, merges groups judged to represent the same population, and writes a filtered dataset. The report brings the structures, evidence, and decisions together.

Sample H5AD files enter integration to reveal core and satellite fragments; optional AI inspection reviews QC and markers without removing cells; annotation applies labels, merges, and removals to a separate dataset. Each stage updates the HTML report.

Get started

1. Install

Use Python 3.10 or newer in a separate environment. Install from PyPI with AI support; omit [agent] if you only need integration. No GPU or torch is needed: Harmony runs on the CPU through harmonypy 2.

python -m pip install "msp-sc[agent]"

For the development version, install from GitHub instead:

python -m pip install "msp-sc[agent] @ git+https://github.com/chansigit/msp.git"

2. Prepare your samples

Provide one H5AD per sample, with raw counts in layers["counts"] and a sample column in obs. Files must share the same genes in the same order, and cell IDs must be unique across files. Replace the paths and sample_id below with your own; see the user guide for details.

3. Run the analysis

This command integrates samples and creates msp_out/report.html without an API key. To include AI inspection and annotation, follow the example below it.

python -m msp A/clustered.h5ad B/clustered.h5ad \
    --batch-col sample_id --species human --outdir msp_out
Add AI inspection and annotation

This example uses Doubao through Volcengine Ark and requires an Ark API key with model access; provider charges may apply. --annotate also runs inspection. For other runtimes, see AI configuration.

export ARK_API_KEY="YOUR_ARK_API_KEY"
python -m msp A/clustered.h5ad B/clustered.h5ad \
    --batch-col sample_id --species human --outdir msp_out \
    --annotate --harness openai --model doubao-seed-2-1-turbo-260628

Add --design-context "one plate = one mouse x one FACS sort gate" when sample identity encodes the study design: the text is shown verbatim to the inspection and annotation agents (and kept in msp_out/design_context.txt) so a cluster confined to one sample is judged against the design rather than as a batch artefact.

Find and understand your results

Open msp_out/report.html in your browser; download it first if you ran on a server. Start with sample composition and cell maps, then compare flagged groups against their markers and QC. Review the proposed labels, merges, and removals before downstream analysis. The HTML embeds its plots and can be shared as one file.

Output What you get
report.html Cell maps, quality evidence, and completed AI reviews.
integrated.h5ad All input cells in the shared space, with inspection proposals when available.
annotated.h5ad Retained cells with broad and fine cell-type labels after annotation.
annotation_removed.csv Removed cell IDs and the sources of each removal decision.

FAQ

Does MSP remove cells?

Integration and inspection retain all cells. Annotation applies the union of integration's removal candidates, inspection's drop proposals, and its own removal decisions. It writes survivors to annotated.h5ad, preserves integrated.h5ad, and records removed cells in annotation_removed.csv.

Can I continue or rerun an analysis?

Repeat the command to reuse completed steps. Use --force or a new output directory when replacing input contents at the same path or changing the AI model. Rerunning a stage archives its previous outputs and invalidates later stages; see rerunning.

Do I need OSP or ECA-RSI?

MSP runs independently with compatible inputs. OSP handles sample-level QC and annotation; ZMIP continues with closer analysis of individual lineages. ECA-RSI coordinates these steps and iterative review, starting from data prepared with ECA-PP.

Documentation

Read the user guide for input preparation, report reading, and reruns, or the developer guide for APIs, data fields, and stage contracts. A folder-based example runs MSP over OSP outputs. Questions and problems belong in GitHub Issues. MSP uses the MIT license.

Metadata

Release files for msp-sc 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for msp-sc 0.4.0
File Size Uploaded
msp_sc-0.4.0.tar.gz 122.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for msp-sc 0.4.0
File Interpreter ABI Platform
msp_sc-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 216.7 kB

Release files / msp_sc-0.4.0.tar.gz

Download URL msp_sc-0.4.0.tar.gz
Size 122.7 kB
Tags Source
SHA-256 checksum
How to use checksums
faadf1303e589c008cade4925866bef486ff2016c7b2ad8c5aa297ec68ba62b1
BLAKE2b-256 checksum
How to use checksums
a7a5fe50c1ba4b0fff8dc572c30c68711bc07ec93ad9ab530665cc70877485a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.1

Release files / msp_sc-0.4.0-py3-none-any.whl

Download URL msp_sc-0.4.0-py3-none-any.whl
Size 94.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c5335c069da21354734468f33aeaf997814693cdd10d41432e356007e3fa3f2a
BLAKE2b-256 checksum
How to use checksums
9010fe830b9cfb6079eac046203c20068407362ac1d0a79e5bda4dcbaab4bb8e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.1

Release history Release notifications | RSS feed

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

This release

0.4.0 This release

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page