diff --git a/README.md b/README.md index 4dbce9f3..0ed72c76 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,22 @@ # tsdate -[![CircleCI](https://circleci.com/gh/tskit-dev/tsdate.svg?style=svg)](https://circleci.com/gh/tskit-dev/tsdate) -[![codecov](https://codecov.io/gh/tskit-dev/tsdate/branch/master/graph/badge.svg)](https://codecov.io/gh/tskit-dev/tsdate) +[![License](https://img.shields.io/github/license/tskit-dev/tsdate)](https://github.com/tskit-dev/tsdate/blob/main/LICENSE) [![PyPI version](https://img.shields.io/pypi/v/tsdate.svg)](https://pypi.org/project/tsdate/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/tsdate.svg)](https://pypi.org/project/tsdate/) [![Docs Build](https://github.com/tskit-dev/tsdate/actions/workflows/docs.yml/badge.svg)](https://github.com/tskit-dev/tsdate/actions/workflows/docs.yml) [![Binary wheels](https://github.com/tskit-dev/tsdate/actions/workflows/wheels.yml/badge.svg)](https://github.com/tskit-dev/tsdate/actions/workflows/wheels.yml) [![Tests](https://github.com/tskit-dev/tsdate/actions/workflows/tests.yml/badge.svg)](https://github.com/tskit-dev/tsdate/actions/workflows/tests.yml) [![codecov](https://codecov.io/gh/tskit-dev/tsdate/branch/main/graph/badge.svg)](https://codecov.io/gh/tskit-dev/tsdate) ``tsdate`` is a scalable method for estimating the age of ancestral nodes in a [tree sequence](https://tskit.dev/tutorials/what_is.html). The method uses a coalescent prior and updates node times on the basis of the number of mutations along each edge of the tree sequence (i.e. using the "molecular clock"). -The method is frequently combined with the [tsinfer](https://tsinfer.readthedocs.io/en/latest/) algorithm, which efficiently infers tree sequence *topologies* from large genetic datasets. +The method is frequently combined with the [tsinfer](https://tskit.dev/tsinfer/docs/stable/) algorithm, which efficiently infers tree sequence *topologies* from large genetic datasets. -Please refer to the [documentation](https://tskit.dev/tsdate/docs/latest/) for information on installing and using the software. +Please refer to the documentation ([stable](https://tskit.dev/tsdate/docs/stable/) • [latest](https://tskit.dev/tsdate/docs/latest/)) for information on installing and using the software. -The algorithms for the original `inside_outside` and `maximization` [methods](https://tskit.dev/tsdate/docs/latest/methods.html) are described [in this Science paper](https://www.science.org/doi/10.1126/science.abi8264) (citation below, preprint [here](https://www.biorxiv.org/content/10.1101/2021.02.16.431497v2), evaluations in [another repository](https://github.com/awohns/unified_genealogy_paper)). The new `variational_gamma` method, the default from version 0.2 onwards, has not yet been described in print. For the moment, please cite this github repository if you need a citable reference. +## Installation + +```bash +python -m pip install tsdate +``` + +The algorithms for the original `inside_outside` and `maximization` [methods](https://tskit.dev/tsdate/docs/stable/methods.html) are described [in this Science paper](https://www.science.org/doi/10.1126/science.abi8264) (citation below, preprint [here](https://www.biorxiv.org/content/10.1101/2021.02.16.431497v2), evaluations in [another repository](https://github.com/awohns/unified_genealogy_paper)). The new `variational_gamma` method, the default from version 0.2 onwards, has not yet been described in print. For the moment, please cite this github repository if you need a citable reference. The citation to use for the original tsdate algorithms is: > Anthony Wilder Wohns, Yan Wong, Ben Jeffery, Ali Akbari, Swapan Mallick, Ron Pinhasi, Nick Patterson, David Reich, Jerome Kelleher, and Gil McVean (2022) _A unified genealogy of modern and ancient genomes_. Science **375**: eabi8264; doi: https://doi.org/10.1126/science.abi8264 -