Gleam User Guide:  jobOptions

Gleam is an application that uses the Gaudi Framework.  All Gaudi applications use a jobOptions file to set up a job.  The jobOptions file is an ASCII file that provides all of the input parameters necessary to run an application.  By default, Gleam will use the jobOptions file defined in Gleam/src/jobOptions.txt.  For detailed information about jobOptions files, please see the GLAST Gaudi tutorial:
http://www-glast.slac.stanford.edu/software/gaudi/gaudi_v9/tutorial/joboptions.htm

What JobOptions are available?

Many packages used by Gleam contain algorithms, services or other Gaudi components that set their parameters through jobOptions.  We keep an up-to-date listing of all such parameters available here:
http://www.slac.stanford.edu/exp/glast/ground/software/package_documentation/GleamJobOptions.htm

Default Gleam JobOptions

If you look in the Gleam/v_ir_j/src directory, you will find a number of text files.  We have tried to separate the parameters for various activities into separate jobOptions files.  The four primary files are:
jobOptions.txt - the main jobOptions file that is used by Gleam by default.
default.txt
basicOptions.txt
guiOptions.txt - sets up the EventDisplay

The test_Gleam jobOptions file is maintained as the "gold standard" for batch operation of Gleam. Look at it in the Gleam/v_ir_j/src/test/ directory, and be sure to notice the included files to see the whole shebang.

There is a sample jobOptions file for reading back existing Root trees and firing up the event display. It is in the RootIo/v_ir_j/src/ directory as readRootOptions.txt.

It is possible to include other jobOptions files within a given jobOptions file.  For example, if you open the jobOptions file, you may see a line like:
#include "$GLEAMROOT/src/guiOptions.txt"
This includes all of the jobOptions parameters contained in the guiOptions.txt file, which sets up the parameters necessary for the GUI.
You can modify the behavior of Gleam just by commenting out included jobOptions files.  For example, if you do not wish to run Gleam with the GUI, comment out the guiOption.txt line:
// #include "$GLEAMROOT/src/guiOptions.txt"

User-defined jobOptions files

You may supply your own jobOptions file by defining an environment variable called JOBOPTIONS.  This environment variable should point to your new jobOptions file.  You can do this in a number of ways.    

• Windows

  • Running within VCMT

    • Pass the name of your jobOptions file in as an input parameter in the app parameters text box in VCMT

    OR

    • Modify the Gleam requirements file
      set JOBOPTIONS "${GLEAMROOT}/src/jobOptions.txt"

    • For this change to take effect - you must perform a new "setup" on the Gleam package.

  • Create a batch file for starting Gleam
    For example:
    REM call Gleam's setup.bat to set the environment variables
    C:\GLAST\packages\Gleam_v3r0\Gleam\v3r0\cmt\setup.bat
    REM specify which jobOptions file to use
    set JOBOPTIONS=C:\GLAST\packages\Gleam_v3r0\Gleam\v3r0\src\jobOption.txt
    REM start Gleam, /low reduces the priority 
    start /low /b C:\GLAST\packaages\Gleam_v3r0\Gleam\v3r0\Win32Debug\Gleam.exe

• Linux

  • Pass your jobOptions file in as an the first input parameter to Gleam:
    glastpack.pl run Gleam v2r2p11 Gleam.exe myPath/jobOptions.txt

H. Kelly Last Modified:  2004-02-18 15:37:30 -0800