Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
johnlees committed Dec 12, 2023
1 parent 5af0914 commit 7335d8a
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@
<!-- badges: start -->
[![Dev build Status](https://dev.azure.com/jlees/PopPUNK/_apis/build/status/johnlees.PopPUNK?branchName=master)](https://dev.azure.com/jlees/PopPUNK/_build/latest?definitionId=1&branchName=master)
![Run tests](https://github.com/bacpop/PopPUNK/workflows/Run%20tests/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/poppunk/badge/?version=latest)](https://poppunk.readthedocs.io/)
[![Build and publish docs](https://github.com/bacpop/PopPUNK/actions/workflows/docs_push.yml/badge.svg)](https://github.com/bacpop/PopPUNK/actions/workflows/docs_push.yml)
[![Anaconda package](https://anaconda.org/bioconda/poppunk/badges/version.svg)](https://anaconda.org/bioconda/poppunk)
[![PyPI version](https://badge.fury.io/py/poppunk.svg)](https://badge.fury.io/py/poppunk)
<!-- badges: end -->

## Description

See the [documentation](http://poppunk.readthedocs.io/en/latest/) the
[paper](https://doi.org/10.1101/gr.241455.118), and [databases](https://www.bacpop.org/poppunk/).
Links:
- [Documentation](https://poppunk.bacpop.org/)
- [Databases](https://www.bacpop.org/poppunk/)
- [Paper](https://doi.org/10.1101/gr.241455.118)

If you find PopPUNK useful, please cite us:

Expand All @@ -24,11 +26,11 @@ suggested methods paragraph.

## News and roadmap

The [roadmap](https://poppunk.readthedocs.io/en/latest/roadmap.html) can be found in the documentation.
The [roadmap](https://poppunk.bacpop.org/roadmap.html) can be found in the documentation.

### 2023-01-18

We will retire the PopPUNK website. Databases have been expanded, and can be
We have retired the PopPUNK website. Databases have been expanded, and can be
found here: https://www.bacpop.org/poppunk/.

### 2022-08-04
Expand Down Expand Up @@ -62,9 +64,9 @@ possible, you can either:

## Installation

This is for the command line version. For more details see [installation](https://poppunk.readthedocs.io/en/latest/installation.html) in the documentation.
This is for the command line version. For more details see [installation](https://poppunk.bacpop.org/installation.html) in the documentation.

There are other interfaces, in-browser and through galaxy, [detailed here](https://poppunk.net/pages/interfaces.html).
Our (beta) web interface BeeBOP is now also available: https://beebop.dide.ic.ac.uk/

### Through conda (recommended)

Expand All @@ -83,8 +85,13 @@ conda config --add channels conda-forge

## Quick usage

See the [quickstart](https://poppunk.readthedocs.io/en/latest/quickstart.html) guide
for a brief tutorial.
See the [overview](https://poppunk.bacpop.org/overview.html) first.

Two ways of running:

- 1) Download an [existing database](https://www.bacpop.org/poppunk/) 2) [Run assignment](https://poppunk.bacpop.org/query_assignment.html).
- OR 1) [Create sketches of input](https://poppunk.bacpop.org/sketching.html),
2) [Run QC](https://poppunk.bacpop.org/qc.html) 3) [Build a model](https://poppunk.bacpop.org/model_fitting.html).

## Docker image

Expand Down

0 comments on commit 7335d8a

Please sign in to comment.