Skip to content
/ khmer Public

In-memory nucleotide sequence k-mer counting, filtering, graph traversal and more

License

Notifications You must be signed in to change notification settings

dib-lab/khmer

Repository files navigation

khmer

Welcome to khmer: k-mer counting, filtering and graph traversal FTW!

https://badge.fury.io/py/khmer.png https://pypip.in/d/khmer/badge.png http://ci.ged.msu.edu/job/khmer-multi/badge/icon

The official repository is at

https://github.com/ged-lab/khmer

and you can read the docs online here:

http://khmer.readthedocs.org/

There are two mailing lists dedicated to khmer, an announcements-only list and a discussion list. To search their archives and sign-up for them, please visit the following URLs:

You can contact the current maintainers at khmer-project@idyll.org.

IMPORTANT NOTE:

khmer is pre-publication and research software, so please keep in mind that (a) the code may have undiscovered bugs in it, (b) you should cite us, and (c) you should get in touch if you need to cite us, as we are writing up the project.

INSTALL INSTRUCTIONS:

khmer requires Python 2.7+. Linux users will need the python development libraries and gcc. OS X users may need XCode installed. For more details see doc/install.txt

In short:

pip install khmer to download, build, and install the latest stable version.

The use of a virtualenv is recommended, see http://www.virtualenv.org/en/latest/#installation

khmer is under the BSD license; see doc/LICENSE.txt. Distribution, modification and redistribution, incorporation into other software, and pretty much everything else is allowed.

khmer project contributors also edit documents collaboratively at our wiki.

MRC 2014-02-16