TPP AMZTPP
From SPCTools
| Revision as of 23:04, 12 March 2012 JoeS (Talk | contribs) (→AWSSECRET File) ← Previous diff |
Revision as of 23:05, 12 March 2012 JoeS (Talk | contribs) (→Environment Variables) Next diff → |
||
| Line 111: | Line 111: | ||
| For Linux (bash shell) use the following commands: | For Linux (bash shell) use the following commands: | ||
| - | export EC2_ACCESS_KEY='<your access key>' | + | export EC2_ACCESS_KEY='your_access_key' |
| - | export EC2_SECRET_KEY='<your secret key>' | + | export EC2_SECRET_KEY='your_secret_key' |
| For Linux (csh shell) use the following commands: | For Linux (csh shell) use the following commands: | ||
| - | setenv EC2_ACCESS_KEY '<your access key>' | + | setenv EC2_ACCESS_KEY 'your_access_key' |
| - | setenv EC2_SECRET_KEY '<your secret key>' | + | setenv EC2_SECRET_KEY 'your_secret_key' |
| ==== AWSSECRET File ==== | ==== AWSSECRET File ==== | ||
Revision as of 23:05, 12 March 2012
AMZTPP is a program developed by the trans-proteomic pipeline team for utilizing cloud computing (specifically Amazon Web Services) to execute multiple different peptide identification programs in parallel on MS/MS data. It can be used to cost effectively analyze large data sets in a short period of time.
Contents |
Installing amztpp
The latest version of the TPP cloud tool amztpp can be downloaded from the TPP sourceforge site at http://sourceforge.net/projects/sashimi/files/amztpp. It is packaged as a gzipped "tar" file and can be unpacked using the standard unix tool tar or on Windows using programs such as 7-zip, WinZip, Stuffit, WinRAR, etc..
Prerequisites
Ironically TPP is not required in order to use the amztpp tool nor do you need to have any of the open source MS/MS identification programs that it uses installed. Though you will find having TPP installed will make it much easier to view and interact with the results produced by amztpp. So its our recommendation that you first install TPP before proceeding following the instructions at Software:TPP.
Since the amztpp tool is written in Perl you therefore need to install Perl on you system before proceeding. If you are on Linux it is very likely that you already have Perl installed on your system. If you are Windows you can download and install the free community edition provided by ActiveState at http://www.activestate.com/activeperl/downloads. (ActivePerl 5.14.2 or greater is required).
Installing amztpp on Linux
First download the latest version from sourceforge if you haven't already and unpack the archive:
% wget http://sashimi.svn.sourceforge.net % tar xvzf amztpp-2.0.tgz % cd amztpp-2.0
There are several ways to proceed from this point. The simplest is to follow the "standard" way of installing perl modules and programs as follows:
% perl Makefile.PL Checking if your kit is complete... Looks good Writing Makefile for AMZTPP Writing MYMETA.yml and MYMETA.json
If you get one or messages like Warning: prerequisite VM::EC2 1.09 not found. this indicates that you'll have to install additional modules for amztpp to work. As before there is a couple of different ways to install them. The easiest is to use CPAN. You can run the CPAN commands manually or there's a convenient rule written in the Makefile called installdeps that will do this for you (you'll likely need root privileges to execute this):
% make installdeps Attempting to install prerequisites using cpan ...
Note that if this is the first time you've installed CPAN modules on your system you may be prompted with a series of questions. Simply accept the defaults for these questions. Another alternative to using CPAN is to use your Linux distributor's package manager. For example, using Ubuntu you'd run commands like "apt-get install libamazon-sqs-s3-perl". See your distributions manual for more details.
The next step is to build and test the program:
% make % make test
A number of tests are skipped by default as they require you to provide your Amazon Credentials and the tests themselves will incur some minor AWS charges. If you want to run the full test set see the section on how to provide your AWS credentials and set these before running the tests.
The final step is to install the program with the command (again likely you'll need root privileges to execute this):
% make install
And that's it. You should now be ready to run amztpp. If you'd like to try it out jump down to the tutorial section to learn more.
 | If you want to change the installation location of amztpp from the default to, say, where you have TPP installed on you system you can use the PREFIX variable when you build the Makefile as so:
% perl Makefile.PL PREFIX=/opt/tpp |
Lastly, for some more references on how to install perl modules on linux please see:
- http://cpan.perl.org/modules/INSTALL.html
- http://www.perlmonks.org/index.pl?node_id=128077
- http://perl.jonallen.info/writing/articles/install-perl-modules-without-root
Installing amztpp on Windows
The process for installing on Windows is similar to the process on Linux. After downloading and installing ActiveState's perl download the amztpp archive and unpack it. Next open up a Windows "command" window by clicking on the start icon and typing "cmd" in the "Search for programs and files" field. When the command window opens up change to the directory ("cd") that you unpacked the archive to. Next configure the build using the same command as with Linux:
C:\AMZTPP-2.0>perl Makefile.PL Set up gcc environment - 4.5.2 Writing Makefile for AMZTPP Writing MYMETA.yml C:\AMZTPP-2.0>
Next make sure dmake is installed and run "dmake" to make the package for your system.
C:\AMZTPP-2.0>ppm install dmake C:\AMZTPP-2.0>dmake
You'll likely also see some messages warning about missing perl modules that are required. To install these you can manually use the perl package manager (ppm) that comes with ActiveState perl. Or simply this which will do it for you:
C:\AMZTPP-2.0>dmake installdeps
The next step is to test the program:
C:\AMZTPP-2.0>dmake test
A number of tests are skipped by default as they require you to provide your Amazon Credentials and the tests themselves will incur some minor AWS charges. If you want to run the full test set see the section on how to provide your AWS credentials and set these before running the tests.
Lastly, install the program with:
C:\AMZTPP-2.0\dmake install
Setting up your Amazon Credentials
Almost all of AMZTPP's operations require you to provide credentials to Amazon Web Services to confirm that you are who you say you are and that you do have permissions to do what you are trying to do. These credentials are know as Amazon's access and secret key. These keys are used to make secure REST or Query protocol requests to any AWS service API and are created automatically for you when your account is created.
You can look up what these values are on your Amazon Security Credentials page. Your access key and secret key are displayed under the Access Keys tab in the Credentials Section of the page.
There are a couple of different ways to provide these keys when running the amztpp command outlined in the next three sections.
Command line options
You can use the command line options --access-key and --secret-key options each time you invoke a command.
Environment Variables
By setting environment variables EC2_ACCESS_KEY and EC2_SECRET_KEY (and optionally EC2_REGION). You'll have to set these each time you log in unless you set these up in your shell login.
For Linux (bash shell) use the following commands:
export EC2_ACCESS_KEY='your_access_key' export EC2_SECRET_KEY='your_secret_key'
For Linux (csh shell) use the following commands:
setenv EC2_ACCESS_KEY 'your_access_key' setenv EC2_SECRET_KEY 'your_secret_key'
AWSSECRET File
The last and most convenient (but not necessarily the safest) way is by putting your keys in a .awssecret file. To do this on Linux you would run:
% echo 'your_access_key' > ~/.awssecret % echo 'your_secret_key' >> ~/.awssecret % echo chmod 600 ~/.awssecret
and on Windows you would run:
C:\echo your_access_key> %LocalAppData%\.awssecret C:\echo your_secret_key>> %LocalAppData%\.awssecret
If you use this mechanism always make sure you keep the permissions of this file strict and never share it with anyone.
AMZTPP Tutorial
Download and install the test data and database
For this tutorial we'll be using the same dataset used by the TPP tutorial. This is a SILAC-labeled Yeast dataset comprised of 2 runs on a high mass-accuracy Orbitrap instrument, along with a Yeast database appended with decoys. We also include a search parameters file. If you haven't already downloaded it you install it by:
- Download the mzML files (768Mb) and unzip.
- Download the database and parameters files (2.1Mb) and unzip.
- Copy or move the yeast_orfs_all_REV.20060126.short.fasta file into the folder C:\Inetpub\wwwroot\ISB\data\dbase\speclibs creating the directories if necessary
- Copy or move the two data files (OR20080317_S_SILAC-LH_1-1_01.mzML and OR20080317_S_SILAC-LH_1-1_11.mzML) as well as the tandem parameters file tandem.xml into the folder C:\Inetpub\wwwroot\ISB\data\demo2009\tandem. Create this last folder if necessary.
