INSTALL.txt

Febrl-0.4.2 installation instructions
=====================================

Peter Christen, 14 December 2011


The basic Febrl-0.4.2 installation requires Python 2.6 or 2.7, with
additional modules and libraries needed for the graphical user interface
(GUI) and the support vector machine (SVM) classification method.

Python:
  http://www.python.org

For the GUI, PyGTK and Matplotlib are required:
  http://www.pygtk.org
  http://matplotlib.sourceforge.net

The SVM classifier is based on libsvm:
  http://www.csie.ntu.edu.tw/~cjlin/libsvm/

  Follow the installation instruction within the python directory once
  you have downloaded and unpacked libsvm.


Test of installed modules:
--------------------------

To test if the required libraries are installed in your Python
distribution, start Python and try the following:

>>> import matplotlib
>>> matplotlib.use('GTK')

>>> import pygtk
>>> pygtk.require("2.0")

>>> import gtk
>>> import gtk.glade

>>> import svm

None of these import commands should give you an error.


Febrl-0.4.2 installation:
-------------------------

Unpack the febrl-0.4.2.tar.gz or febrl-0.4.2.zip archive and a new
directory named 'febrl-0.4.2' will be created containing all the
necessary Febrl modules and additional files such as example data sets,
documentation, the Febrl data set generator and testing programs.

Go into the 'tests' sub-directory within 'febrl-0.4.2' and either run
all tests using the corresponding script provided:

#> ./allTests.sh

or run the tests individually, for examples:

#> python indexingTest.py
#> python datasetTest.py

Note (by Van Ly, FSF): Due to differences in the end of line convention
for Mac (CR or \r), for Linux (LF or \n) and for Windows (CRLF or \r\n),
allTests.sh currently has the Windows end of line convention which
misbehaves on Linux Fedora 9 (in VirtualBox on Windows). Thus, the test
script does not execute properly, the work around I used was to apply

#> cat allTests.sh |sed -e ',\r,,' > allTests_1.sh
#> chmod u+x allTests_1.sh ; ./allTests_1.sh


Starting Febrl-0.4.2
--------------------

The Febrl GUI can be started using:

#> ./guiFebrl.py

(you might have to set the execute permission for the file guiFebrl.py),
or using:

#> python guiFebrl.py

Traditional Febrl project modules (either implemented manually or
saved from within the GUI) can be run outside the GUI, for example:

#> python my-linkage-project.py


Problems and errors:
--------------------

Please note that this is the initial 'alpha' distribution of Febrl-0.4.2
which has only been tested to a limited extent on an Ubuntu Linux platform
(specifically Ubuntu with Python 2.6 and Python 2.7).

Please report any problems and bugs to: peter.christen@anu.edu.au


Febrl-0.4.2 mailing lists:
--------------------------

To receive updates and news on Febrl please subscribe to the
announcement mailing list at:

  https://sourceforge.net/projects/febrl/