Skip to main content

tools for comparing DNA sequences with MinHash sketches

Project description

sourmash

Documentation Build Status codecov DOI

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

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 C++ development environment and the CPython development headers and libraries (for the C++ extension).

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 library code.

Tests require py.test and can be run with make test.

Please see the developer notes for more information.


CTB Dec 2018

Project details


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

sourmash-2.3.1.tar.gz (7.3 MB view details)

Uploaded Source

Built Distributions

sourmash-2.3.1-cp38-cp38-manylinux2010_x86_64.whl (849.2 kB view details)

Uploaded CPython 3.8 manylinux: glibc 2.12+ x86-64

sourmash-2.3.1-cp38-cp38-manylinux1_x86_64.whl (849.2 kB view details)

Uploaded CPython 3.8

sourmash-2.3.1-cp38-cp38-macosx_10_9_x86_64.whl (185.0 kB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

sourmash-2.3.1-cp37-cp37m-manylinux2010_x86_64.whl (787.5 kB view details)

Uploaded CPython 3.7m manylinux: glibc 2.12+ x86-64

sourmash-2.3.1-cp37-cp37m-manylinux1_x86_64.whl (787.5 kB view details)

Uploaded CPython 3.7m

sourmash-2.3.1-cp37-cp37m-macosx_10_6_intel.whl (183.9 kB view details)

Uploaded CPython 3.7m macOS 10.6+ intel

sourmash-2.3.1-cp36-cp36m-manylinux2010_x86_64.whl (789.6 kB view details)

Uploaded CPython 3.6m manylinux: glibc 2.12+ x86-64

sourmash-2.3.1-cp36-cp36m-manylinux1_x86_64.whl (789.6 kB view details)

Uploaded CPython 3.6m

sourmash-2.3.1-cp36-cp36m-macosx_10_6_intel.whl (188.5 kB view details)

Uploaded CPython 3.6m macOS 10.6+ intel

sourmash-2.3.1-cp35-cp35m-manylinux2010_x86_64.whl (780.5 kB view details)

Uploaded CPython 3.5m manylinux: glibc 2.12+ x86-64

sourmash-2.3.1-cp35-cp35m-manylinux1_x86_64.whl (780.5 kB view details)

Uploaded CPython 3.5m

sourmash-2.3.1-cp35-cp35m-macosx_10_6_intel.whl (184.4 kB view details)

Uploaded CPython 3.5m macOS 10.6+ intel

sourmash-2.3.1-cp27-cp27mu-manylinux2010_x86_64.whl (733.7 kB view details)

Uploaded CPython 2.7mu manylinux: glibc 2.12+ x86-64

sourmash-2.3.1-cp27-cp27mu-manylinux1_x86_64.whl (733.7 kB view details)

Uploaded CPython 2.7mu

sourmash-2.3.1-cp27-cp27m-manylinux2010_x86_64.whl (733.7 kB view details)

Uploaded CPython 2.7m manylinux: glibc 2.12+ x86-64

sourmash-2.3.1-cp27-cp27m-manylinux1_x86_64.whl (733.7 kB view details)

Uploaded CPython 2.7m

sourmash-2.3.1-cp27-cp27m-macosx_10_6_intel.whl (185.8 kB view details)

Uploaded CPython 2.7m macOS 10.6+ intel

File details

Details for the file sourmash-2.3.1.tar.gz.

File metadata

  • Download URL: sourmash-2.3.1.tar.gz
  • Upload date:
  • Size: 7.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1.tar.gz
Algorithm Hash digest
SHA256 d9dd240fbad71a57eb9960388a015c2315b91704d83a77454c47c006846d3f4b
MD5 c82ff2c793428b0eaf015c007e43c294
BLAKE2b-256 22c468a3487b1e2664fdf46c898045019a137847714c5c45a9d9b75c4731dc78

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp38-cp38-manylinux2010_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp38-cp38-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 849.2 kB
  • Tags: CPython 3.8, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp38-cp38-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 fd47a1ac030a6cbdbc1c82b34f0ae25c9e89bd74c2c3cd282e5203e83d57f086
MD5 61bb6f600aaeb877872433ec9bd478d7
BLAKE2b-256 1b29558db81f12c2026854cab3b0dfedb811233e4faddfae4f7d22f605976fbe

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp38-cp38-manylinux1_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp38-cp38-manylinux1_x86_64.whl
  • Upload date:
  • Size: 849.2 kB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp38-cp38-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 feb87057ee8b6c60176932aad963e8b3bf624a878a10934cbfb03c7820492213
MD5 0539bf1bfe84f46f4f8441130681183c
BLAKE2b-256 bd54cae183583cc2543db2216744b4745036a62b08ac1df836d6d6550f8da0f5

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp38-cp38-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp38-cp38-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 185.0 kB
  • Tags: CPython 3.8, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 4b3d40f946a666476f1c6b21114a4b9c9838ebc309aa48cf8b9f413a10cf09b5
MD5 2cd785f9710d6009a710974757a4c47f
BLAKE2b-256 29ad86aaf034673be0d42960e50428c6ee0711006cbc77cceab21688fa0c483c

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp37-cp37m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp37-cp37m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 787.5 kB
  • Tags: CPython 3.7m, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp37-cp37m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 42317425dd02ae7e07c483a67635fdef53554abeaeeb8b96063c100667251b62
MD5 9230a72fe9c2fd2f69975a7d3468f550
BLAKE2b-256 e0b682b6c2c85e6eddaf4d0dfa878292828072c00d463200bcd527eb4bafdae0

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 787.5 kB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 3184213a0727710ecd6ec921b02a37c9e131bc121b56581bd8d5a237bc363ae5
MD5 aeba4e38b31105ef3cf1c2b9e32983e4
BLAKE2b-256 48d26ad81e20e7aec5e2edf22fe4d5f61c0f144b09f446b78b624081da8aba85

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp37-cp37m-macosx_10_6_intel.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp37-cp37m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 183.9 kB
  • Tags: CPython 3.7m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp37-cp37m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 02b45d285887df750895b5bd9443cb1bc5af9f1eaa1fc2b90a55ff711160b86a
MD5 ccff0fafd53e5cd7e23bbe4352633575
BLAKE2b-256 eb2087548bba49bc70dd67feab148da2e4cdb546356dfa230e1e310fca2c0282

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp36-cp36m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp36-cp36m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 789.6 kB
  • Tags: CPython 3.6m, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp36-cp36m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 2d77efb3b1b435ac833ac33f02031dfe8663058e788eaf1522191402d805f812
MD5 7a78e1a6d6c7874bfef8a4cc74ac19ad
BLAKE2b-256 78160310326d578aa7525f4c88901309f3e6515706615b7763d9e22f034cdcab

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 789.6 kB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 1db70ec80d941e18f2dc325ec876f0c5a4d159d178f6f304d1e24842bc513375
MD5 8c212e2ff57fee81019c5faee100bb08
BLAKE2b-256 e84c07fc820bb8579abd51034cb8e1542f597c9c6180b33c33ac6890cc19afe3

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp36-cp36m-macosx_10_6_intel.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp36-cp36m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 188.5 kB
  • Tags: CPython 3.6m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp36-cp36m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 ba62b7410210e1ca2acd0857bcabab142108d12574e194ff171204735297cb53
MD5 0d149a1cd52d242974fde1007f65dbf6
BLAKE2b-256 8d1413e116fb949ce4cc86ccefcca4c9a2b4db1decf82c81f4efe027c39db96d

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp35-cp35m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp35-cp35m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 780.5 kB
  • Tags: CPython 3.5m, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp35-cp35m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 03a672f0fd48c923b726525d3ee7263ba3d0a21529b4ffac031866f6a7d27f83
MD5 ffd630dcab6e4ed03bd75e04b76337b3
BLAKE2b-256 ddb288e572e700ab35e78fbcdb2e9d1d1bf67e6fbbbcdbd2d7adddcdd5ede991

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp35-cp35m-manylinux1_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp35-cp35m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 780.5 kB
  • Tags: CPython 3.5m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 20fc5f704cfa09c6533076ee567359453008fa60cc38aef3d34fd0ef0190be6a
MD5 d324f63cb1921d816fbbc7e00c4d80f6
BLAKE2b-256 5450b295b1fd20887dce350f873152e785537f233f2a8a29461d2e695ef6ae35

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp35-cp35m-macosx_10_6_intel.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp35-cp35m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 184.4 kB
  • Tags: CPython 3.5m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp35-cp35m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 26abdd602b68fde328f3df85f7be0dff648cb611a0f08b8da038b185bea6fc2d
MD5 5a116a587f8cb54e16b3ab9a55a5ff9c
BLAKE2b-256 ee9256f29bd1908e54670c032c9926e64c1448a5b515ffce765d1584ddf618a8

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp27-cp27mu-manylinux2010_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp27-cp27mu-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 733.7 kB
  • Tags: CPython 2.7mu, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp27-cp27mu-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 ad570e60075945c6705d8eec8f07cec5c8a095e941c15ca59aa7ad19bdb89fae
MD5 b587231f7664f2a682474ea0906391b5
BLAKE2b-256 c9914b022863af1746bb3281f74ddb9c336e0da53c08b4c65302aae6246b1e0a

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp27-cp27mu-manylinux1_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp27-cp27mu-manylinux1_x86_64.whl
  • Upload date:
  • Size: 733.7 kB
  • Tags: CPython 2.7mu
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 6272f90edde7e0cb2a1be151cda082235b1ae86889cc15304827e282f9ee3870
MD5 6f40498666a493336fd7a315cf61d989
BLAKE2b-256 7b0b69aeafcbb46a3195682ac47098c1130ca95949dec0ce115a8b120d988ac5

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp27-cp27m-manylinux2010_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp27-cp27m-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 733.7 kB
  • Tags: CPython 2.7m, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp27-cp27m-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 ae93a5cfb3eab5842f165346d9172c890138dc3900e2bd50b1fc3dc2eb7d3fe7
MD5 5f8b503eb2f738f1e8b4f7967bd66692
BLAKE2b-256 e5c994e2441b5318c8dc175eb4ca9bb55ce3b1e21d18f22d19f9c2daec5b7c1d

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp27-cp27m-manylinux1_x86_64.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp27-cp27m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 733.7 kB
  • Tags: CPython 2.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 f3f23e88974c65bf702b1dfef7187f1bb06c403d5a7d6d89c332a53ed8f1236a
MD5 8a8652e786a66b296f09d52c09546356
BLAKE2b-256 539382afc013dc4ebbaf69eb7d5a8dc4f3a78d212e8b0f35fcab3211dbb7ea21

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.3.1-cp27-cp27m-macosx_10_6_intel.whl.

File metadata

  • Download URL: sourmash-2.3.1-cp27-cp27m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 185.8 kB
  • Tags: CPython 2.7m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for sourmash-2.3.1-cp27-cp27m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 26b87fccb8a5f7e2c6117b1c94d047162ed16907f7c075d66e6bd79237ab9ea4
MD5 ead1a67dbab1142a55d54012c87af50a
BLAKE2b-256 bcc41592cc4266ac76c184dbcfc4cdefc77067118a416bc30c89e31e434c5d9b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page