tools for comparing DNA sequences with MinHash sketches

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for bluegenes from gravatar.com bluegenes Avatar for luizirber from gravatar.com luizirber Avatar for titus from gravatar.com titus

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for bluegenes from gravatar.com bluegenes Avatar for luizirber from gravatar.com luizirber Avatar for titus from gravatar.com titus

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

4.8.11

4.8.10

4.8.9

4.8.8

4.8.7

4.8.6

4.8.5

4.8.4

4.8.3

4.8.2

4.8.1

4.8.0

4.7.0

4.6.1

4.6.0

4.5.0

4.5.0rc1 pre-release

4.4.3

4.4.2

4.4.1

4.4.0

4.3.0

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.2

4.1.1

4.1.0

4.0.0

4.0.0rc2 pre-release

4.0.0rc1 pre-release

4.0.0a3 pre-release

4.0.0a2 pre-release

4.0.0a1 pre-release

3.5.1

3.5.0

3.4.1

3.4.0

3.3.1

3.3.0

3.2.3

3.2.2

3.2.1

3.2.0

3.1.0

3.0.1

3.0.0

3.0.0rc1 pre-release

2.3.1

2.3.0

2.2.0

2.1.0

This version

2.0.1

2.0.0

2.0.0a11 pre-release

2.0.0a10 pre-release

2.0.0a9 pre-release

2.0.0a8 pre-release

2.0.0a7 pre-release

2.0.0a6 pre-release

2.0.0a5 pre-release

2.0.0a4 pre-release

2.0.0a2 pre-release

1.0

0.9.6

0.9.5

0.9.4

0.9.4-rc1 pre-release

0.9.3

0.9.2

0.3

0.2

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.0.1.tar.gz (7.3 MB view details)

Uploaded Source

Built Distributions

sourmash-2.0.1-cp37-cp37m-manylinux1_x86_64.whl (458.3 kB view details)

Uploaded CPython 3.7m

sourmash-2.0.1-cp37-cp37m-macosx_10_6_intel.whl (155.7 kB view details)

Uploaded CPython 3.7m macOS 10.6+ intel

sourmash-2.0.1-cp36-cp36m-manylinux1_x86_64.whl (459.6 kB view details)

Uploaded CPython 3.6m

sourmash-2.0.1-cp36-cp36m-macosx_10_6_intel.whl (159.6 kB view details)

Uploaded CPython 3.6m macOS 10.6+ intel

sourmash-2.0.1-cp35-cp35m-manylinux1_x86_64.whl (450.8 kB view details)

Uploaded CPython 3.5m

sourmash-2.0.1-cp35-cp35m-macosx_10_6_intel.whl (156.5 kB view details)

Uploaded CPython 3.5m macOS 10.6+ intel

sourmash-2.0.1-cp34-cp34m-manylinux1_x86_64.whl (449.0 kB view details)

Uploaded CPython 3.4m

sourmash-2.0.1-cp34-cp34m-macosx_10_6_intel.whl (154.7 kB view details)

Uploaded CPython 3.4m macOS 10.6+ intel

sourmash-2.0.1-cp27-cp27mu-manylinux1_x86_64.whl (429.0 kB view details)

Uploaded CPython 2.7mu

sourmash-2.0.1-cp27-cp27m-manylinux1_x86_64.whl (429.0 kB view details)

Uploaded CPython 2.7m

sourmash-2.0.1-cp27-cp27m-macosx_10_6_intel.whl (155.9 kB view details)

Uploaded CPython 2.7m macOS 10.6+ intel

File details

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

File metadata

  • Download URL: sourmash-2.0.1.tar.gz
  • Upload date:
  • Size: 7.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1.tar.gz
Algorithm Hash digest
SHA256 be7d0a074696626f1488ff172e948c2f0de1610f5a3fd1250605fabc0ea382b2
MD5 708b297698a8a903197adfc5955577d1
BLAKE2b-256 4fb1400d620018af2a6e7261bd109521f12ee20fb3c47d73e0fe11d6ead5f324

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: sourmash-2.0.1-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 458.3 kB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 87b85d877bb9fd5aaa412f62ff1b944432f2bfd6c6af50b07088faa5a1234720
MD5 59e4796c74f72bddc10fa6c3d72ae877
BLAKE2b-256 95e94c483ad1587fe7517e11cff0f5f94a11f1c05ab96f480ec89d07dd52ab5c

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: sourmash-2.0.1-cp37-cp37m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 155.7 kB
  • Tags: CPython 3.7m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp37-cp37m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 ed7ec0e5fa61abb4745cfda0513b63add3f88471f1745cc84b1ad019a77d0049
MD5 bdce0e8848cb4412aa0258bf73aca6ff
BLAKE2b-256 89232a7239faa191baba3c3d4ac1f1cb54f37bf11208965eb6a5c5089d251036

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: sourmash-2.0.1-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 459.6 kB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 a1e2b2a54c4408ec1c7eb69759ba539c8162e86c5185e36226c6c81f81b95cab
MD5 dda8b6f44fb3ee714e66a4054e260f00
BLAKE2b-256 4308e5acdeb630d70e8a324867d8e2e0bf69332c2489940ba9faa92579fc3ee5

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: sourmash-2.0.1-cp36-cp36m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 159.6 kB
  • Tags: CPython 3.6m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp36-cp36m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 634b9a0e84f2d4afe900783c8af995b8368880eb4d46a2db87ed1b05e15f9c79
MD5 34a24836c130523f94976d7597d1c1b3
BLAKE2b-256 14e7e7d25e800b1f8edd96646d33e64a10dc1975e4e6bcc0adc32cac89c0a9e3

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: sourmash-2.0.1-cp35-cp35m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 450.8 kB
  • Tags: CPython 3.5m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 b2e970abaac3ebbf948a105e9f362112571ea29f4138fbb61ec5571f2ec37e25
MD5 44150fa345668fec8f33a3e3a5386b18
BLAKE2b-256 5651e3d7401663cdd57ab8069f5ff68e12330d1a1e37785684fbb81609925f1b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: sourmash-2.0.1-cp35-cp35m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 156.5 kB
  • Tags: CPython 3.5m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp35-cp35m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 570b7572a65b29330b6d5164ac7950fc3645313a6716a9e35829fa294dd922e8
MD5 5d02a966a21805c6c74f22f1eca985ef
BLAKE2b-256 1efce180bd3deb0a7154443a47f7cbad788b03201da99a69ded8d979c4335979

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.0.1-cp34-cp34m-manylinux1_x86_64.whl.

File metadata

  • Download URL: sourmash-2.0.1-cp34-cp34m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 449.0 kB
  • Tags: CPython 3.4m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 a65736420ca1cedec4b4ef52292bf25959f82624757323bb9b207b49d4512d29
MD5 ca3d87eb016f3f399cba8be24e7e6e73
BLAKE2b-256 a9a7b3c0f788d60cdbfc7aa986f09ef03490e4d866b6fb2aac5076dcd77784c7

See more details on using hashes here.

Provenance

File details

Details for the file sourmash-2.0.1-cp34-cp34m-macosx_10_6_intel.whl.

File metadata

  • Download URL: sourmash-2.0.1-cp34-cp34m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 154.7 kB
  • Tags: CPython 3.4m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp34-cp34m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 b8b37a443c6f2d8e131aa34c2d6d0b50bf3cee36a0da048f922b5885bf4f43ca
MD5 e1c62b8eb90a8e011f0ed85ca06e19b7
BLAKE2b-256 45fa59d7e47bb0422a1b06fcf880baff51ea41de187ce86e5ce0dcf95dacafb6

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: sourmash-2.0.1-cp27-cp27mu-manylinux1_x86_64.whl
  • Upload date:
  • Size: 429.0 kB
  • Tags: CPython 2.7mu
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 7aebb829696c785107a7164dc921c162ece3e0a442f48b686d4a85ab2599c911
MD5 c068ce041b96eee9f06a6b42c42f00a9
BLAKE2b-256 63d02c9ccbd31e0c7c9d2183d13e2cc7a1a6d1731eb9b99601291f4666cf25eb

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: sourmash-2.0.1-cp27-cp27m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 429.0 kB
  • Tags: CPython 2.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c920f4ea0d5a6f386e1f82dea6cc8613aba6789cc9f9b5314a68d9b8430b15f1
MD5 1ded79bb72d5a6143e0cabc08e848fc1
BLAKE2b-256 321a00d8ab60372418149a8fe18073cea50dc06edcd9ad3178d50aa9b78688f9

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: sourmash-2.0.1-cp27-cp27m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 155.9 kB
  • Tags: CPython 2.7m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sourmash-2.0.1-cp27-cp27m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 7e2257317defc64281d268adbe9d1539552e7b0ae3d87cd74ccf7e3abffbccc4
MD5 06c07231597ff507b808cdd5ec93aec8
BLAKE2b-256 bdacd2b7dae722e72165183ee2ae55dc1bd4cd80866f3e2f21f1484235b7294b

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