Installation¶
Supported platforms¶
BESTUI is cross-platform, it should work on all platforms where the Requirements are met.
Here are reported the platforms on which the application is currently developed and tested:
Requirements¶
In order to run BESTGUI you need to install the following software:
- BEST v. 4.0 or higher
- Python v. 2.4 or higher
- PyGTK v. 2.6 or higher
- libglade v. 2.4 or higher
- win32all extensions (WindowsTM only)
- pygtksourceview (optional)
Recommended tools for the developers:
Note
PyGTK requires the GTK+ library. While it is usually already installed on UNIX platforms, you may need to download and install it by yourself on WindowsTM.
A good GTK+ distribution for win32 can be found here.
How to get it¶
You can download the source code and binary packages from the BESTGUI project page on SourceForge.
Both source and binary packages include the full HTML documentation and the PDF version of the User Manual.
Available packages formats¶
In order to fit the needs of a number of users as wide as possible several kind of packages are available for the download:
| bestgui-x.yy.z.tar.gz: | |
|---|---|
| gzipped tarball of the standard source package | |
| bestgui-x.yy.z.noarch.rpm: | |
| platform independent binary package in RPM format | |
| bestgui-x.yy.z-k_all.deb: | |
| binary Debian package | |
| bestgui-x.yy.z.win32.exe: | |
| windows binary installer. It includes the only BESTGUI package, so all the software mentioned in the Requirements section should be downloaded and installed separately) | |
The content of this packages includes:
- the BESTGUI source, glade files and configuration files
- the “BESTGUI User Manual” in txt, HTML and PDF format
For the WindowsTM platform are also available the following packages:
| bestgui-x.yy-bin-win32.zip: | |
|---|---|
| windows binary package in zip format. It includes all the software and libraries needed to run BESTGUI (but BEST itself) | |
| bestgui-x.yy.z-bin-win32-setup.exe: | |
| windows binary installer including all the software and libraries needed to run BESTGUI (but BEST itself) | |
In detail the above two package types include:
- the BESTGUI source, glade files and configuration files
- the “BESTGUI User Manual” in txt, HTML and PDF format
- the Python interpreter (version 2.5.2)
- a subset of the Python standard library
- the GTK+ runtime environment (version 2.12.8)
- the PyGTK library (version 2.10.6)
Important
For legal reasons BEST is never included in the BESTGUI packages.
You have to download and install it separately.
Subversion Access¶
The source code of BESTGUI is available via (anonymous) subversion from the BESTGUI project page on SourceForge.
The project’s SourceForge.net Subversion repository can be checked out through SVN with the following instruction set:
$ svn co https://bestgui.svn.sourceforge.net/svnroot/bestgui
Note
This is a generic Subversion checkout command which will pull all modules, tags and/or branches of the project (including the sanbox).
In most cases, you will want to check out only trunk (main development line) using the following checkout instruction:
$ svn co https://bestgui.svn.sourceforge.net/svnroot/bestgui/bestgui/trunk bestgui
Information about accessing this Subversion repository may be found in SourceForge.net document titled Subversion (Version Control for Source Code).
Updates from within the module’s directory do not need the URL string.
Warning
UNIX file and directory names are case sensitive.
Important
In order to have BESTGUI fully working you have to build the HTML documentation by typing the following command in the BESTGUI doc directory:
$ make html
The HTML documentation should be re-built every time a file in the doc directory is updated.
How to install BESTGUI¶
But when else specified you need to have all software listed in the Requirements section correctly installed and working.
Install BESTGUI from sources¶
The python distutils are used to build and install BESTGUI, so it is fairly simple to get things ready to go. The distutils provide a wide set of flags for custom installations so please refer to the Installing Python Modules manual for details.
Here is the step by step setup procedure:
extract the source package contents. You can use both graphical tools commonly available on many systems (e.g. WinZipTM for WindowsTM or ark and File Roller for GNU/Linux) and command line tools. In the latter case, depending on the archive type you retrieved you can use one of the following commands from the shell prompt:
$ tar xvfz bestgui-1.x.tar.gz
for gzipped tarballs or:
$ unzip bestgui-1.x.zip
for zip files.
from the main BESTGUI distribution directory run this command as root (or Administrator on WindowsTM):
$ python setup.py install
This will install BESTGUI for all the users on your system. If you don’t have administrative privileges or you want a single user installation you can specify a custom installation path:
# python setup.py install --prefix=<prefix-dir>where <prefix-dir> have to be replaced with the actual prefix directory where you have write privileges.
Note: you can customize your installation using the setup flags described in the Installing Python Modules manual.
Install binary packages¶
Linux RPM packages¶
You can install the BESTGUI RPM package using your favorite package manager or from the command line typing the following command with root privileges:
$ rpm -Uvh bestgui-1.x-1.noarch.rpm
Linux DEBIAN packages¶
You can install the BESTGUI .deb package using your favorite package manager or from the command line typing the following command with root privileges:
$ dpkg -i bestgui_1.x-2_all.deb
Windows installer¶
To install BESTGUI check that all the Requirements are satisfied and then simply run the executable installer and follow the instructions of the wizard.
Windows standalone package¶
For the WindowsTM platform is also provided a standalone package including all you need to run BESTGUI but BEST (you have to download BEST from the ESA website and install it).
The package includes the Python interpreter with all the packages and libraries required to run BESTGUI, the GTK+ library, PyGTK and the Python win32 extensions.
See the Available packages formats section for details.
To install BESTGUI from the binary standalone package just run the installer and follow the wizard.
If you downloaded the standalone package in zip format you don’t have to install it. Unpack the archive and run the best-gui.exe executable in it.
Running BESTGUI without installation¶
You can also run BESTGUI without installing it. Simply extract the source package (as described in Install BESTGUI from sources step “1”) and run BESTGUI using the following command:
$ python bestgui-1.x/scripts/bestgui
for UNIX-like systems or:
cmd> pythonw bestgui-1.x\scripts\best-gui.pyw
for WindowsTM users.
Note
off course bestgui-1.x in the above commands should be replaced with the actual BESTGUI directory name e.g bestgui-1.0, bestgui-1.0.6 an so on.
