tools for comparing DNA sequences with MinHash sketches
Project description
# sourmash
[![Documentation](https://readthedocs.org/projects/sourmash/badge/?version=latest)](http://sourmash.readthedocs.io/en/latest/)
[![Build Status](https://drone.io/github.com/dib-lab/sourmash/status.png)](https://drone.io/github.com/dib-lab/sourmash/latest)
[![codecov](https://codecov.io/gh/dib-lab/sourmash/branch/master/graph/badge.svg)](https://codecov.io/gh/dib-lab/sourmash)
[![DOI](https://zenodo.org/badge/22555/dib-lab/sourmash.svg)](https://zenodo.org/badge/latestdoi/22555/dib-lab/sourmash)
Compute MinHash signatures for DNA sequences.
Usage:
sourmash compute *.fq.gz
sourmash compare *.sig -o distances
sourmash plot distances
We have demo notebooks on binder that you can interact with:
[![Binder](http://mybinder.org/badge.svg)](http://mybinder.org/repo/dib-lab/sourmash)
----
The name is a riff off of [Mash](https://github.com/marbl/Mash),
combined with @ctb's love of whiskey.
([Sour mash](https://en.wikipedia.org/wiki/Sour_mash) is used in
making whiskey.)
Authors: [C. Titus Brown](mailto:titus@idyll.org) ([@ctb](http://github.com/ctb)) and Luiz C. Irber, Jr.
sourmash is a product of the
[Lab for Data-Intensive Biology](http://ivory.idyll.org/lab/) at the
[UC Davis School of Veterinary Medicine](http://www.vetmed.ucdavis.edu).
## Installation
You can do:
pip install sourmash
sourmash runs under both Python 2.7.x and Python 3.5. The base
requirements are screed and PyYAML, 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.
## Support
Please ask questions and files issues
[on Github](https://github.com/dib-lab/sourmash/issues). The developers
sometimes hang out [on gitter](https://gitter.im/dib-lab/khmer).
## Development
Development happens on github at
[dib-lab/sourmash](https://github.com/dib-lab/sourmash).
`sourmash` is the main command-line entry point; run it for help.
`sourmash_lib/` contains the library code.
Tests require py.test and can be run with `make test`.
----
CTB
6.jun.2016
[![Documentation](https://readthedocs.org/projects/sourmash/badge/?version=latest)](http://sourmash.readthedocs.io/en/latest/)
[![Build Status](https://drone.io/github.com/dib-lab/sourmash/status.png)](https://drone.io/github.com/dib-lab/sourmash/latest)
[![codecov](https://codecov.io/gh/dib-lab/sourmash/branch/master/graph/badge.svg)](https://codecov.io/gh/dib-lab/sourmash)
[![DOI](https://zenodo.org/badge/22555/dib-lab/sourmash.svg)](https://zenodo.org/badge/latestdoi/22555/dib-lab/sourmash)
Compute MinHash signatures for DNA sequences.
Usage:
sourmash compute *.fq.gz
sourmash compare *.sig -o distances
sourmash plot distances
We have demo notebooks on binder that you can interact with:
[![Binder](http://mybinder.org/badge.svg)](http://mybinder.org/repo/dib-lab/sourmash)
----
The name is a riff off of [Mash](https://github.com/marbl/Mash),
combined with @ctb's love of whiskey.
([Sour mash](https://en.wikipedia.org/wiki/Sour_mash) is used in
making whiskey.)
Authors: [C. Titus Brown](mailto:titus@idyll.org) ([@ctb](http://github.com/ctb)) and Luiz C. Irber, Jr.
sourmash is a product of the
[Lab for Data-Intensive Biology](http://ivory.idyll.org/lab/) at the
[UC Davis School of Veterinary Medicine](http://www.vetmed.ucdavis.edu).
## Installation
You can do:
pip install sourmash
sourmash runs under both Python 2.7.x and Python 3.5. The base
requirements are screed and PyYAML, 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.
## Support
Please ask questions and files issues
[on Github](https://github.com/dib-lab/sourmash/issues). The developers
sometimes hang out [on gitter](https://gitter.im/dib-lab/khmer).
## Development
Development happens on github at
[dib-lab/sourmash](https://github.com/dib-lab/sourmash).
`sourmash` is the main command-line entry point; run it for help.
`sourmash_lib/` contains the library code.
Tests require py.test and can be run with `make test`.
----
CTB
6.jun.2016
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-0.9.6.tar.gz
(34.4 kB
view details)
Built Distribution
File details
Details for the file sourmash-0.9.6.tar.gz
.
File metadata
- Download URL: sourmash-0.9.6.tar.gz
- Upload date:
- Size: 34.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39b52b1dde71911a9d4144a209816f7a2cf1fedc4abfdec4de6150713a5d2fd7 |
|
MD5 | 0e5b6f14d8266e1f817f411604f99880 |
|
BLAKE2b-256 | 74a3767a6a414825a084b1e328c134ec3462c636d480aaca3ae4549e44221c46 |
Provenance
File details
Details for the file sourmash-0.9.6-cp27-cp27m-macosx_10_11_intel.whl
.
File metadata
- Download URL: sourmash-0.9.6-cp27-cp27m-macosx_10_11_intel.whl
- Upload date:
- Size: 50.2 kB
- Tags: CPython 2.7m, macOS 10.11+ intel
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3c2bb50305d604c1944370fbd688fed598c7f1d3ba453408ac4bb136f887bdc |
|
MD5 | f9f82a198a642e175e76275a0118ece5 |
|
BLAKE2b-256 | 884b5e53041e76ab84e106c3d2557fb33b1309a4ecc3cd051ce7900506b23a01 |