Difference between revisions of "Quick installation instructions for STAMP"

From Bioinformatics Software
Jump to: navigation, search
Line 19: Line 19:
  
 
After you have installed Python and the above libraries, extract the [https://github.com/dparks1134/STAMP/archive/v2.0.3.zip STAMP source code files] to a directory (e.g., C:\STAMP). You can now run STAMP by moving to the source directory and entering <tt>'python ./bin/STAMP'</tt> on your command line. If you get an error message indicating Python cannot be found you likely need to add it to your system path (check out this [http://docs.python.org/using/windows.html#excursus-setting-environment-variables website] for instructions). If you have trouble installing STAMP, please feel free to contact us.
 
After you have installed Python and the above libraries, extract the [https://github.com/dparks1134/STAMP/archive/v2.0.3.zip STAMP source code files] to a directory (e.g., C:\STAMP). You can now run STAMP by moving to the source directory and entering <tt>'python ./bin/STAMP'</tt> on your command line. If you get an error message indicating Python cannot be found you likely need to add it to your system path (check out this [http://docs.python.org/using/windows.html#excursus-setting-environment-variables website] for instructions). If you have trouble installing STAMP, please feel free to contact us.
 
  
 
== Source code on Linux ==
 
== Source code on Linux ==

Revision as of 01:00, 26 May 2014

Contents


Binary release

An executable binary is available for Microsoft Windows. It has been tested under Windows XP SP3 and Windows 7, but will likely also run under Windows Vista. The Windows binary can also be run on Linux or OS X using Virtual Box. Due to differences in how the user interface appears under Windows, Linux and OS X we recommended using Virtual Box to run STAMP. Please note that the first time your run STAMP it may take a minute or more to load. After this, it will start up more quickly.

Note: if you have a pristine copy of Microsoft Windows installed, you may need to install the Microsoft Visual C++ 2008 Redistributable Package (32-bit,64-bit). This package contains a number of commonly required runtime components and as such you likely already have them. STAMP will fail with a message indicating the "configuration is incorrect" if you require this package.

Source code on Microsoft Windows

STAMP is implemented in Python and running it from source is easy. Any operating system that supports Python should be able to run STAMP from source. Running from source is the best way to fully exploit and contribute to STAMP. STAMP is dependent on the following libraries:

After you have installed Python and the above libraries, extract the STAMP source code files to a directory (e.g., C:\STAMP). You can now run STAMP by moving to the source directory and entering 'python ./bin/STAMP' on your command line. If you get an error message indicating Python cannot be found you likely need to add it to your system path (check out this website for instructions). If you have trouble installing STAMP, please feel free to contact us.

Source code on Linux

STAMP can be install on Linux (tested under Ubuntu 14.04) using the following commands:

 sudo apt-get install freetype* python-pip python-dev python-numpy python-scipy python-matplotlib
 sudo pip install STAMP

This installs STAMP for use with the default version of Python on your system. You can now run STAMP by entering 'STAMP' on your command line.

Source code on Apple OS X

Installation of STAMP on OS X is currently untested, but should be the same as for Linux. Please let me know how your experience with installing STAMP of OS X goes so I can update these instructions.

Our build environment

STAMP was developed on Microsoft Windows XP and ported to Apple's OS X. py2exe was used to create the Windows binary. It is generally best to download the latest version of each dependency. Our build environment currently uses the following versions of each dependency:

  • Python 2.7.3
  • PyQt4 4.8.4
  • NumPy 1.7.1
  • SciPy 0.13.0
  • matplotlib 1.3.1
  • biom-format 1.2.0
  • pyqi 0.3.1
  • py2exe 0.6.9