Read Me

SciEx, version 0.0.0+

=====================================================================

SciEx is intended to provide code to represent a scientific experiment in
a computer program.

Quick install

Unpack the SciEx package into a directory (_install_directory_) of your choice.
This will create a directory tree starting with 
_install_directory_/SciEx-0.0.0+.

Please refer to the restricted installation page (see below) or
- after a complete or an only-doc installation - to the online-documentation
generated with "make doc" and "make doc-install" during installation on your
computer at
_install_directory_/share/SciEx-0.0.0+/documentation/html/index.html.

BEFORE having completed a full installation, a restricted page with more
detailed
installation instructions is located in your source tree. Point your browser to
file:///<path>/documentation/html/sciexInstallation.html
where <path> is the full path to your Experiment source. If, for example,
you unpacked the source in directory /home/user/software, <path> will be
/home/user/software/SciEx-0.0.0+.
If you downloaded a svn development version, follow the instructions in 
README_FIRST to generate the necessary configuration files.

Have Boost (version 1.34.1), Loki (versions up to 0.1.7), BSUtilities
(version 0.6.2+), Quantities (version 1.2.2+), and SciDatVis (version 0.0.0+)
installed. If you want to install the graphical user
interface library for Experiment, have Qt4 installed on your system.

In the root directory, do the following:
./configure with options:
             --prefix=_install_directory_ if necessary, to give the
             path to the installation directory for Quantities, default
             is /usr/local,
             add --with-loki=_loki_directory_, to specify the path to the
             loki installation - this directory should contain subdirectories
             include/loki and, in subdirectory lib a file named libloki.so
             default is /usr,
             add --with-boost=_boost_directory_, to specify the path to the
             boost installation, where a subdirectory include/boost or
             include/boost-<version>/boost exists with a file version.hpp,
             and at least libboost_filesystem<tag>.so is present in
             subdirectory lib
             add --with-BSUtilities=_BSUtilities_install_directory_, to specify
             the path to the BSUtilities installation
             add --with-BSUtilities_version=<versionnumber>, with
             <versionnumber> being the version number of BSUtilities
             (e.g. 0.6.2+)
             add --with-BSUtilities_libtag=<libtag>, with <libtag> being `-o',
             '-d' or '-o-d', depending on which features of the BSUtilities
             libraries you want to use. Note, that you must have installed
             add --with-Quantities=_Quantities_install_directory_, to specify
             the path to the Quantities installation
             add --with-Quantities_version=<versionnumber>, with
             <versionnumber> being the version number of Quantities
             (e.g. 1.2.2+)
             add --with-Quantities_libtag=<libtag>, with <libtag> being `-o',
             '-d' or '-o-d', depending on which features of the Quantities
             libraries you want to use. Note, that you must have installed
             the respective Quantities libraries if you use this option,
             add --with-SciDatVis=_SciDatVis_install_directory_, to specify
             the path to the SciDatVis installation
             add --with-SciDatVis_version=<versionnumber>, with
             <versionnumber> being the version number of SciDatVis
             (e.g. 1.2.2+)
             add --with-SciDatVis_libtag=<libtag>, with <libtag> being `-o',
             '-d' or '-o-d', depending on which features of the SciDatVis
             libraries you want to use. Note, that you must have installed
             the respective SciDatVis libraries if you use this option,
             add --enable-gui=no (default) or do not specify this option if
             you do NOT want the graphical user interface to be installed,
             add --with-gui=Qt if you want to get the Qt4 implementation of
             the graphical user interface installed,
             add --enable-onlydoc if you want to generate only the documentation
             (with make doc;make doc-install) without having all prerequisites
             ready).

make
make install
make doc
make doc-install
make check

To clean up the generated files, use
make clean
make doc-clean
make uninstall
make doc-uninstall


Author and contact

Bernd Speiser, Institut fuer Organische Chemie, Universitaet Tuebingen,
Auf der Morgenstelle 18, D-72076 Tuebingen, Germany
e-mail: berndspeiser@users.sourceforge.net

=====================================================================