*********************************************************
*                       README                          *
*                                                       *
*      dataDisplay v9r12p7  (30 Jun 2009)               *
*      D. Verkindt (verkindt@lapp.in2p3.fr)             *
*      D. Buskulic (buskulic@lapp.in2p3.fr)             *
*********************************************************


FUNCTIONALITIES:
===============

This version of the VIRGO Data Display:
---------------------------------------

  - Uses Root (root.cern.ch). This implies several users facilities
    like zooming, values pointing, saving of plot under various formats, etc...

  - Reads data under frame format (see /virgoApp/Fr documentation):
       - from frames files or from ffl (off-line or online)
       - from shared memory (online or off-line)
       - from a Cm server through Ethernet (online)

  - Displays and edits the following plots type:
    1D distribution, 2D distribution, time, spectrum, time-frequency, time-1d, 
    transfert function, coherence function, correlation function.

  - Dumps the last frame read or any selected channel of each frame read.

  - Saves the current configuration in a file (dd.car file)
    that can also be read by the Virgo simulation package Siesta.

  - Loads its configuration from a *.car file.


HOW TO USE IT:
-------------

  - Once in executable directory (OSF1 or Linux-i686, etc...),
    just type "dataDisplay.exe" and you will
    get the main panel. You can also put arguments: first one is the
    name of the configuration file you use, second is the number of frames
    you want to read, third is the debug level. For instance,
    "dataDisplay - - 3" means that you do not take any configuration initially,
    you do not set the number of frames to read and you set denug level to 3.

  - You can then, using "Config Menu", load a configuration file (*.car file).
    or, using the "Input Menu", select a data source (Cm Server, Files Online or Offline).

  - In the main panel, the white bottom line lets you know the
    last action you made or the current status of the data display.
    After selecting a data source, you should
    get there the message "Frame read successfully".

  - The "Data and Plots" panel allows to select channels and
    to create plots by pushing the button corresponding to the
    type of plot you want (1D, 2D, TIME, ...).
    For 2D histogram, you select first the 2 channels for X and Y,
    then push the "2D" button. Or select one channel for X, push
    the "2D" button and select then the channel for Y. the
    same remark applies to "TrFct", "Cohe" and "Corr" plots.
    Otherwise, the button "Exchange" allows to exchange variables in
    the plots "2D","TrFct", "Cohe" or "Corr" already created.
    Plots can be superposed by using the "Same" button.

 - From the "Data and Plots" panel you can select the item "OperationString"
   from the "UserFct" menu and do operations on the signals before doing plots.

- More informations are available from the full documention in the directory "doc".


COMPILING:
---------

  - The following libraries are used:
        * - /virgoApp/root (Root libraries)
        * - /virgoApp/Fr   (Frame library)
          - /virgoApp/Cm   (Cm library)
          - /virgoApp/CSet 
        * - /virgoApp/Xform (the GUI Xforms library)

    The "*" indicates the mandatory libraries needed to produce a minimal version
    of the dataDisplay able to read only data offline.

  - In the cmt directory, you will find a requirements file to be used with the
    compiling tool CMT. Once you have installed the CMT package, just go into the
    cmt directory and type: cmt config ; make
    To compile under Cygwin, you need to uncomment some lines in the requirements
    and to comment others (see instructions in the requirements file).

  - In the mgr directory, you will find makefiles used to compile dataDisplay
    under OSF1 v5 and Linux RedHat7, RedHat9 or Linux SL4 and SL5 latforms:

      - Make-requirements: contains the maximal list of packages version (except the Root version)
                           needed to compile this version of dataDisplay.
      - Make-macros: the makefile code "independent" of the platform used.
      - Makefile.VIRGO.osf1.cxx6: the main makefile that includes the previous one.
                                  Used to compile under OSF1 v5, with cc compiler.
      - Makefile.VIRGO.osf1.cxx6_nocm: Same as previous one but uses only Frame Library,
                                       Root library and Xform library.
                                       Produces a dataDisplay executable able to get
                                       data only from files ("nocm" version).
      - Makefile.sun_nocm: to compile under SunOS a "nocm" version.
      - Makefile.LAPP.linux.egcs: to compile under Linux RedHat 7 and 9, or SL4 using the gcc compiler.
      - Makefile.LAPP.linux.egcs_nocm: to compile under Linux RedHat or SL4 a "nocm" version.
      - makeUtil: a script to compile any additional tool (like sound2frame.c) provided in the Dy package.

  - The Xforms GUI is a free software, open source since 2001.
    Are available now in Virgo the Xforms libraries for OSF1 v5, Linux RedHat7,9 or Linux SL4, SL5 operating systems.
    Xform Web page: 
    http://savannah.nongnu.org/projects/xforms and http://savannah.nongnu.org/download/xforms

-------------------------------------------------------------------------