Package:  d0tools


Installation instructions
-------------------------

In general, this package requires the D0RunII software environment,
and python.  SAM is also required for some functionality.

The following environmental variables must be defined:

D0TOOLS_DIR  -  Path to the head of this package.
D0TOOLS_BIN  -  Path to the bin area of this package.
D0TOOLS_DOC  -  Path to the doc area of this package.

d0tools/bin should be added to the user's PATH.
d0tools/python should be added to the user's PYTHONPATH.


Local user installation
-----------------------

A user may make a local copy of this package in their personal area, 
and then configure their account accordingly:

1) Choose an area for installation of the package.  For example, $HOME.
2) % cd $HOME
3) % cvs checkout d0tools
4) You will need the following somewhere in your .login

    setup python
    setup sam

    setenv D0TOOLS_DIR $HOME/d0tools
    setenv D0TOOLS_BIN $HOME/d0tools/bin
    setenv D0TOOLS_DOC $HOME/d0tools/doc

    set path=($path $HOME/d0tools/bin)
    setenv PYTHONPATH ${PYTHONPATH}:$HOME/d0tools/python

5) To get the latest version,

    % cd $HOME/d0tools
    % cvs update


Directories
-----------

d0tools/bin     -  Scripts
d0tools/doc     -  Documentation
d0tools/python  -  Python utilities


Files
-----

bin/rund0exe     -  Run any D0 framework executable
bin/runreco      -  Run D0RECO (uses rund0exe)
bin/initreco.sh  -  Setup D0RECO run time environment
bin/cpustats     -  Analyze a framework .out file, returning CPU statistics
bin/memstats     -  Analyze a framework .log file, returning memory usage statistics

python/scriptutil.py  -  Utility to write python scripts