reqs

sourmash-bio · Jun 7, 2016 · 8da2ee3 · 8da2ee3
1 parent df2edd9
commit 8da2ee3
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -48,6 +48,7 @@ Contents:
    command-line
    api
    api-example
+   requirements
    more-info
 
 

diff --git a/doc/requirements.rst b/doc/requirements.rst
@@ -0,0 +1,18 @@
+Computational requirements
+==========================
+
+sourmash has no particular memory requirements; it will need to hold
+the largest single sequence you have in memory, but the individual
+signatures are quite small and we do no special buffer allocation.
+
+sourmash's intensive computation is almost entirely computing k-mers
+and hashes of k-mers.  It will create a sketch of several megabases
+in a second or so on a rather slow 2016 Mac laptop.
+
+MinHash sketches and signatures are quite small on disk.
+
+sourmash should run with little modification on Linux and Mac OS X,
+under Python 2.7.11 and Python 3.5.  Please see `the development
+repository README
+<https://github.com/dib-lab/sourmash/blob/master/README.md>`__ for
+information on source code, tests, and continuous integration.