diff --git a/docs/content/harvest.png b/docs/content/harvest.png new file mode 100644 index 0000000..ba84ff9 Binary files /dev/null and b/docs/content/harvest.png differ diff --git a/docs/index.rst b/docs/index.rst index 83648f2..96c1013 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,53 +3,41 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -================================================================= -Harvest software suite for rapid genome alignment and visualization -================================================================= +Harvest +======= -Project home page: https://github.com/marbl/harvest +.. image:: content/harvest.png -============== -Citation -============== - -Preprint: +Harvest is a suite of core-genome alignment and visualization tools +for quickly analyzing thousands of intraspecific microbial +genomes, including variant calls, recombination +detection, and phylogenetic trees. - Treangen TJ, Ondov BD, Koren S, Phillippy AM. - "Rapid Core-Genome Alignment and Visualization for Thousands of Microbial Genomes." - *bioRxiv* (2014). doi: http://dx.doi.org/10.1101/007351 +.. image:: content/gingr/screen.png + :width: 462 + :height: 290 -============== -Release status -============== +**Tools** -07/21/14: `v1.0` +* `Parsnp `_ - Core-genome alignment and analysis +* `Gingr `_ - Interactive visualization of alignments, trees and variants +* `HarvestTools `_ - Archiving and postprocessing -================= -Overview -================= +**Citation (preprint)** -Harvest is a suite of core-genome alignment and visualization tools -for quickly analyzing thousands of intraspecific microbial -genomes. Harvest includes Parsnp, a fast core-genome multi-aligner, harvest-tools, a binary archive format and format conversion tool, -and Gingr, a dynamic visual platform. Combined they provide -rapid core-genome alignments, variant calls, recombination -detection, and phylogenetic trees. + Treangen TJ, Ondov BD, Koren S, Phillippy AM. + "Rapid Core-Genome Alignment and Visualization for Thousands of Microbial Genomes." + *bioRxiv* (2014). doi: http://dx.doi.org/10.1101/007351 -.. image:: example.png - :target: https://raw.githubusercontent.com/marbl/harvest/master/docs/example.png +**Download (v1.1, 6-Feb-2015)** -Contents: +* `Harvest-OSX64-v1.1.tar.gz `_ +* `Harvest-Linux64-v1.1.tar.gz `_ .. toctree:: - :maxdepth: 1 - :numbered: + :hidden: - content/hardware - content/installation content/gingr content/parsnp content/harvest-tools - content/faq -