# Quikr #
This is the homepage for quikr.

## What is Quikr ##
Quikr is a QUadratic, Iterative, K-mer based Reconstruction technique that
utilizes sparsity promoting ideas from the field of compressed sensing to
reconstruct the composition of a bacterial community (when the input data is
454-like pyrosequencing data). This extremely fast method comes with a several
databases that can be custom trained. Typically reconstruction is
accurate down to the genus level.


## How Do I Install Quikr ##
Please read the directions on the [installation page](doc/install.markdown).

## How Do I use Quikr ##
We have several ways to use quikr. Quikr is first and formost a command
line utility, but we also provide python and matlab scripts.

+ [Command Line Utilities](doc/cli.markdown)
+ [Matlab documentation](doc/matlab.markdown)
+ [Python documentation](doc/python.markdown)

## Contact ##
For issues with the quikr software, contact gailro@gmail.com

## License ##

The Quikr project is released under the GPL-3 License. Please view the [LICENSE](LICENSE)
file for more details.

## Contributors ##
+ David Koslicki
+ Simon Foucart
+ Gail Rosen
+ Calvin Morrison
+ Jean-Luc Bouchot