Skip to main content

tools for comparing DNA sequences with MinHash sketches

Project description

sourmash

Quickly search, compare, and analyze genomic and metagenomic data sets.

Documentation Build Status Bioconda install PyPI codecov DOI License: 3-Clause BSD

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 was initially developed by the Lab for Data-Intensive Biology at the UC Davis School of Veterinary Medicine, and now includes contributions from the global research and developer community.

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 Python 3.7 and later. The base requirements are screed, cffi, numpy, matplotlib, and scipy. Conda (see below) will install everything necessary, and is our recommended installation method.

Installation with conda

Bioconda is a channel for the conda package manager with a focus on bioinformatics software. After installing conda, 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 released version.

Support

Please ask questions and files issues on Github.

Development

Development happens on github at dib-lab/sourmash.

sourmash is developed in Python and Rust, and you will need a Rust environment to build it; see the developer notes for our suggested development setup.

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 on getting set up with a development environment.


CTB July 2020

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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

sourmash-4.0.0a3-py2.py3-none-manylinux2010_x86_64.whl (1.2 MB view details)

Uploaded Python 2Python 3manylinux: glibc 2.12+ x86-64

sourmash-4.0.0a3-py2.py3-none-manylinux2010_i686.whl (1.3 MB view details)

Uploaded Python 2Python 3manylinux: glibc 2.12+ i686

sourmash-4.0.0a3-py2.py3-none-manylinux1_x86_64.whl (1.2 MB view details)

Uploaded Python 2Python 3

sourmash-4.0.0a3-py2.py3-none-manylinux1_i686.whl (1.3 MB view details)

Uploaded Python 2Python 3

sourmash-4.0.0a3-py2.py3-none-macosx_10_11_x86_64.whl (529.8 kB view details)

Uploaded Python 2Python 3macOS 10.11+ x86-64

File details

Details for the file sourmash-4.0.0a3-py2.py3-none-manylinux2010_x86_64.whl.

File metadata

  • Download URL: sourmash-4.0.0a3-py2.py3-none-manylinux2010_x86_64.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 2, Python 3, manylinux: glibc 2.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.6

File hashes

Hashes for sourmash-4.0.0a3-py2.py3-none-manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 c4063ad662eba557d3242edf3e3c3935775d53889be415e677a17d09d88b79fb
MD5 e3bec906024d0843c912846bac54516e
BLAKE2b-256 57c59f0b98e4f6e334e99f71f0d9c1c3ba389649a5c83572183b2148b8083470

See more details on using hashes here.

File details

Details for the file sourmash-4.0.0a3-py2.py3-none-manylinux2010_i686.whl.

File metadata

  • Download URL: sourmash-4.0.0a3-py2.py3-none-manylinux2010_i686.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 2, Python 3, manylinux: glibc 2.12+ i686
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.6

File hashes

Hashes for sourmash-4.0.0a3-py2.py3-none-manylinux2010_i686.whl
Algorithm Hash digest
SHA256 9258a3288d6da877d20944ce80255622b3d8321c9313aa49981624f536d176df
MD5 e753e40be151c0d0c4cbc28dae608f4a
BLAKE2b-256 8aef583dd955f74d5b86334c6c920c0d81ce31f7d76d1a5562a0e2685139eebb

See more details on using hashes here.

File details

Details for the file sourmash-4.0.0a3-py2.py3-none-manylinux1_x86_64.whl.

File metadata

  • Download URL: sourmash-4.0.0a3-py2.py3-none-manylinux1_x86_64.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.6

File hashes

Hashes for sourmash-4.0.0a3-py2.py3-none-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 4506acda9473ad20f57f6a22dcc32ebed940e705da747ce037eacb06f266d72a
MD5 e99bd5f5a660ae67c125fdae80810e6c
BLAKE2b-256 9eda305911de514d9be90163b3c761fb91d8d42460e6b9d11f6cc021ca350b53

See more details on using hashes here.

File details

Details for the file sourmash-4.0.0a3-py2.py3-none-manylinux1_i686.whl.

File metadata

  • Download URL: sourmash-4.0.0a3-py2.py3-none-manylinux1_i686.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.6

File hashes

Hashes for sourmash-4.0.0a3-py2.py3-none-manylinux1_i686.whl
Algorithm Hash digest
SHA256 f941351298be02ddffd5f9ede6a4186e7a41b9e286d17ab727bf389a89cbc936
MD5 7607fb41906bd35abc3ec36bc0fe1aae
BLAKE2b-256 078074283a35673f16248b1e55f1a4905780da5417589da1d0fa91f29f88098e

See more details on using hashes here.

File details

Details for the file sourmash-4.0.0a3-py2.py3-none-macosx_10_11_x86_64.whl.

File metadata

  • Download URL: sourmash-4.0.0a3-py2.py3-none-macosx_10_11_x86_64.whl
  • Upload date:
  • Size: 529.8 kB
  • Tags: Python 2, Python 3, macOS 10.11+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.6

File hashes

Hashes for sourmash-4.0.0a3-py2.py3-none-macosx_10_11_x86_64.whl
Algorithm Hash digest
SHA256 f970c31772b6cdf5e33b096cb85772f879f05d360417b230376dc120452b7c30
MD5 5fc9840cf20f1e8055bb363cf817ced9
BLAKE2b-256 cc76eaf5ccbb490711710db73ac6cf99ce5ab5222cf86552a91e13d1f3d9bfa8

See more details on using hashes here.

Supported by

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