You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+21-13
Original file line number
Diff line number
Diff line change
@@ -16,18 +16,20 @@ We have implemented a tool called VSEARCH which supports *de novo* and reference
16
16
17
17
VSEARCH stands for vectorized search, as the tool takes advantage of parallelism in the form of SIMD vectorization as well as multiple threads to perform accurate alignments at high speed. VSEARCH uses an optimal global aligner (full dynamic programming Needleman-Wunsch), in contrast to USEARCH which by default uses a heuristic seed and extend aligner. This usually results in more accurate alignments and overall improved sensitivity (recall) with VSEARCH, especially for alignments with gaps.
18
18
19
-
[VSEARCH binaries](https://github.com/torognes/vsearch/releases/latest) are provided for GNU/Linux on three 64-bit processor architectures: x86-64, POWER8 (ppc64le) and ARMv8 (aarch64). Binaries are also provided for MacOS (version 10.9 Mavericks or later) on Intel (x86-64) and Apple Silicon (ARMv8), as well as Windows (64-bit, version 7 or higher, on x86_64). VSEARCH contains dedicated SIMD code for the three processor architectures (SSE2/SSSE3, AltiVec/VMX/VSX, Neon).
19
+
[VSEARCH binaries](https://github.com/torognes/vsearch/releases/latest) are provided for GNU/Linux on three 64-bit processor architectures: x86_64, POWER8 (ppc64le) and ARMv8 (aarch64). Binaries are also provided for macOS (version 10.9 Mavericks or later) on Intel (x86_64) and Apple Silicon (ARMv8), as well as Windows (64-bit, version 7 or higher, on x86_64). VSEARCH contains dedicated SIMD code for the three processor architectures (SSE2/SSSE3, AltiVec/VMX/VSX, Neon). In addition, VSEARCH uses the SIMD Everywhere (SIMDe) library to enable building on RISCV64, MIPS64EL, and other little-endian architectures.
Various packages, plugins and wrappers are also available from other sources - see [below](https://github.com/torognes/vsearch#packages-plugins-and-wrappers).
28
30
29
-
The source code compiles correctly with `gcc` (versions 4.8.5 to 13.0)
30
-
and `llvm-clang` (3.8 to 17.0). The source code should also compile on
31
+
The source code compiles correctly with `gcc` (versions 4.8.5 to 14.0)
32
+
and `llvm-clang` (3.8 to 19.0). The source code should also compile on
31
33
[FreeBSD](https://www.freebsd.org/) and
32
34
[NetBSD](https://www.netbsd.org/) systems.
33
35
@@ -55,8 +57,8 @@ tar xzf v2.28.1.tar.gz
55
57
cd vsearch-2.28.1
56
58
./autogen.sh
57
59
./configure CFLAGS="-O3" CXXFLAGS="-O3"
58
-
make
59
-
make install # as root or sudo make install
60
+
make ARFLAGS="cr"
61
+
sudo make install
60
62
```
61
63
62
64
You may customize the installation directory using the `--prefix=DIR` option to `configure`. If the compression libraries [zlib](https://www.zlib.net) and/or [bzip2](https://www.sourceware.org/bzip2/) are installed on the system, they will be detected automatically and support for compressed files will be included in vsearch (see section **Dependencies** below). Support for compressed files may be disabled using the `--disable-zlib` and `--disable-bzip2` options to `configure`. A PDF version of the manual will be created from the `vsearch.1` manual file if `ps2pdf` is available, unless disabled using the `--disable-pdfman` option to `configure`. It is recommended to run configure with the options `CFLAGS="-O3"` and `CXXFLAGS="-O3"`. Other options may also be applied to `configure`, please run `configure -h` to see them all. GNU autoconf (version 2.63 or later), automake and the GCC C++ (`g++`) compiler is required to build vsearch. Version 3.82 or later of `make` may be required on Linux, while version 3.81 is sufficient on macOS.
**Binary distribution** Starting with version 1.4.0, binary distribution files containing pre-compiled binaries as well as the documentation will be made available as part of each [release](https://github.com/torognes/vsearch/releases). The included executables include support for input files compressed by zlib and bzip2 (with files usually ending in `.gz` or `.bz2`).
@@ -211,7 +213,6 @@ The code is written mostly in C++.
211
213
212
214
File | Description
213
215
---|---
214
-
**align.cc** | New Needleman-Wunsch global alignment, serial. Only for testing.
215
216
**align_simd.cc** | SIMD parallel global alignment of 1 query with 8 database sequences
216
217
**allpairs.cc** | All-vs-all optimal global pairwise alignment (no heuristics)
217
218
**arch.cc** | Architecture specific code (Mac/Linux)
@@ -225,12 +226,15 @@ File | Description
225
226
**db.cc** | Handles the database file read, access etc
226
227
**dbhash.cc** | Database hashing for exact searches
227
228
**dbindex.cc** | Indexes the database by identifying unique kmers in the sequences
228
-
**derep.cc** | Dereplication
229
+
**derep.cc** | Dereplication, full-length
230
+
**derep_prefix.cc** | Dereplication, prefix
231
+
**derep_smallmem.cc** | Dereplication, small memory usage
229
232
**dynlibs.cc** | Dynamic loading of compression libraries
230
233
**eestats.cc** | Produce statistics for fastq_eestats command
VSEARCH may be compiled with zlib or bzip2 integration that allows it to read compressed FASTA files. The [zlib](http://www.zlib.net/) and the [bzip2](https://www.sourceware.org/bzip2/) libraries are needed for this.
271
276
@@ -300,11 +305,13 @@ Special thanks to the following people for patches, suggestions, computer access
300
305
301
306
* Davide Albanese
302
307
* Colin Brislawn
308
+
* Michael R. Crusoe
303
309
* Jeff Epler
304
310
* Christopher M. Sullivan
305
311
* Andreas Tille
306
312
* Sarah Westcott
307
313
314
+
308
315
## Citing VSEARCH
309
316
310
317
Please cite the following publication if you use VSEARCH:
0 commit comments