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 -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

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.

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.8.tar.gz (10.5 MB 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.8-py3-none-any.whl (8.5 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mutopia-1.0.8.tar.gz
Algorithm Hash digest
SHA256 971c50978d26a13b08adb18acf1cde2f565648b53a52813f7dfd91159980797c
MD5 8f1e485926d94328898ed99fb8f56b60
BLAKE2b-256 7ed1d43c2cead7229649637625e82df14fa85a376facc9c860f82e12d1a3f166

See more details on using hashes here.

Provenance

The following attestation bundles were made for mutopia-1.0.8.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.8-py3-none-any.whl.

File metadata

  • Download URL: mutopia-1.0.8-py3-none-any.whl
  • Upload date:
  • Size: 8.5 MB
  • 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 84f8db3b7299fba32252a26786dbee8bec8ba83798d86ea19a7023b8db2ae488
MD5 07f8a4ba550a28ffe44f7e73f600fff7
BLAKE2b-256 b3bf1143c2211e4d7935e784a1d86c48424e692bd0253dd6fae91d7585d7fdb1

See more details on using hashes here.

Provenance

The following attestation bundles were made for mutopia-1.0.8-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