1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
|
# BppSuite presentation
BppSuite is a suite of ready-to-use programs for phylogenetic and sequence analysis.
## Installation
### Standalone executables
Standalone executables are available for [linux64](https://github.com/BioPP/bppsuite/releases/tag/v2.3.2)
[//]: [win32](http://biopp.univ-montp2.fr/repos/exe/win32/), [win64](http://biopp.univ-montp2.fr/repos/exe/win64/) and [Mac](http://biopp.univ-montp2.fr/repos/exe/mac/)
### From source files
#### Get the sources
This is done with <tt>git</tt>, for example in directory <tt>$bpp_dir</tt>:
<h5>
<pre>
cd $bpp_dir
git clone https://github.com/BioPP/bppsuite
</pre>
</h5>
#### Compiling
Bio++ libraries need to be installed beforehand, for example in <tt>$bpp_dir</tt>. The needed libraries are [bpp-core](https://github.com/BioPP/bpp-core), [bpp-seq](https://github.com/BioPP/bpp-seq), [bpp-phyl](https://github.com/BioPP/bpp-phyl), [bpp-popgen](https://github.com/BioPP/bpp-popgen).
After, you proceed:
<h5>
<pre>
cd bppsuite
cmake -DCMAKE_INSTALL_PREFIX=$bpp_dir ./ # prepare compilation
make # compile
make install # move files to the installation directory (this will create a $bpp_dir/bin/ directory)
</pre>
</h5>
That's it ! The executables are now installed in <tt>$bpp_dir/bin</tt>.
Without the option <tt>-DCMAKE_INSTALL_PREFIX=$bpp_dir</tt>, the standard <tt>/usr/local</tt> directory will be used, and the executables installed in <tt>/usr/local/bin</tt>, a location which requires superuser access rights.
## Usage
Bppsuite executables should know where the dynamic libraries are. A way to check it is the command:
<h5>
<pre>
ldd $bpp_dir$/bin/bppml
</pre>
</h5>
To configure this, set in the shell environment variable :
<h5>
<pre>
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$bpp_dir
</pre>
</h5>
(and source the configuration file or relog).
## Documentation
You can also generate the pdf documentation by typing :
<h5>
<pre>
make pdf
</pre>
</h5>
### Examples
Many examples are available in the subdirectory of <tt>Examples</tt>.
### Documentation
Documentation can be found in one page at: http://bioweb.me/bppsuite-doc
Or on github: https://github.com/BioPP/bppsuite/releases/tag/v2.3.2 in pdf or html.
|