*********************************************************
*                       README                          *
*                                                       *
*      dataDisplay v8r13  (14 May 2003)                 *
*      D. Verkindt (verkindt@lapp.in2p3.fr)             *
*      D. Buskulic (buskulic@lapp.in2p3.fr)             *
*********************************************************


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

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

  - Uses Root instead of Hplot. This induces a lot of convenient users facilities
    like zooming, values pointing, saving of plot under various formats, etc...

  - Reads data under frame format (see /virgoApp/Fr documentation) from:
       - files (off-line)
       - files (online)
       - a Cm server (online)
       - the Data Distribution Server (online)

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

  - Dumps the last frame read, dump any selected channels of each frame read.

  - Saves the current configuration in a file (*.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 /virgoApp/Dy/vxx/OSF1, just type dataDisplay.
    You 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.


COMPILING:
---------

  - The following libraries are used:
        * - /virgoApp/Root (Root libraries)
        * - /virgoApp/Fr   (Frame library)
          - /virgoApp/Fd   (Frame Distribution library)
          - /virgoApp/Cfg 
          - /virgoApp/Cbf 
          - /virgoApp/Cm   (Cm library)
          - /virgoApp/CSet 
        * - /virgoApp/Xform (the GUI Xforms library)
          - /virgoApp/Db
          - /virgoApp/El
          - /virgoApp/Su

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


  - In the mgr directory, you will find makefiles used to compile dataDisplay
    on OSF1 v5 and Linux RedHat v7 platforms:
      - 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.OLD.linux.egcs: to compile under Linux RedHat v7,
                                 on a HPVectra PC, using the gcc compiler.
      - Makefile.OLD.linux.egcs_nocm: to compile under Linux RedHat v7 a "nocm" version.

  - The Xforms GUI is a free software, open source since 2001.
    Are available for now in Virgo the Xforms libraries for OSF1 or Linux
    systems. Xform Web page: http://world.std.com/~xforms


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

Some utilities are also available:
---------------------------------

  - FrCreate: to create on disk some frames containing sms, adc or proc data.
  - FrAudio:  to audio play one selected channel of data.
  - FrHisto:  to get a 1D, a Time and a Spectrum plot of one selected channel.

You compile them, from mgr directory, by using the command: makeUtil
