CLARA Tutorial

Reconstruction with CLARA

To run clara, you first have to install it. The installation process will automatically download coatjava (you can specify the version number). For complete documentation see https://claraweb.jlab.org.

CLARA Installation

To install clara, run the following commands (with tcsh shell):

wget --no-check-certificate https://claraweb.jlab.org/clara/_downloads/install-claracre-clas.sh
chmod +x install-claracre-clas.sh
setenv CLARA_HOME $PWD/myClara/
./install-claracre-clas.sh -v 4a.5.5

where "myClara" is the name of the directory where you want clara installed (note that it does not exist yet - it will be created automatically during installation) and "4a.5.5" is the coatjava tag that you want to use.

Starting and Running CLARA

To start CLARA, simply do:

$CLARA_HOME/bin/clara-shell

This should open the clara CLI and look something like this:

   ██████╗██╗      █████╗ ██████╗  █████╗ 
  ██╔════╝██║     ██╔══██╗██╔══██╗██╔══██╗ 4.3.0
  ██║     ██║     ███████║██████╔╝███████║
  ██║     ██║     ██╔══██║██╔══██╗██╔══██║
  ╚██████╗███████╗██║  ██║██║  ██║██║  ██║
   ╚═════╝╚══════╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝


 Run 'help' to show available commands.

clara>

You can type "help" to get a list of possible commands and descriptions and then "help " (e.g. "help run") to get more information about a specific command. "show config" is a particularly useful command, it will show you all of your current settings:

clara> show config
servicesFile:        "/Users/harrison/tutorials/myClara/plugins/clas12/config/services.yaml"
fileList:            "/Users/harrison/tutorials/myClara/plugins/clas12/config/files.list"
inputDir:            "/Users/harrison/tutorials/myClara/data/input"
outputDir:           "/Users/harrison/tutorials/myClara/data/output"
threads:             NO VALUE
reportEvents:        NO VALUE
skipEvents:          NO VALUE
maxEvents:           NO VALUE
logDir:              "/Users/harrison/tutorials/myClara/log"
feHost:              NO VALUE
fePort:              NO VALUE
session:             "harrison"
description:         "clara"
useFE:               true
javaMemory:          NO VALUE
javaOptions:         NO VALUE
farm.cpu:            72
farm.memory:         70
farm.disk:           3
farm.time:           1440
farm.os:             "centos7"
farm.stage:          NO VALUE
farm.track:          "debug"
farm.system:         "jlab"

To change any of these settings, use "set " (e.g. "set threads 2" will run the reconstruction with two threads). CLARA comes with a small test file which will run using the default settings; to start reconstructing it, simply do:

run local

Note that the test file is located in inputDir, it's filename is given in the fileList file, and the reconstructed output file will be in outputDir.