README

###################################################
#
#  RAIDA
#
#  [ Root (http://root.cern.ch)    implementation of
#    AIDA (http://aida.freehep.org)  ]  
#  
#  
###################################################

 
Introduction:
-------------

RAIDA is a ROOT implementation of AIDA (Abstract Interfaces for Data Analysis).
The motivation for the development of RAIDA was to offer the 
possibility to create and fill n-tuple or histograms using standard ROOT 
objects with AIDA. All ROOT objects created with AIDA are stored in a 
ROOT file. Since our main application of RAIDA is to create ROOT output to
be analysed using the ROOT program, the current version can not read in 
the root files created. Furthermore only objects, which exist within ROOT 
can be created. 

This version of RAIDA supports the following AIDA objects:

ITREE (create output-file, create and change directories)  
IHistogram1D, IHistogram2D, IHistogram3D (1D, 2D, and 3D binned histograms) 
ICloud1D, ICloud2D, ICloud3D (1D, 2D, and 3D unbinned histograms)
IProfile1D, IProfile2D (1D and 2D profile histogram)
IAxis (get information about axis of IHistogram, ICloud, and IProfile)
ITuple (creating and filling of n-tuples with different data types:
        int, short, long, float, double)

Additional Information:
----------------------

The AIDA histograms hold more information about the data than those from ROOT. 
RAIDA can write out these additional information by including additional 
histograms in the output file. By default the additional histograms are 
omitted. To tell RAIDA to write out these histograms, the environment variable 
"AIDA_HISTOGRAMS_IN_ROOT" has to be set to "1":

export AIDA_HISTOGRAMS_IN_ROOT=1

Debug Information:
-----------------

To supporting the usage of a debugger like GDB (DDD), the object file has to
have some additional information. By default these information is not 
written to the object file. This can be changed by setting an environment
variable:

export RAIDADEBUG=1

Verbose Mode:
------------

To get additional information written to the screen during the operation of
RAIDA, set the following environment variable:

export RAIDA_DEBUG_VERBOSE=1


Installation (with cmake):
-------------------------

    In order to build RAIDA you need ILCUTIL, ROOT and CMake

    if you have access to /afs/desy.de/ then you will find all this packages under:

        /afs/desy.de/project/ilcsoft/sw/i386_gcc34_sl4/   # SL4 32bit
        /afs/desy.de/project/ilcsoft/sw/i386_gcc41_sl5/   # SL5 32bit
        /afs/desy.de/project/ilcsoft/sw/x86_64_gcc41_sl5/ # SL5 64bit


    if you do NOT have acces to /afs/desy.de/ or you do not have an SL4/SL5 machine the easiest
        way is to use ilcinstall (http://ilcsoft.desy.de/portal/software_packages/ilcinstall/).
        Please use an ilcinstall version >= v01-11. More information under:
        http://ilcsoft.desy.de/portal/general_documentation/ilcinstall_documentation/


    Once the dependencies are resolved, issue the following commands:

    mkdir build
    cd build
    cmake -C $ILCSOFT/ILCSoft.cmake ..
    make install

    For more information on CMake for the ILCSoftware check:
    http://ilcsoft.desy.de/portal/general_documentation/index_eng.html

    CMake's official website:
    http://www.cmake.org


Installation (with cmake) standalone (no ilcinstall, no afs):
-------------------------

    In order to build RAIDA you need ILCUTIL, ROOT and CMake

    # 1. install ROOT >= 5.0
    # please visit http://root.cern.ch for ROOT install instructions.

    # 2. install ILCUTIL
    svn co https://svnsrv.desy.de/public/ilctools/ilcutil/tags/v01-00 ilcutil-v01-00

    mkdir ilcutil-v01-00/build
    cd ilcutil-v01-00/build
    cmake ..
    make install
    cd ../../

    # install RAIDA
    svn co https://svnsrv.desy.de/public/ilctools/RAIDA/tags/v01-06-02 raida-v01-06-02

    mkdir raida-v01-06-02/build
    cd raida-v01-06-02/build
    cmake -DILCUTIL_DIR=/tmp/ilcutil-v01-00 -DROOT_DIR=/path/to/ROOT ..
    make install


Linking against RAIDA:
---------------------

In order to build your program with RAIDA you need to use the proper 
include files and libraries, e.g. in your Makefile add:
 
  CPPFLAGS += `aida-config --include`
  LIBS += `aida-config --lib`

  LIBS += `root-config --libs`

( the first two lines should work for any AIDA installation)


and before calling 'make' set the proper environment, e.g.:

 export ROOTSYS=/opt/products/root/5.08.00

 export LD_LIBRARY_PATH=$ROOTSYS/lib:$LD_LIBRARY_PATH
 export PATH=$ROOTSYS/bin:$PATH

 export RAIDA_HOME=/afs/desy.de/user/g/gaede/ilcsoft/RAIDA/v00-00

 . $RAIDA_HOME/bin/aida-setup.sh