Difference between revisions of "Quick installation instructions for STAMP"

From Bioinformatics Software
Jump to navigationJump to search
Line 3: Line 3:
 
== Binary release ==
 
== Binary release ==
  
A precompiled binary is available for [[Media:STAMP_1.0_Setup_Win32.exe‎|Microsoft Windows]]. The binary has only been tested under Windows XP SP3, but will likely run under Windows Vista and Windows 7. If you are running one of these newer operating systems we would appreciate knowing if this binary worked for you.
+
A precompiled binary is available for [[Media:STAMP_1.0_Setup_Win32.exe‎|Microsoft Windows]]. The binary has only been tested under Windows XP SP3, but will likely run under Windows Vista and Windows 7. If you are running one of these newer operating systems, we would appreciate knowing if this binary worked for you.
  
Note: if you have a pristine copy of Microsoft Windows installed you may need to install the [http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en|Microsoft Visual C++ 2008 Redistributable Package]. 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.
+
Note: if you have a pristine copy of Microsoft Windows installed, you may need to install the [http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en|Microsoft Visual C++ 2008 Redistributable Package]. 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 ==
 
== Source code on Microsoft Windows ==
Line 17: Line 17:
 
* [http://matplotlib.sourceforge.net/ matplotlib]
 
* [http://matplotlib.sourceforge.net/ matplotlib]
  
After you have installed Python and the above libraries, extract the [[Media:STAMP_1.0_source.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 STAMP.py'</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 [[Media:STAMP_1.0_source.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 STAMP.py'</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 Apple's OS X ==
 
== Source code on Apple's OS X ==
  
Running STAMP from source on Apple's OS X is straight-forward. It requires minimal effort on your part, although it does require a lot of compiling to be done by your computer. There are many ways to get STAMP running for source, but we have found the following the simplest (if you have a better way, please let us know):
+
Running STAMP from source on Apple's OS X is straight-forward. It requires minimal effort on your part, although it does require a lot of compiling to be done by your computer. There are many ways to get STAMP running from source, but we have found the following the simplest (if you have a better way, please let us know):
  
 
* Install [http://darwinports.com/ DarwinPorts]
 
* Install [http://darwinports.com/ DarwinPorts]
Line 39: Line 39:
 
   sudo port install py26-matplotlib
 
   sudo port install py26-matplotlib
  
Our first attempt to install py26-pyqt4 failed, but was successful on our second attempt. Here are some rough estimates on the time required to installing each of these package: python26 = 1 hour, python_select = 30 seconds, py26-macholib = 1 min, py26-sip = 10 min, py26-pyqt4 = 3 hours, py26-numpy = 3 hours, py26-scipy = 15 min, py26-mpmath = 30 seconds, py26-matplotlib = 5 min.
+
Our first attempt to install py26-pyqt4 failed, but was successful on our second attempt. Here are some rough estimates on the time required to install each of these package: python26 = 1 hour, python_select = 30 seconds, py26-macholib = 1 min, py26-sip = 10 min, py26-pyqt4 = 3 hours, py26-numpy = 3 hours, py26-scipy = 15 min, py26-mpmath = 30 seconds, py26-matplotlib = 5 min.
  
 
To test that all dependencies where installed correctly, start a python session and import each package:
 
To test that all dependencies where installed correctly, start a python session and import each package:
Line 48: Line 48:
 
   import matplotlib
 
   import matplotlib
  
After you have installed Python and the above libraries, extract the [[Media:STAMP_1.0_source.zip|STAMP source code files]] to a directory (e.g., ~\STAMP). You can now run STAMP by moving to the source directory and entering <tt>'python STAMP.py'</tt> on your command line.  If you have trouble installing STAMP please feel free to contact us.
+
After you have installed Python and the above libraries, extract the [[Media:STAMP_1.0_source.zip|STAMP source code files]] to a directory (e.g., ~\STAMP). You can now run STAMP by moving to the source directory and entering <tt>'python STAMP.py'</tt> on your command line.  If you have trouble installing STAMP, please feel free to contact us.
  
 
== Our build environment ==
 
== Our build environment ==
  
STAMP was developed on Microsoft Windows XP and ported to Apple's Mac OS X. [http://www.py2exe.org/ py2exe] was used to create the Windows binary. Generally it is best to download the latest version of each dependency. Our build environment currently uses the following versions of each dependency:
+
STAMP was developed on Microsoft Windows XP and ported to Apple's Mac OS X. [http://www.py2exe.org/ 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.6.4
 
* Python 2.6.4

Revision as of 21:07, 9 December 2009

Binary release

A precompiled binary is available for Microsoft Windows. The binary has only been tested under Windows XP SP3, but will likely run under Windows Vista and Windows 7. If you are running one of these newer operating systems, we would appreciate knowing if this binary worked for you.

Note: if you have a pristine copy of Microsoft Windows installed, you may need to install the Visual C++ 2008 Redistributable Package. 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 STAMP.py' 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 Apple's OS X

Running STAMP from source on Apple's OS X is straight-forward. It requires minimal effort on your part, although it does require a lot of compiling to be done by your computer. There are many ways to get STAMP running from source, but we have found the following the simplest (if you have a better way, please let us know):

  • Install DarwinPorts
  • Update DarwinPorts by typing the following into a console:
 sudo port -d selfupdate 

From your console, install the necessary dependencies for STAMP using port:

 sudo port install python26
 sudo port install python_select
 sudo python_select python26
 sudo port install py26-macholib
 sudo port install py26-sip
 sudo port install py26-pyqt4
 sudo port install py26-numpy
 sudo port install py26-scipy
 sudo port install py26-mpmath
 sudo port install py26-matplotlib

Our first attempt to install py26-pyqt4 failed, but was successful on our second attempt. Here are some rough estimates on the time required to install each of these package: python26 = 1 hour, python_select = 30 seconds, py26-macholib = 1 min, py26-sip = 10 min, py26-pyqt4 = 3 hours, py26-numpy = 3 hours, py26-scipy = 15 min, py26-mpmath = 30 seconds, py26-matplotlib = 5 min.

To test that all dependencies where installed correctly, start a python session and import each package:

 import PyQt4
 import numpy
 import scipy
 import mpmath
 import matplotlib

After you have installed Python and the above libraries, extract the STAMP source code files to a directory (e.g., ~\STAMP). You can now run STAMP by moving to the source directory and entering 'python STAMP.py' on your command line. If you have trouble installing STAMP, please feel free to contact us.

Our build environment

STAMP was developed on Microsoft Windows XP and ported to Apple's Mac 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.6.4
  • PyQt4 4.6.2
  • NumPy 1.3.0
  • SciPy 0.7.1
  • mpmath 0.13
  • matplotlib 0.99.1.1
  • py2exe 0.6.9