Difference between revisions of "Quick installation instructions for STAMP"

From Bioinformatics Software
Jump to: navigation, search
(Source code on Linux)
Line 3: Line 3:
 
== Binary release ==
 
== Binary release ==
  
Precompiled binaries are available for [[Media:STAMP_1.08_Setup.exe|Microsoft Windows]] and [[Media:STAMP_1_08_OS_X.zip‎|Mac OS X]]. The Windows binary has been tested under Windows XP SP3 and Windows 7, but will likely also run under Windows Vista. The OS X binary has been tested under Leopard and Snow Leopard. Please note that the first time your run STAMP it may take a minute or more to load. After this, it will start up far more quickly. If either of these binaries fail to work for you please let us know. 
+
A executable binary is available for [[Media:STAMP_2_setup_rc1.zip.exe|Microsoft Windows]]. It has been tested under Windows XP SP3 and Windows 7, but will likely also run under Windows Vista. An binary for Leopard and Snow Leopard is currently underway. Please note that the first time your run STAMP it may take a minute or more to load. After this, it will start up far 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 ([http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en 32-bit],[http://www.microsoft.com/downloads/details.aspx?familyid=bd2a6171-e2d6-4230-b809-9a8d7548c1b6&displaylang=en 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.
 
Note: if you have a pristine copy of Microsoft Windows installed, you may need to install the Microsoft Visual C++ 2008 Redistributable Package ([http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en 32-bit],[http://www.microsoft.com/downloads/details.aspx?familyid=bd2a6171-e2d6-4230-b809-9a8d7548c1b6&displaylang=en 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.
Line 14: Line 14:
 
* [http://www.riverbankcomputing.co.uk/software/pyqt/download PyQt4]
 
* [http://www.riverbankcomputing.co.uk/software/pyqt/download PyQt4]
 
* [http://www.scipy.org/ NumPy and SciPy]  
 
* [http://www.scipy.org/ NumPy and SciPy]  
* [http://code.google.com/p/mpmath/ mpmath]
 
 
* [http://matplotlib.sourceforge.net/ matplotlib]
 
* [http://matplotlib.sourceforge.net/ matplotlib]
  
After you have installed Python and the above libraries, extract the [[Media:STAMP_1_08_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_2_source_rc1.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 OS X ==
 
== Source code on Apple OS X ==
Line 35: Line 34:
 
   sudo port install py26-numpy
 
   sudo port install py26-numpy
 
   sudo port install py26-scipy
 
   sudo port install py26-scipy
  sudo port install py26-mpmath
 
 
   sudo port install py26-matplotlib
 
   sudo port install py26-matplotlib
  
Line 44: Line 42:
 
   import numpy
 
   import numpy
 
   import scipy
 
   import scipy
  import mpmath
 
 
   import matplotlib
 
   import matplotlib
  
After you have installed Python and the above libraries, extract the [[Media:STAMP_1_08_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_2_source_rc1.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.
  
 
== Source code on Linux ==
 
== Source code on Linux ==
Line 55: Line 52:
 
   sudo apt-get install python-scipy python-numpy python-matplotlib pyqt-dev-tools
 
   sudo apt-get install python-scipy python-numpy python-matplotlib pyqt-dev-tools
  
All other STAMP dependencies, including the python-mpmath library, will be automatically installed.
+
All other STAMP dependencies will be automatically installed.
  
After you have installed the above libraries, extract the [[Media:STAMP_1_08_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.
+
After you have installed the above libraries, extract the [[Media:STAMP_2_source_rc1.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.
  
 
== Command-line interface install ==
 
== Command-line interface install ==
Line 65: Line 62:
 
* [http://www.python.org/download/ Python 2.5 or 2.6] (we recommend Python 2.6.4)
 
* [http://www.python.org/download/ Python 2.5 or 2.6] (we recommend Python 2.6.4)
 
* [http://www.scipy.org/ NumPy and SciPy]  
 
* [http://www.scipy.org/ NumPy and SciPy]  
* [http://code.google.com/p/mpmath/ mpmath]
 
  
For details on running STAMP from the command-line please see the [[Media:STAMP_Users_Guide.pdf|User's Guide]].
+
For details on running STAMP from the command-line please see the [[Media:STAMP_Users_Guide_v2.0.0.pdf|User's Guide]].
  
 
== 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. It is generally 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 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
Line 77: Line 73:
 
* NumPy 1.6.0
 
* NumPy 1.6.0
 
* SciPy 0.9.0
 
* SciPy 0.9.0
* mpmath 0.17
 
 
* matplotlib 1.0.1
 
* matplotlib 1.0.1
 
* py2exe 0.6.9
 
* py2exe 0.6.9

Revision as of 17:03, 11 August 2011

Contents


Binary release

A 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. An binary for Leopard and Snow Leopard is currently underway. Please note that the first time your run STAMP it may take a minute or more to load. After this, it will start up far 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 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 OS X

Installing STAMP from source on Apple OS X is straight-forward. It requires minimal effort on your part, although it does require a lot of compiling. STAMP can be installed from source as follows:

  • Install MacPorts
  • Update MacPorts 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 select --set python 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-matplotlib

Here are some rough estimates on the time required to install each of these packages: 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 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.

Source code on Linux

Heikki Lehvaslaiho has generously suggested the following approach for (K)ubuntu 11.04. From the command line run:

 sudo apt-get install python-scipy python-numpy python-matplotlib pyqt-dev-tools

All other STAMP dependencies will be automatically installed.

After you have installed 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.

Command-line interface install

If you wish to use STAMP strictly from the command-line (e.g., as typical of a cluster environment) only the following 3rd-party dependencies are required:

For details on running STAMP from the command-line please see the User's Guide.

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.6.4
  • PyQt4 4.8.4
  • NumPy 1.6.0
  • SciPy 0.9.0
  • matplotlib 1.0.1
  • py2exe 0.6.9