SEPP

Mirarab, Siavash, Nam Nguyen, and Tandy Warnow. “SEPP: SATé-Enabled Phylogenetic Placement.” Pacific Symposium On Biocomputing, 2012, 247–58 (PubMed).

SATé-enabled phylogenetic placement (SEPP) is a software package for phylogenetic placement.

Data

• Empirical data: empirical.tar.gz
  • Uncompress files ending in ".tar.gz" using the command "tar -zxvf <file>".
  • Within each resulting directory is a file named "README" which describes the contents of the download.
• Simulated data: sims.tar.gz
  • Uncompress files ending in ".tar.gz" using the command "tar -zxvf <file>".
  • Within each resulting directory is a file named "README" which describes the contents of the download.

Software

• To download and to see details on how to install and run latest version of SEPP, please see our github repository. The README file on the github repository has instructions for installation.
• A tutorial describing how SEPP works is is available here. Note that the github repository also has the tutorial included, and the github version is more up-to-date.
• If you are interested in the version corresponding to the PSB paper, pleaser refer to "Version 1.0 instructions" section below.

Version 1.0 instructions:

This section details instructions for installing and running version 1.0 of SEPP. This is the version used in the submission of the SEPP paper. Current users should use the latest github version instead of the following instructions. Version 1.0 is provided in this page only to enable replication of the results reported in the paper.

• We ran SEPP on a machine running Linux release 2.6.32-33-server. If you experience difficulty installing or running the software, please contact one of us (Tandy Warnow, Nam Nguyen, or Siavash Mirarab.
1. Installing HMMER package.
   • Download the HMMER binaries from the HMMER website. Modify your PATH environment variable to include the directory of the HMMER binaries.
2. Installing pplacer.
   • Download the pplacer binary from the pplacer webiste. Modify your PATH environment variable to include the location of the pplacer binary.
3. Installing python packages.
   • The software packages listed below are Python source distributions. To use them, you must first have Python installed on your system; for details on obtaining and installing Python, please visit the Python home page. We used Python version 2.6.
   • To uncompress and inflate each distribution file, run "tar -xzf <package>.tar.gz". To install each package, run "python setup.py install" from inside the uncompressed package directory; this step requires root access to the system.
   • If you do not have root access, invoke the setup script as follows: "python setup.py install --prefix=/some/path/on/your/system", where "/some/path/on/your/system" is the path to a directory on your system to which you do have read and write access. If you use the "--prefix" option, you must ensure that the "lib/python2.x/site-packages" subdirectory (where "x" denotes the minor version number of your Python install) of the directory you specify following "--prefix=" is on Python's search path. To add a directory to Python's search path, modify yourPYTHONPATH environment variable.
   • More instructions on installing Python packages can be found on this Python page.
4. Install the DendroPy 3 package.
   • DendroPy-3.9.0.tar.gz
5. Install the NumPy package.
   • numpy-1.6.1.tar.gz
6. Install the Biopython package.
   • biopython-1.58.tar.gz
7. Install the SEPP package.
   • sepp-1.0.tar.gz (see the file list above)
   • After installing, add an environment variable MERGE_JAR with the absolute path to the the location of merge.jar. This jarfile is included in the gzip in the folder location sepp-1.0/sepp/tools/merge.jar.
   • A README file for running SEPP can be found in sepp-1.0/.
8. Running SEPP.
   • To run SEPP, invoke the "run_sepp.py" script from the "bin" subdirectory of the location in which you installed the Python packages. To see options for running the script, using the command
     • "python <bin>/run_sepp.py -h"
   • The general command for running sepp is:
     • "python <bin>/run_sepp.py -t <tree_file> -a <alignment_file> -f <fragment_file> -r <raxml_info_file> -A <alignment_set_size> -P <placement_set_size> "
   • SEPP can also be run using a configuration file. Sample configuration files and input files can be found in the folder location sepp-1.0/sample/. Change to that directory to run SEPP on the sample files. To run using command options, run
     • python <bin>/run_sepp.py -t test.tree -a test.fasta -f test.fas -r test.RAxML_info -A 250 -P 250
   • and to run using a configuration file, run
     • "python <bin>/run_sepp.py -c sample.config"
   • The output of SEPP is a .json file, created according to pplacer format. Please refer to here for more information on the format of the josn file. Also note that pplacer package provides a program called guppy that can read .json files and perform downstream steps such as visualization.