Skip to main content

Large timetrees

Project description

Chronumental

Chron​ologies from mon​umental phylogenetic trees


Chronumental is a tool for creating a "time-tree" (where distance on the tree represents time) from a phylogenetic divergence-tree (where distance on the tree reflects a number of genetic substitutions).

What sets Chronumental apart from most other tools is that it scales to extremely large trees, which can contain millions of nodes. Chronumental uses JAX to represent the task of computing a time tree in a differentiable graph for efficient calculation on a CPU or GPU.

📝 Read the preprint

📚 View the documentation

Installation

Method 1: Using pipx (recommended for basic use - installs in its own isolated environment)

pip install --local pipx
pipx install  chronumental

Method 2: In your python environment

pip install chronumental

Method 3: Bioconda

Chronumental is now available on bioconda

conda config --add channels bioconda
conda install chronumental

Usage

This demo uses trees and metadata collated by the UShER team.

wget https://hgwdev.gi.ucsc.edu/~angie/UShER_SARS-CoV-2/2021/10/06/public-2021-10-06.all.nwk.gz
wget https://hgwdev.gi.ucsc.edu/~angie/UShER_SARS-CoV-2/2021/10/06/public-2021-10-06.metadata.tsv.gz
chronumental --tree public-2021-10-06.all.nwk.gz --dates public-2021-10-06.metadata.tsv.gz --steps 100

📚 Please visit our documentation page to learn more about the parameters you can use to control Chronumental.

Integrations

Taxonium can automatically call Chronumental, and generate a combined visualisation that allows switching between distance and time phylogenies

Similar tools

TreeTime is a more advanced tool for inferring time trees. If you have a dataset of e.g. <10,000 rather than millions of nodes you are definitely best off trying it. The TreeTime readme also links to other similar tools.

Troubleshooting

  • Chronumental uses the earliest date in your dataset as an anchor to calibrate everything else. If this earliest date is wrong due to a metadata error things won't work well.

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

chronumental-0.0.51.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

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

chronumental-0.0.51-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file chronumental-0.0.51.tar.gz.

File metadata

  • Download URL: chronumental-0.0.51.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for chronumental-0.0.51.tar.gz
Algorithm Hash digest
SHA256 37e8592831605a60ee818e1aa7bc6db41a754ad283d65c7e089e90c214223fbd
MD5 32e869b1a2be8079e2b5bef74e7b151e
BLAKE2b-256 03e811e14d0b219980f0fe9af2ba56762bd7b862da50fa74325c16e420af3e65

See more details on using hashes here.

File details

Details for the file chronumental-0.0.51-py3-none-any.whl.

File metadata

  • Download URL: chronumental-0.0.51-py3-none-any.whl
  • Upload date:
  • Size: 13.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for chronumental-0.0.51-py3-none-any.whl
Algorithm Hash digest
SHA256 baff245d39def767e13dbf7fc8444ecc258d3219a772e6ebfa957c85d7ca32bb
MD5 05e6b307f213362505cf951155133e2a
BLAKE2b-256 717ac9aa49f9983f8bc61e2f9ac6e410640700e079feba523e479a5ca0bc0fa4

See more details on using hashes here.

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