View source for Quick installation instructions for STAMP

__TOC__

== Binary release ==

A executable binary is available for [[Media:STAMP_2_setup_rc1.exe|Microsoft Windows]]. It has been tested under Windows XP SP3 and Windows 7, but will likely also run under Windows Vista. An '''experimental''' binary for [[Media:STAMP_2_setup_rc1_SnowLeopard.zip|OS X Snow Leopard]] is also available although there are a few [[Known OS X issues|known OS X bugs]]. The Windows binary can also be run on OS X using [http://www.virtualbox.org/ Virtual Box]. Due to differences in how the user interface appears under Windows and OS X we recommended using Virtual Box with Windows 7 to run STAMP under OS X. 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 ([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.

== 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:

* [http://www.python.org/download/ Python 2.5 or 2.6] (we recommend Python 2.6.4)
* [http://www.riverbankcomputing.co.uk/software/pyqt/download PyQt4]
* [http://www.scipy.org/ NumPy and SciPy] 
* [http://matplotlib.sourceforge.net/ matplotlib]

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 ==

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 [http://www.macports.org 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-sip
  sudo port install py26-macholib
  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, py26-sip = 10 min, py26-macholib = 1 min, py26-pyqt4 = 3 hours, py26-numpy = 3 hours, py26-scipy = 15 min, 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 [[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 ==

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 [[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 ==

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:
 
* [http://www.python.org/download/ Python 2.5 or 2.6] (we recommend Python 2.6.4)
* [http://www.scipy.org/ NumPy and SciPy] 

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 ==

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