Installation
Contents
For the impatient
Down load the tarball and unpack:
$ tar zxf ScrumPy.tgz
Now cd into the freshly created directory then (as root):
# python install.py
This will create a launcher script - /usr/local/bin/ScrumPy by default - which can be simply run from the command line.
Prerequisites
OS
We currently use debian/squeeze as our development platform, and if you have the choice this is reccomended as you should then be able to continue in impatient mode.
ScrumPy should install on any Linux distribution, possibly after editing the configuration file install_conf.py, and probably on most other unix variants. Brief notes for installing on Red Hat derivatives can be found here
We don't have a Windows version, and we are not currently planning one. If anyone is interested in porting ScrumPy to windows please get in touch. As far as I am aware, there are only two places in the source that would require modification, both of which are concerned with loading shared objects.
Python
Python 2.7 is recommended. 2.8 would probably be OK, but has not yet been fully tested, and may produce verbiage concerning Python 3 issues. Python 3 will almost certainly not (at present) work.
SBML
SBML functionality depends on libsbml libsbml . This is not distributed as part of ScrumPy, so must be installed separately (after installing ScrumPy). Version 5.5 is reccomended. Later versions will probably be OK, but haven't yet been tested. When installing libsbml ensure you specify "--with-python" at the configuration stage. You will als need to run "ldconfig" once the installation is complete.
Other dependencies
All other dependencies are automatically taken care of by the install script, bit be sure to read the configutation instuctions below.
Configuration
General
Configuration details are held in the file install_conf.py. The default file is suitable for Debian and Ubuntu platforms (and most likely other Debian derivatives). Follow the lik for explanations.
Other Options
The install script recognises two additioanl arguments which can appear anywhere on the command line : "NOPKG" and "LIBONLY".
If the "NOPGK" argument is given none of the dependent packages will be installed. This will speed things a bit if you know that the packages are in place. Another time at which this might be useful is if you are installing as a non-root user. However, under these circumstances you will need write access in other places (see install_conf).
The "LIBONLY" compiles and installs the C extension modules without installing any Python. This is a development/maintaince option only.
Initial testing
The ScrumPy installation script will produce a lot of verbiage on your terminal, however this mainly reportage/diganostic information related to the compilation of the varous C libraries. If you see explicit errors here, it is most likely due to missing or non-standard development packages. Another possibility is your C compiler is stricter than gcc 4.4.5 currently distributed with Debian-Squeeze. If you do get errors at this point check install_conf.py and if the problem remains unfixable, get in touch.
Once installed Scrumpy can be run by simply entering Scrumpy at the command line. You should then see the main ScrumPy window shown below.
Further doccumentation continues here.