In-memory nucleotide sequence k-mer counting, filtering, graph traversal and more
Python C++ Makefile Other
Latest commit b2ab515 Feb 16, 2017 @standage standage committed on GitHub Merge pull request #1621 from dib-lab/rename/consume_fasta
Rename/consume fasta
Permalink
Failed to load latest commit information.
.github Reset to master Dec 10, 2016
ci_scripts Adding OSX to travis Sep 2, 2016
data Correct test data for new FASTA{A,Q} name format. (Earlier conversion… Feb 20, 2013
doc fix counting types in python-apis Feb 14, 2017
examples Rename CountingHash to Countgraph and Hashbits to Nodegraph (#1506) Nov 8, 2016
khmer consume_fasta --> consume_seqfile Feb 15, 2017
legacy Reset to master Dec 10, 2016
lib Comments Feb 15, 2017
oxli consume_fasta --> consume_seqfile Feb 15, 2017
sandbox consume_fasta --> consume_seqfile Feb 15, 2017
scripts Appease pep8 Feb 15, 2017
tests consume_fasta --> consume_seqfile Feb 15, 2017
third-party pylint fixes May 9, 2016
.dictionary pylint fixes May 9, 2016
.gitattributes trying out versioneer Oct 22, 2013
.gitignore Switch to using pytests.xml instead of nosetests.xml Aug 30, 2016
.landscape.yaml configure landscape.io service Mar 2, 2014
.mailmap Replace nose with py.test (#1356) May 16, 2016
.travis.yml Fix generation of coverage for c++ code Feb 13, 2017
.ycm_extra_conf.py use clang's JSON compilation database for code completion Jun 30, 2014
CHANGELOG.md Document change in change log Feb 15, 2017
CITATION Strip extraneous whitespace (#1390) Jun 23, 2016
CODE_OF_CONDUCT.rst round 2 Sep 2, 2015
Doxyfile.in update doxygen Aug 14, 2015
LICENSE remove unused zlib files, doc its license Sep 4, 2015
MANIFEST.in trim absent files Aug 14, 2015
Makefile Add missing header to build dependency Feb 14, 2017
README.rst Add link to issue tracker Nov 17, 2016
ez_setup.py new version 3.4.1 of ez_setup.py Apr 1, 2014
pylintrc Replace nose with py.test (#1356) May 16, 2016
pytest.ini Replace nose with py.test (#1356) May 16, 2016
setup.cfg Move pep8 settings to setup.cfg Nov 2, 2016
setup.py Add missing header to build dependency Feb 14, 2017
sort-authors-list.py round 2 Sep 2, 2015
versioneer.py versioneer 0.15+dev Oct 26, 2015

README.rst

Research software impact

khmer

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

The official source code repository is at

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

and you can read the docs online here:

http://khmer.readthedocs.io/

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:

The maintainers can be contacted at khmer-project@idyll.org.

For getting help please see this guide: http://khmer.readthedocs.io/en/stable/user/getting-help.html Your first port of call when looking for help should be: https://github.com/dib-lab/khmer/issues

Important note: cite us!

khmer is research software, so you should cite us when you use it in scientific publications! Please see the CITATION file for citation information.

Install

khmer works with Python version 2.7 or 3.5. Create a virtual environemnt and install khmer with:

` pip install khmer `

You are ready to go. For more details see doc/install.rst

Contributing

If you want to modify khmer or contribute to its development read the developer instructions

License

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