Skip to content

Commit bd17e9a

Browse files
committed
Update README.md
1 parent bf5fdb2 commit bd17e9a

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

+21-13
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,20 @@ We have implemented a tool called VSEARCH which supports *de novo* and reference
1616

1717
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.
1818

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.
2020

21-
| CPU \ OS | GNU/Linux | MacOS | Windows |
21+
| CPU \ OS | GNU/Linux | macOS | Windows |
2222
| ------------- | :-----------: | :----: | :-------: |
2323
| x86_64 ||||
2424
| ARMv8 ||| |
2525
| POWER8 || | |
26+
| RISCV64 | not tested | | |
27+
| MIPS64EL | not tested | | |
2628

2729
Various packages, plugins and wrappers are also available from other sources - see [below](https://github.com/torognes/vsearch#packages-plugins-and-wrappers).
2830

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
3133
[FreeBSD](https://www.freebsd.org/) and
3234
[NetBSD](https://www.netbsd.org/) systems.
3335

@@ -55,8 +57,8 @@ tar xzf v2.28.1.tar.gz
5557
cd vsearch-2.28.1
5658
./autogen.sh
5759
./configure CFLAGS="-O3" CXXFLAGS="-O3"
58-
make
59-
make install # as root or sudo make install
60+
make ARFLAGS="cr"
61+
sudo make install
6062
```
6163

6264
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.
@@ -70,8 +72,8 @@ git clone https://github.com/torognes/vsearch.git
7072
cd vsearch
7173
./autogen.sh
7274
./configure CFLAGS="-O3" CXXFLAGS="-O3"
73-
make
74-
make install # as root or sudo make install
75+
make ARFLAGS="cr"
76+
sudo make install
7577
```
7678

7779
**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++.
211213

212214
File | Description
213215
---|---
214-
**align.cc** | New Needleman-Wunsch global alignment, serial. Only for testing.
215216
**align_simd.cc** | SIMD parallel global alignment of 1 query with 8 database sequences
216217
**allpairs.cc** | All-vs-all optimal global pairwise alignment (no heuristics)
217218
**arch.cc** | Architecture specific code (Mac/Linux)
@@ -225,12 +226,15 @@ File | Description
225226
**db.cc** | Handles the database file read, access etc
226227
**dbhash.cc** | Database hashing for exact searches
227228
**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
229232
**dynlibs.cc** | Dynamic loading of compression libraries
230233
**eestats.cc** | Produce statistics for fastq_eestats command
231-
**fasta2fastq.cc** | FASTA to FASTQ conversion
232234
**fasta.cc** | FASTA file parser
235+
**fasta2fastq.cc** | FASTA to FASTQ conversion
233236
**fastq.cc** | FASTQ file parser
237+
**fastq_chars.cc** | FASTQ statistics
234238
**fastq_join.cc** | FASTQ paired-end reads joining
235239
**fastqops.cc** | FASTQ file statistics etc
236240
**fastx.cc** | Detection of FASTA and FASTQ files, wrapper for FASTA and FASTQ parsers
@@ -249,8 +253,8 @@ File | Description
249253
**rereplicate.cc** | Rereplication
250254
**results.cc** | Output results in various formats (alnout, userout, blast6, uc)
251255
**search.cc** | Implements search using global alignment
252-
**searchcore.cc** | Core search functions for searching, clustering and chimera detection
253256
**search_exact.cc** | Exact search functions
257+
**searchcore.cc** | Core search functions for searching, clustering and chimera detection
254258
**sff_convert.cc** | SFF to FASTQ file conversion
255259
**sha1.c** | SHA1 message digest
256260
**showalign.cc** | Output an alignment in a human-readable way given a CIGAR-string and the sequences
@@ -265,7 +269,8 @@ File | Description
265269
**userfields.cc** | Code for parsing the userfields option argument
266270
**util.cc** | Various common utility functions
267271
**vsearch.cc** | Main program file, general initialization, reads arguments and parses options, writes info.
268-
**xstring.h** | Code for a simple string class
272+
**utils/maps.cc** | Utilities, maps for encoding of nucleotides
273+
**utils/seqcmp.cc** | Utilities, sequence comparison
269274

270275
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.
271276

@@ -300,11 +305,13 @@ Special thanks to the following people for patches, suggestions, computer access
300305

301306
* Davide Albanese
302307
* Colin Brislawn
308+
* Michael R. Crusoe
303309
* Jeff Epler
304310
* Christopher M. Sullivan
305311
* Andreas Tille
306312
* Sarah Westcott
307313

314+
308315
## Citing VSEARCH
309316

310317
Please cite the following publication if you use VSEARCH:
@@ -314,6 +321,7 @@ doi: [10.7717/peerj.2584](https://doi.org/10.7717/peerj.2584)
314321

315322
Please note that citing any of the underlying algorithms, e.g. UCHIME, may also be appropriate.
316323

324+
317325
## Test datasets
318326

319327
Test datasets (found in the separate vsearch-data repository) were

0 commit comments

Comments
 (0)