Hall A C++ Analyzer Installation Guide

General

The C++ Analyzer is intended to be a general-purpose programming framework similar to ROOT. As with ROOT, it should ideally not be necessary to compile the Analyzer yourself. A precompiled version should be available to you, either already installed or ready for download. Any experiment-specific extensions of the Analyzer that do need to be compiled would be placed in a separate shared library built against the preinstalled Analyzer.

Unfortunately, precompiled versions are problematic because of the large number of possible combinations of ROOT versions and compilers, which are often not compatible at the binary level. Currently, we provide a preinstalled version of the Analyzer for the Hall A counting house analysis computers (adaql3-5, adaqs2-3). More information can be found in a separate document. We do not offer binaries for download at this time, but we are planning to do so in the near future.

If you wish to build the Analyzer yourself for local use, please download the latest source distribution and follow the instructions below.

System Requirements

Linux or Solaris. Other Unices (e.g. IRIX, AIX, Alpha/OSF/Tru64) will probably work too.
ROOT 3.02 or higher.
Decent hardware (recommended 500MHz Pentium 3, 256MB RAM).
50 MB disk space to build the Analyzer. GBs of disk space for raw data files.

Prerequisites

The following software must be installed and set up prior to unpacking and compiling the analyzer:

ROOT 3.02 or higher (3.04/02 recommended).
gcc/g++ C/C++ compiler 2.95/2.96, 3.0 or higher. Important: this MUST be the EXACT SAME compiler version used to compile ROOT! Different recent versions of g++ produce incompatible C++ object code.
On Solaris, the Sun Workshop Compiler 6 (C++ 5.3) or similar.
GNU make 3.76 or later.
GNU gzip/gunzip.

Getting the analyzer source code

Source distributions can be downloaded from here. Unpack the archive as follows:

  % tar xzf analyzer-1.1.tar.gz
OR
  % gunzip -c analyzer-1.1.tar.gz | tar xf -

The sources will be unpacked into the subdirectory "analyzer-1.1". Go there

  % cd analyzer-1.1

Compilation

First, ensure that ROOT is properly set up. Inspect the value of the environment variable ROOTSYS. It must point to the version of ROOT you intend to use. See if you can start ROOT by typing

  % root

$ROOTSYS/bin must be in your PATH.

Currently, there is no "configure" script that automatically detects and configures system-dependent parameters such as compiler, path to applications, etc. Thus, changing the platform must be done by hand. Fortunately this is rather easy. The default configuration is for Linux. So, on Linux you can simply type

  % make

On Solaris, edit the top-level Makefile and change the value of "ARCH" from "linuxegcs" to "solarisCC5". Then type

  % gmake

On other Unices, you will have to provide an appropriate "ARCH" section in each of the three Makefiles:

  ./Makefile
  hana_decode/Makefile
  hana_scaler/Makefile

Building on ifarml1/2/3

Download the source tarball, unpack, set up ROOT and gcc, and compile:

   % tar xzvf analyzer-1.1.tar.gz 
   % cd analyzer-1.1
   % use root/3.05-07
   % use gcc/3.2.3
   % make -j4
   ( ... go drink a coffee ... )

   Quick test of the build:

   % setenv LD_LIBRARY_PATH `pwd`:${LD_LIBRARY_PATH}
   % ./analyzer

Recovering from a corrupted build

If you build fails because something wasn't set up right, restarting the build may fail with weird error messages. In such a case, try

  % find . -name '*.d' -exec rm {} \;
  % make realclean
  % make

Only if this fails you are likely to have a real problem with the source code.

Installation

To run the analyzer in an arbitrary directory, a number of environment variables need to be set up. Assuming you built the Analyzer in ~/analyzer-1.1, the setup would be as follows:

For bash (Linux default):

  % export LD_LIBRARY_PATH=~/analyzer-1.1:$ROOTSYS/lib
  % export DB_DIR=~/analyzer-1.1/DB
  % export PATH=~/analyzer-1.1:$PATH

For tcsh (JLab Computer Center default):

  % setenv LD_LIBRARY_PATH ~/analyzer-1.1:${ROOTSYS}/lib
  % setenv DB_DIR ~/analyzer-1.1/DB
  % set path = ( ~/analyzer-1.1 $path )

Instead of adding the build directory to PATH, you could link ~/analyzer-1.1/analyzer to your working directory.

You probably want to put these definitions in your login script: ~/.bash_profile or ~/.login.

Running

Go to your working directory and type:

  % analyzer

or, if you did not modify the PATH:

  % ./analyzer

You should see the startup message:

  ************************************************
  *                                              *
  *            W E L C O M E  to  the            *
  *       H A L L A   C++  A N A L Y Z E R       *
  *                                              *
  *        Release   1.1             Nov 17 2003 *
  *  Based on ROOT  3.05/07          Sep 30 2003 *
  *                                              *
  *            For information visit             *
  *        http://hallaweb.jlab.org/root/        *
  *                                              *
  ************************************************

CINT/ROOT C/C++ Interpreter version 5.15.94, June 30 2003
Type ? for help. Commands must be C++ statements.
Enclose multiple statements between { }.
analyzer [0]

Since the Analyzer is built on top of ROOT, you now have access to all ROOT commands from the Analyzer command prompt. Running the Analyzer is like running ROOT with a bunch of extra classes available. The special Analyzer classes are listed in the Analyzer Class Index.

If you are a new user, you might want to look at the example scripts in the examples/ subdirectory of the distribution. Documentation of them can be found in the Quickstart Guide.

Ole Hansen <ole@jlab.org>

Last modified: Mon Nov 17 12:31:36 EST 2003