Differences between revisions 11 and 24 (spanning 13 versions)
Revision 11 as of 2012-11-23 14:49:20
Size: 3982
Editor: mark
Comment:
Revision 24 as of 2022-04-29 12:58:21
Size: 1696
Editor: mark
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
= Installing ScrumPy =
== Prerequisites ==
=== Operating Systems ===
The current version of !ScrumPy can be installed on Debian (>=9), Ubuntu (>=1804) For installation on other Unix-like systems see [[ScrumPy/InstallConf|these notes]].
Line 3: Line 7:
= Installation =
<<TableOfContents>>
=== For the impatient ===
Down load the tarball and unpack:
=== Windows ===
!ScrumPy has been reported to work using windows subsystem for linux (WSL).
Line 8: Line 10:
{{{$ 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 [[../Doc/InstallConf|install_conf.py]], and probably on most other unix variants.

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.
=== Mac ===
Not currently supported
Line 28: Line 14:
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. !ScrumPy requires Python 3, Python 2 is not supported.
Line 30: Line 16:
=== 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 (''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.
== Installation ==
Download the current [[http://mudsharkstatic.brookes.ac.uk/Download/ScrumPy.tgz|tarball]], unpack it and cd into the newly created [[ScrumPy|!ScrumPy]] diectory. 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.
Line 33: Line 19:
!ScrumPy will now be installed in
Line 34: Line 21:
{{{ /usr/local/lib/python3/dist-packages/ScrumPy}}}, and the "binary" (actually a soft link into the main package) installed in
Line 35: Line 23:
=== Other dependencies ===
All other dependencies are automatically taken care of by the install script, bit be sure to read the configutation instuctions below.
{{{/usr/local/bin/ScrumPy3}}}
Line 38: Line 25:
== 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.
!ScrumPy can now be started by simply typing !ScrumPy3 at the command line. A few diagnostic messages will appear in the terminal, but these are for information only .
Line 42: Line 27:
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}}} Further documentation continues [[ScrumPy/Doc/ModEnv#RunSpy|here]].
Line 44: Line 29:
=== 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 [[../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.

{{attachment:ScrumPyStart.png| |width=600}}

Further doccumentation continues [[../Doc/ModEnv#RunSpy|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).

Installing ScrumPy

Prerequisites

Operating Systems

The current version of ScrumPy can be installed on Debian (>=9), Ubuntu (>=1804) For installation on other Unix-like systems see these notes.

Windows

ScrumPy has been reported to work using windows subsystem for linux (WSL).

Mac

Not currently supported

Python

ScrumPy requires Python 3, Python 2 is not supported.

Installation

Download the current tarball, unpack it and cd into the newly created !ScrumPy diectory. 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.

ScrumPy will now be installed in

 /usr/local/lib/python3/dist-packages/ScrumPy, and the "binary" (actually a soft link into the main package) installed in

/usr/local/bin/ScrumPy3

ScrumPy can now be started by simply typing ScrumPy3 at the command line. A few diagnostic messages will appear in the terminal, but these are for information only .

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).

None: ScrumPy/Installation (last edited 2022-04-29 12:58:21 by mark)