HOWTO:StandAloneBlast

From BioPerl

Contents 1 Author 2 Copyright 3 Revisions 4 Introduction 5 Checklist 5.1 Install the binaries 5.2 The NCBI configuration file 5.3 Locating the binaries 5.4 Default location of BLAST indices 6 Example session 7 Using WU-BLAST 8 Further reading

Author

Torsten Seemann <torsten.seemann-at-infotech-monash-edu-au>

Victorian Bioinformatics Consortium, Monash University, Australia.

Copyright

This document is copyright Torsten Seemann, 2006. It can be copied and distributed under the terms of the Perl Artistic License.

Revisions

• First draft - Torsten 22:16, 21 April 2006 (EDT)

Introduction

This HOWTO describes the steps you may need to take to get Bio::Tools::Run::StandAloneBlast working with NCBI BLAST on your system. There is a lot of confusion between settings that are purely do to with BLAST itself, settings for the StandAloneBlast module, and settings used by both. Hopefully this document will help clarify this.

Checklist

Install the binaries

StandAloneBlast, despite its name, does not work standalone; it requires that the BLAST binaries/executables are installed on your system. You'll need to download and install the blast package appropriate for your platform from ftp://ftp.ncbi.nlm.nih.gov/blast/ . Let's assume you unpackaged them into /home/blast (Unix) or C:\BLAST (Windows). There should be a bin and data subdirectories.

The NCBI configuration file

This is needed to keep blastall happy.

Unix: $HOME/.ncbirc

 [NCBI] 
 Data=/home/blast/data
 

Windows: C:\WINDOWS\NCBI.INI or C:\WINNT\NCBI.INI

 [NCBI] 
 Data=C:\BLAST\DATA

Locating the binaries

To be able to BLAST sequences, the StandAloneBlast module needs to know where the blastall (Unix) or blastall.exe (Windows) executable is. This can be done in two ways - using PATH or BLASTDIR. Here we combine both methods.

Unix: $HOME/.bashrc

 export PATH=${PATH}:/home/blast/bin
 export BLASTDIR=/home/blast

Windows: C:\AUTOEXEC.BAT [FIXME?]

 PATH=$PATH;C:\BLAST\BIN
 BLASTDIR=C:\BLAST

After you get this part working, typing blastall - should print all the command line options.

Default location of BLAST indices

This is the directory where blastall will look for sequence index files if you don't specify a full path on the -d option (database to search).

Unix: $HOME/.bashrc

 export BLASTDB=/home/blast/data

Windows: C:\AUTOEXEC.BAT [FIXME?]

 BLASTDB=C:\BLAST\DATA

This is not needed if you supply a fully specified path (ie. starts with "/" or "\").

Example session

TODO.

Using WU-BLAST

TODO.

Further reading

• Perl documentation for Bio::Tools::Run::StandAloneBlast
• NCBI BLAST installation guide
• Bioperl Mailing lists