tools for comparing DNA sequences with MinHash sketches
Project description
sourmash
Compute MinHash signatures for nucleotide (DNA/RNA) and protein sequences.
Usage:
sourmash compute *.fq.gz
sourmash compare *.sig -o distances
sourmash plot distances
sourmash 1.0 is published on JOSS; please cite that paper if you use sourmash (doi: 10.21105/joss.00027):.
The name is a riff off of Mash, combined with @ctb's love of whiskey. (Sour mash is used in making whiskey.)
Primary authors: C. Titus Brown (@ctb) and Luiz C. Irber, Jr (@luizirber).
sourmash is a product of the Lab for Data-Intensive Biology at the UC Davis School of Veterinary Medicine.
Installation
We recommend using bioconda to install sourmash:
conda install -c conda-forge -c bioconda sourmash
This will install the latest stable version of sourmash 3.
You can also use pip to install sourmash:
pip install sourmash
A quickstart tutorial is available.
Requirements
sourmash runs under both Python 2.7.x and Python 3.5+. The base
requirements are screed and ijson, together with a Rust environment (for the
extension code). We suggest using rustup to install the Rust environment:
curl https://sh.rustup.rs -sSf | sh
The comparison code (sourmash compare) uses numpy, and the plotting
code uses matplotlib and scipy, but most of the code is usable without
these.
For search and gather you also need khmer version 2.1+.
Installation with conda
Bioconda is a channel for the conda package manager with a focus on bioinformatics software. After installing conda you will need to add the bioconda channel as well as the other channels bioconda depends on. Once you have setup bioconda, you can install sourmash by running:
$ conda create -n sourmash_env -c conda-forge -c bioconda sourmash python=3.7
$ source activate sourmash_env
$ sourmash compute -h
which will install the latest alpha release.
Support
Please ask questions and files issues on Github.
Development
Development happens on github at dib-lab/sourmash.
After installation, sourmash is the main command-line entry point;
run it with python -m sourmash, or do pip install -e /path/to/repo to
do a developer install in a virtual environment.
The sourmash/ directory contains the Python library and command-line interface code.
The src/core/ directory contains the Rust library implementing core
functionality.
Tests require py.test and can be run with make test.
Please see the developer notes for more information.
CTB Jan 2020
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file sourmash-3.3.0.tar.gz.
File metadata
- Download URL: sourmash-3.3.0.tar.gz
- Upload date:
- Size: 7.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2bdf64fdb306123fee0f2ba8e6b58caf2ff4a73a25cbe1fe563dd7de141c648f |
|
| MD5 | 1e3c120c7097457888387d0b23370d4b |
|
| BLAKE2b-256 | 43a4bbae001e8bd4795fbf2a3a946b38ead532395da9e0a8407fdfe7643c8b1d |
Provenance
File details
Details for the file sourmash-3.3.0-py2.py3-none-manylinux2014_aarch64.whl.
File metadata
- Download URL: sourmash-3.3.0-py2.py3-none-manylinux2014_aarch64.whl
- Upload date:
- Size: 1.1 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ca6d5ed0fa3b96fbe9b5381f86fbbaa11dce7501a763b9921f8155b5fe418758 |
|
| MD5 | 5bffbd4e09fc6e23b102c760952b1aa0 |
|
| BLAKE2b-256 | 74a00d488e4af21bdf3c8c5c8fa01eeda317630dea1d228f89e4fd3d393fb7e7 |
Provenance
File details
Details for the file sourmash-3.3.0-py2.py3-none-manylinux2010_x86_64.whl.
File metadata
- Download URL: sourmash-3.3.0-py2.py3-none-manylinux2010_x86_64.whl
- Upload date:
- Size: 1.1 MB
- Tags: Python 2, Python 3, manylinux: glibc 2.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 43061e2a6caaca9f371e5a7c26f24b75fb2fe7fff9ddb8cf01d7c037e1d317ff |
|
| MD5 | 83f55f1d01fae418de41c0370072f8c2 |
|
| BLAKE2b-256 | dbcd6777a4102c0ed1118267a7f541d5ca9eeb11dadf6e67e157f50d92bf43e1 |
Provenance
File details
Details for the file sourmash-3.3.0-py2.py3-none-manylinux1_x86_64.whl.
File metadata
- Download URL: sourmash-3.3.0-py2.py3-none-manylinux1_x86_64.whl
- Upload date:
- Size: 1.1 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f317544a89afac3648c17e2d4042ddf9ae8543c084581556b0a07665136bf328 |
|
| MD5 | 49eefe5e4b2f2a6af1139e22dfa2de92 |
|
| BLAKE2b-256 | c2a0fff1abb89a67b744940b4d736b0a0d62ccec822fe76bb4e879dfd38c32c0 |
Provenance
File details
Details for the file sourmash-3.3.0-py2.py3-none-macosx_10_11_x86_64.whl.
File metadata
- Download URL: sourmash-3.3.0-py2.py3-none-macosx_10_11_x86_64.whl
- Upload date:
- Size: 507.4 kB
- Tags: Python 2, Python 3, macOS 10.11+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5943a9eea3653c2e576c83ece55e06626fadb8cf2794c33f7ebd228627742144 |
|
| MD5 | 7a0c6ea92f44869b7c157b4a9748ba85 |
|
| BLAKE2b-256 | 65248f1c61391d57bfcd81875a6a1309bd00f328df4764111f8a42c9bed78f55 |
