Skip to main content

No project description provided

Project description

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.

Installation

MuTopia requires Python 3.11 due to a pinned scikit-learn dependency (1.4.2) used for fast gradient-boosted tree training. We recommend uv — it resolves and installs the full dependency set in seconds and keeps environments reproducible across machines.

With Docker (zero setup)

The pre-built image ships with MuTopia plus all the bioinformatics tools it needs (bedtools, bcftools, tabix, UCSC bigWigAverageOverBed):

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

With uv (recommended for native installs)

# 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

With conda / bioconda

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

Verify the CLI tools are on your PATH:

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

Five minutes to MuTopia

The fastest way to get started is to:

  1. Pull the docker.

  2. Download a pre-trained model from our Zenodo repository.

  3. Apply it to your mutation data. 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, so the results aren’t 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 allenlynch/mutopia:latest \
   mutopia-sbs annotate-vcf ${MODEL} ${TUMOR_TYPE}.setup.nc ${VCF} --no-pass-only --no-cluster -fa ${FASTA} -w VAF -o annotated.vcf

MuTopia can do a lot more than just data annotation. Check out the tutorials for walkthroughs on data munging, model training, and mutational topography analysis!

Documentation

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

Citation

If you use MuTopia in your research, please cite:

Lynch AW, et al. (2025). MuTopia: topographic modeling of mutational processes
across the cancer genome. [Preprint]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mutopia-1.0.7.tar.gz (271.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mutopia-1.0.7-py3-none-any.whl (307.2 kB view details)

Uploaded Python 3

File details

Details for the file mutopia-1.0.7.tar.gz.

File metadata

  • Download URL: mutopia-1.0.7.tar.gz
  • Upload date:
  • Size: 271.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mutopia-1.0.7.tar.gz
Algorithm Hash digest
SHA256 062a91513b8f2be8c61146e55f25489fb5183ce7f1972a9aebcfca2eca81dca0
MD5 05eccf7d9894be670550511497faf9d1
BLAKE2b-256 da70c4a97ca35dfb9557dd31d8e2988dc3a9a53df3ca64b84944fc52c70e71be

See more details on using hashes here.

Provenance

The following attestation bundles were made for mutopia-1.0.7.tar.gz:

Publisher: publish.yml on sigscape/MuTopia

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mutopia-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: mutopia-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 307.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mutopia-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1ce6ed9967eac733dbc983c5157a5a577e1787aeb9124c4aacce8c82305aee55
MD5 91a7d94a1045ee62390acace6a7bad14
BLAKE2b-256 d60b4845cbc2802067f9e7b7b05dbcf00dd9f1d4aad8cc124177523fea146e65

See more details on using hashes here.

Provenance

The following attestation bundles were made for mutopia-1.0.7-py3-none-any.whl:

Publisher: publish.yml on sigscape/MuTopia

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page