|
Size: 3829
Comment:
|
Size: 2296
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
| = Installation = === For the impatient === Down load the tarball and unpack: |
= Installing ScrumPy = == Prerequisites == === Operating Systems === The current version of !ScrumPy can be installed on Debian 8 (Jessie), Ubuntu 1404 (Trusty) or later and Centos 6. Debian 7 (Wheezy) will probably work, but may result in some loss of function and/or require manual intervention, Debian 6 (Squeeze) will only work with a lot of manual intervention and is deprecated. For installation on other Unix-like systems see [[ScrumPy/InstallConf|these notes]]. |
| Line 6: | Line 7: |
| {{{$ tar zxf ScrumPy.tgz}}} | === Windows === !ScrumPy can also be installed natively on Windows 10. For a guide on this, see [[http://mudsharkstatic.brookes.ac.uk/ScrumPyDoc/scrumpy-on-windows_may2017.pdf|these notes]]. More to follow soon. |
| Line 8: | Line 10: |
| 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. |
=== Mac === Installation on Mac's is planned for the second half of 2017. |
| Line 16: | Line 15: |
| == Prerequisites == === OS === |
=== Python === !ScrumPy requires python 2.7 or 2.8. Python 2.6 ''might ''work but is long obsolete and not reccomended. Python 3 is not currently supported. |
| Line 19: | Line 18: |
| 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. | == Installation == Download the current [[http://mudsharkstatic.brookes.ac.uk/Download/ScrumPy.tgz|tarball]], unpack it and cd into the newly created ScrumPyXXXX directory (XXXX is the revision number). Then, as root, execute the install.py script. This will install a number of prerequisite packages which may take some time depending on what is already installed. A number of extension C libraries will also be compiled that may take a little time and generate a fair ammount of verbiage on the terminal. As long as the last line looks something like: |
| Line 21: | Line 21: |
| {{{ScrumPy}}} should install on any Linux distribution, possibly after editing the configuration file [[../Doc/InstallConf|install_conf.py]], and probably on most other unix variants. | {{{ Makefails = [] }}} this output can safely be ignored. |
| Line 23: | Line 23: |
| 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. | !ScrumPy will now be installed in |
| Line 25: | Line 25: |
| === Python === Python 2.6 or 2.7 are 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. ScrumPy will (currently) run on 2.5, but this is effectively obsolete and thus not recomended. |
{{{ /usr/lib/python2.n/dist-packages/ScrumPy}}}, and a start script installed in |
| Line 28: | Line 27: |
| === SBML === SBML functionality depends on libsbml [[http://sbml.org/Software/libSBML|libsbml]] . This is not distributed as part of ScrumPy, so must be installed separately. Version 5.5 is reccomended. Later versions will ''probably'' be OK, but haven't yet been tested. |
{{{/usr/local/bin/ScrumPy}}} |
| Line 31: | Line 29: |
| === Other dependencies === All other dependencies are automatically taken care of by the install script, bit be sure to read the configutation instuctions below. |
!ScrumPy can now be started by simply typing !ScrumPy at the command line. A few diagnostic messages will appear in the terminal, but these are for information only (see note on SBML below) and not errors. |
| Line 34: | Line 31: |
| == Configuration == === General === Configuration details are held in the file [[../Doc/InstallConf|install_conf.py]]. The default file is suitable for Debian and Ubuntu platforms (and most likely other Debian derivatives). Follow the lik for explanations. |
Further documentation continues [[ScrumPy/Doc/ModEnv#RunSpy|here]]. |
| Line 38: | Line 33: |
| The file {{{install_conf_SUSE.py}}} is suitable for OpenSUSE (and likely SUSE as well) distributions. If using these then copy {{{install_conf_SUSE.py}}} to {{{install_conf.py}}} === 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 Squeeze. If you do get errors at this point check [[../Doc/InstallConf|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. Additional messages appearing here or at the terminal are informational and/or warn of missing optional components, and shoul can be ignored. {{attachment:ScrumPyStart.png| |width=600}} |
== SBML support. == !ScrumPy uses libsbml to to read/write sbml format file. If libsbml is present in your distributions repository it will be installed automatically, otherwise libsbml will need to be installed manually from source (with the python option). |
Installing ScrumPy
Prerequisites
Operating Systems
The current version of ScrumPy can be installed on Debian 8 (Jessie), Ubuntu 1404 (Trusty) or later and Centos 6. Debian 7 (Wheezy) will probably work, but may result in some loss of function and/or require manual intervention, Debian 6 (Squeeze) will only work with a lot of manual intervention and is deprecated. For installation on other Unix-like systems see these notes.
Windows
ScrumPy can also be installed natively on Windows 10. For a guide on this, see these notes. More to follow soon.
Mac
Installation on Mac's is planned for the second half of 2017.
Python
ScrumPy requires python 2.7 or 2.8. Python 2.6 might work but is long obsolete and not reccomended. Python 3 is not currently supported.
Installation
Download the current tarball, unpack it and cd into the newly created ScrumPyXXXX directory (XXXX is the revision number). Then, as root, execute the install.py script. This will install a number of prerequisite packages which may take some time depending on what is already installed. A number of extension C libraries will also be compiled that may take a little time and generate a fair ammount of verbiage on the terminal. As long as the last line looks something like:
Makefails = [] this output can safely be ignored.
ScrumPy will now be installed in
/usr/lib/python2.n/dist-packages/ScrumPy, and a start script installed in
/usr/local/bin/ScrumPy
ScrumPy can now be started by simply typing ScrumPy at the command line. A few diagnostic messages will appear in the terminal, but these are for information only (see note on SBML below) and not errors.
Further documentation continues here.
SBML support.
ScrumPy uses libsbml to to read/write sbml format file. If libsbml is present in your distributions repository it will be installed automatically, otherwise libsbml will need to be installed manually from source (with the python option).