Algorithm for large-scale multiple sequence alignments (400k proteins in 2 hours and 8BG of RAM)
FAMSA comes with a set of precompiled binaries for Windows, Linux, and OS X. They can be found under Releases tab. The basic variant of the algorithm which executes entirely on CPU is contained in a file named famsa. For Windows and Linux systems there is an additional executable famsa-gpu which employs massively parallel processing (GPGPU) with a use of OpenCL.
The software can be also built from the sources distributed as:
- Visual Studio 2015 solution for Windows,
- MAKE project (G++ 4.8 required) for Linux and OS X.
At the top of the makefile there are several switches controlling building process. These are:
- STATIC_LINK - enable static linking (default: false); may be helpful when binary portability is desired,
- NO_AVX - prevent from using AVX and AVX2 extensions (default: false),
- NO_AVX2 - prevent from using AVX2 extensions (default: false),
- NO_GPU - prevent from building famsa-gpu binary (default: false); use it when OpenCL version is not needed.
Note, that FAMSA by default takes advantage of AVX and AVX2 CPU extensions. Pre-built binary detetermines supported instructions at runtime, thus it is multiplatform. However, one may encounter a problem when building FAMSA version on a CPU without AVX and/or AVX2. For this purpose NO_AVX and NO_AVX2 switches are provided.
famsa [options] <input_file_name> <output_file_name>
Positional parameters:
input_file_name- input file in FASTA format or STDIN when reading from standard inputoutput_file_name- output file in FASTA format or STDOUT when writing to standard output
Options:
-go <value>- gap open cost (default: 14.85)-ge <value>- gap extension cost (default: 1.25)-tgo <value>- terminal gap open cost (default: 0.66)-tge <value>- terminal gap extenstion cost (default: 0.66)-gsd <value>- gap cost scaller div-term (default: 7)-gsl <value>- gap cost scaller log-term (default: 45)-dgr- disable gap cost rescaling (default: enabled)-dgo- disable gap optimization (default: enabled)-dsp- disable sum of pairs optimization during refinement (default: enabled)-r <value>- no. of refinement iterations (default: 100)-fr- force refinement (by default the refinement is disabled for sets larger than 1000 seq.)-t <value>- no. of threads, 0 means all available (default: 0)-v- verbose mode, show timing information (default: disabled)-gt <sl, upgma, chained>- choice of guide tree method: single linkage, UPGMA, chained (default: sl)-gt_import <file_name>- import guide tree in Newick format-gt_export <file_name>- export guide tree to Newick format-dist_export <file_name>- export distance matrix to CSV file; works only in UPGMA mode (-gt upgma)
When running famsa-gpu executable, two additional parameters must be specified:
-gpu_p <value>- gpu platform id-gpu_d <value>- gpu device id
FAMSA has the ability to import/export alignment guide trees in Newick format. Below one can find example guide tree file for sequences A, B, and C:
(A:0.1,(B:0.2,C:0.3):0.4);
Note, that when importing the tree, the branch lengths are not taken into account, though they have to be specified in a file for successful parsing. When exporting the tree, all the branches are assigned with length 1, thus only the structure of the tree can be restored (we plan to output real lengths in the future release):
(A:1.0,(B:1.0,C:1.0):1.0);