TPP AMZTPP
From SPCTools
Revision as of 23:54, 11 March 2012 JoeS (Talk | contribs) ← Previous diff |
Revision as of 18:31, 12 March 2012 JoeS (Talk | contribs) (→Setting up amztpp) Next diff → |
||
Line 1: | Line 1: | ||
+ | '''''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. | ||
+ | |||
== Setting up amztpp == | == Setting up amztpp == | ||
- | The latest version of the TPP cloud tool amztpp can be downloaded from the TPP sourceforge site at http://sashimi.svn.sourceforge.net. 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.. | + | 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 ==== | ==== Prerequisites ==== | ||
Line 13: | Line 15: | ||
First download the latest version from sourceforge if you haven't already and unpack the archive: | First download the latest version from sourceforge if you haven't already and unpack the archive: | ||
- | wget <nowiki>http://sashimi.svn.sourceforge.net</nowiki> | + | % wget <nowiki>http://sashimi.svn.sourceforge.net</nowiki> |
- | tar xvzf amztpp-2.0.tgz | + | % tar xvzf amztpp-2.0.tgz |
- | cd amztpp-2.0 | + | % 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: | 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 | ||
- | The amztpp tool is written in Perl and is installed using the standard Perl way of installing programs and modules. The following commands show the simplest way to get it installed, and you'll need root privileges to install: | + | 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): | ||
- | tar xvzf amztpp-2.0.tgz | + | % make install |
- | cd amztpp-2.0 | + | |
- | perl Makefile.PL | + | |
- | make | + | |
- | make test | + | |
- | 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. | ||
==== Installing amztpp on Windows ==== | ==== Installing amztpp on Windows ==== |
Revision as of 18:31, 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 |
Setting up 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.
Installing amztpp on Windows
- Download amztpp from the TPP Subversion tree at: http://sashimi.svn.sourceforge.net/viewvc/sashimi/trunk/trans_proteomic_pipeline/extern/hpctools/aws/
- Run perl Makefile.pl
- There are a large number of dependencies that may need to be installed in order to install amztpp.
- Run make install