Skip to main content

MuTopia learns topographic models of somatic mutation: it simultaneously decomposes a cohort’s mutation counts into distinct processes (signatures) and explains how local genomic context shapes each signature’s activity across the genome.

Documentation

Full documentation, API reference, and tutorials are at sigscape.github.io/MuTopia.

The site includes step-by-step tutorials covering every part of the package:

  1. Building a G-Tensor from genomic feature tracks and VCFs

  2. Analyzing G-Tensors (slicing, feature management, region queries)

  3. Training topographic models (single-fit and Optuna hyperparameter studies)

  4. Analyzing trained models (component plots, SHAP, marginal predictions)

  5. Genome-browser plotting (composable track views over any region)

System requirements

Software dependencies

  • Python 3.11 (pinned for scikit-learn==1.4.2)

  • See setup.cfg for the complete pinned dependency list.

  • CLI bioinformatics tools (auto-installed via Docker / bioconda): bedtools, bcftools, tabix, samtools, UCSC bigWigAverageOverBed.

Tested on

  • macOS

  • Linux (x86_64)

Hardware

MuTopia runs on CPU hardware — no GPU required. Training a 15-component model on a cohort of ~200 WGS samples uses ~8 GB RAM with default settings; inference and annotation use <4 GB.

Installation

MuTopia requires Python 3.11 due to a pinned scikit-learn dependency (1.4.2) used for fast gradient-boosted tree training.

With Docker (zero setup) — ~2 minutes:

docker pull allenlynch/mutopia:latest
docker run --rm -v "$PWD":/workspace allenlynch/mutopia:latest gtensor --help

With conda / bioconda — 2–4 minutes:

MuTopia is published on bioconda, which pulls in the bioinformatics tool dependencies (bedtools, bcftools, tabix, samtools) automatically:

conda create -n mutopia -c conda-forge -c bioconda -y python=3.11 mutopia
conda activate mutopia

With uv (you must install bioinformatic dependencies separately) — under 30 seconds:

# Install uv if you don't have it
curl -LsSf https://astral.sh/uv/install.sh | sh

uv venv --python 3.11 .venv
source .venv/bin/activate
uv pip install mutopia

Verify the CLI tools are on your PATH:

gtensor --help
topo-model --help
mutopia --help

Demo

The fastest way to see MuTopia in action is to apply a pre-trained model to a sample VCF. The annotate-vcf command infers which topographical mutational processes are active in your sample and annotates each mutation with its most likely generating process.

Note: this is just an example VCF; the results aren’t biologically meaningful.

docker pull allenlynch/mutopia:latest

TUMOR_TYPE="Liver-HCC"
FASTA="path/to/hg38.fasta"

ZENODO="https://zenodo.org/records/18803136/files"
MODEL=${TUMOR_TYPE}.model.pkl
DATA=${TUMOR_TYPE}.nc
wget ${ZENODO}/${MODEL}
wget ${ZENODO}/${DATA}
wget ${ZENODO}/${DATA}.regions.bed

VCF=CHC197.sample.hg38.vcf.gz
wget -O ${VCF} https://github.com/sigscape/MuTopia/releases/download/v1.0.5/CHC197.sample.hg38.vcf.gz

docker run --rm -v "$PWD":/workspace allenlynch/mutopia:latest \
   topo-model setup ${MODEL} ${DATA} ${TUMOR_TYPE}.setup.nc -@ 4

docker run --rm -v "$PWD":/workspace -v "$(dirname ${FASTA})":/fasta allenlynch/mutopia:latest \
   mutopia-sbs annotate-vcf ${MODEL} ${TUMOR_TYPE}.setup.nc ${VCF} --no-pass-only --no-cluster -fa /fasta/$(basename ${FASTA}) -w VAF -o annotated.vcf

Expected output: annotated.vcf is a copy of the input VCF with new INFO fields per record giving the most likely component (signature) for that mutation and its posterior probability.

Expected run time: ~2–3 minutes end-to-end (annotation itself ~30 seconds; the rest is the one-time G-Tensor download).

Instructions for use

To run on your own data:

  1. Annotate a VCF with a pre-trained model — follow the demo above, replacing CHC197.sample.hg38.vcf.gz with your VCF and choosing the tumor-type-matched model from the Zenodo repository.

  2. Train a new model on your cohort — see Tutorials 1-3 for the end-to-end workflow (build G-Tensor → split → train → score).

  3. Analyze a trained model — see Tutorial 4 for signature plots, SHAP feature attribution, and marginal predictions. See Tutorial 5 for genome-browser visualizations.

Preprint

Lynch AW, et al. (2026). Topographical archetypes of somatic mutagenesis in cancer.

Metadata

Release files for mutopia 1.0.9

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

Source distribution (sdist)

Source distribution for mutopia 1.0.9
File Size Uploaded Provenance
mutopia-1.0.9.tar.gz 2.3 MB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for mutopia 1.0.9
File Interpreter ABI Platform
mutopia-1.0.9-py3-none-any.whl Python 3 none any Details

Total release size: 2.7 MB

Release files / mutopia-1.0.9.tar.gz

Download URL mutopia-1.0.9.tar.gz
Size 2.3 MB
Tags Source
SHA-256 checksum
How to use checksums
0b3ddfaec3bc81bb620ae6cbd871ac17aeea100c09b5ba0726795a697cc8c7ce
BLAKE2b-256 checksum
How to use checksums
60e2e03597401f76e82ec71cf1594fe2da8daad7e12b688b3a625ac66da4628b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 7, 2026.

Transparency log

Release files / mutopia-1.0.9-py3-none-any.whl

Download URL mutopia-1.0.9-py3-none-any.whl
Size 346.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7124f30ab9a858aa6b8853742df0e51dfd3ac0f8c686810a61063a1df44bfebf
BLAKE2b-256 checksum
How to use checksums
ebd2c048a4cf1d2a6adb53038e0cf3efd68693f8adb35a69c8eac43b2a52a092
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 7, 2026.

Transparency log

Security for mutopia 1.0.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for mutopia-1.0.9.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 7, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

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