Skip to content

Commit a419ad4

Browse files
committed
Update documentation with mention of AVX2 requirement
1 parent 3bf7109 commit a419ad4

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Newmap can search for minimum k-mer lengths for specific values, or entire
1212
continuous ranges using a binary search method allowing for computing all
1313
possible minimum unique k-mer lengths for any sequence.
1414

15+
Newmap requires a CPU that supports the AVX2 instruction set.
1516

1617
## Quick start
1718

docs/source/usage.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ These unique counts are stored in a ``.unique`` file which is a binary file
88
containing integers of the minimum unique length found. These files can be used
99
to generate mappability data for a give k-mer length.
1010

11+
Newmap requires a CPU with AVX2 support, and has only been tested on Linux.
12+
1113
For instructions on how to install see the `Installation`_ section.
1214
For a quick example on how to get started, see the `Quickstart`_ section.
1315
For details on the command line options, see the :ref:`Commands` section.

0 commit comments

Comments
 (0)