Differences between revisions 3 and 24 (spanning 21 versions)
Revision 3 as of 2011-08-11 14:33:42
Size: 2298
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 1: Line 1:
= Instalation = ## page was renamed from ScrumPy/InstallNotes
= 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:
=== For the impatient === === Windows ===
!ScrumPy has been reported to work using windows subsystem for linux (WSL).
Line 5: Line 10:
Down load the tarball and unpack:

{{{$ tar zxf ScrumPy.tgz}}}


Now cd into the freshly created directory and check the {{{install_conf.py}}} file. Then (as root)

{{{# python install.py}}}


== Prerequisites ==


=== OS ===

ScrumPy should install on any "Unix-like" system, possibly after tweaking the configuration files (see below).

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 25: Line 14:
!ScrumPy requires Python 3, Python 2 is not supported.
Line 26: Line 16:
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. == 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 28: Line 19:
!ScrumPy will now be installed in
Line 29: Line 21:
=== Other dependencies === {{{ /usr/local/lib/python3/dist-packages/ScrumPy}}}, and the "binary" (actually a soft link into the main package) installed in
Line 31: Line 23:
All other dependencies are automatically taken care of by the install script. {{{/usr/local/bin/ScrumPy3}}}
Line 33: Line 25:
!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 34: Line 27:
== Configuration == Further documentation continues [[ScrumPy/Doc/ModEnv#RunSpy|here]].
Line 36: Line 29:
=== 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).


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


=== Tweaking install_conf.py ===

'''Note''' {{{install_conf.py}}} is a Python module and needs to be syntactically correct.

For installation purposes there are only two places that might need editing: The list of packages to be installed and the command needed to install them. Both of these are self explanatory, although you may need to consult local documentation for the requisite information. The packages needed are all pretty standard and should be present on all up-to-date unix-like systems.

If you do make a custom configuration please send it to me of inclusion with the ScrumPy distribuation.

=== Initial testing ===

The ScrumPy installation script will produce a ''lot'' of verbiage on your terminal,







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