From HallBWiki

A wiki for documentation and discussion of software for CLAS12.

Contents 1 TDR 2 Communication 3 bCNU 3.1 Overview 3.2 Latest Announcements, News 4 ClaRA: CLAS Reconstruction and Analysis 4.1 Latest Announcements, News 5 gemc: Geant4 MonteCarlo 5.1 Overview 5.2 Latest Announcements, News 5.3 Getting started 5.4 Documentation 6 Reconstruction (SOCRAT) 6.1 Overview 6.2 Getting started 6.3 Documentation 7 Clas12 Detectors 8 Simulation 9 Infrastructure 10 Software Tools 10.1 HDDS 10.2 Version Control 10.3 Doxygen 10.4 EVIO 10.5 cMsg 11 Detectors 12 Hits 13 Action Items, Task List 14 Documentation 15 Related Links

TDR

• TDROutline
• Current version
• Previous TDR

Communication

• Agendas, minutes, notes and related documents of and for meetings on CLAS12 software.
• Email list information (clas12_software@jlab.org)

bCNU

Overview

bCNU (Be Seein' You) is the Java MDI (multi Document Interface) upon which the CLAS12 single event display will be built. However, bCNU is more general than just supporting the event display--it is roughly the equivalent of the Hv package used to support the current CLAS event display, ced, and will support non-MDI applications as well. Basically it is a class library that provides many utility packages that a Java GUI might find useful--e.g., logging, xml input and output, etc. It will change/grow rapidly at first, as packages co-opted from other graphical projects are added. Its initial implementation has been placed in the clas12 svn repository.

bCNU documentation

Latest Announcements, News

• 11/13/2007 Initial import of bCNU into the CLAS12 svn repository.

ClaRA: CLAS Reconstruction and Analysis

• Introduction
  
• Quick start guide
  
• Programmers guide
  
• Proposed CLARA Computer Specs
  
• TDR in progress
  

Latest Announcements, News

• 02/03/2008 GeometryService. Current status and communication protocols
• 02/02/2008 GeometryService Java and Cpp consumer examples.
• 02/02/2008 .clarasetup file.
• 01/23/2008 real task with the deadline
• 12/04/2007 hypothetical tracking
• 11/26/2007 EVIO event producer and EVIO event consumer services (C++).
• 11/26/2007 cMsg Message Rates courtesy of Carl Timmer.
• 11/19/2007 data producer and data consumer services. C examples use cMsg payload (ASCII).
• 11/12/2007 clara C++ geometry service consumer example
• 11/12/2007 clara geometry service prototype
• 03/31/2008 clara web services

gemc: Geant4 MonteCarlo

Overview

gemc (GEant4 MonteCarlo) is our software simulation built on Geant4.
It reads detector information from an external database, the Hit Processes Routines are built by a factory method at run time, and the output banks are dynamic. read more.

Latest Announcements, News

• 8/15/2008 Latest findings by Octavian, Sebastien and myself, and latest gemc updates: gemc updates
• 8/15/2008 hovanes study on eg1-dvcs using gemc
• 8/05/2008 Bug: toroidal field bug fixed.
• 4/25/2008 The latest news are now announced through the gemc mailing list. Here are the latest two issues: April 11-18 2008 gemc newsletter, April 11-25 2008 gemc newsletter
• 4/16/2008 gemc release 1023
• 4/09/2008 We have a mailing list dedicated to gemc: gemc_software@jlab.org. This mailing list provides news, tips, usage infos and troubleshooting. Do not hesitate to ask question, reports bugs, request features about gemc. To subscribe to the mailing list, send an e-mail to majordomo@jlab.org with the line: subscribe gemc_software@jlab.org .
• 4/08/2008 gemc release 943
• 4/02/2008 Presentation for the SVT review
• 3/30/2008 Moeller Absorber Geometry is in
• 3/20/2008 Forward TOF are in (latest numbers from designer - will need new numbers for improved geometry)
• 3/14/2008 Added various pre-packaged physics lists: LHEP, LHEP_BERT, LHEP_BERT_HP, QGSP, QGSP_BIC, QGSP_BIC_HP, QGSP_BERT, QGSP_BERT_HP
• 3/11/2008 Drift Chambers digitization: added wire number routine in hit process.
• 3/11/2008 Drift Chambers geometry implemented (Yelena Prok)
• more announcements
• gemc newsletter

Getting started

• For users (CUE machines): gemc has been compiled on the CUE machines. That means that if you want to run gemc there, you don't need to check out or compile anything, you can just run it: read more
• For developers: Prerequisite software is needed: geant4, mysql, clhep, scons, qt4.
  You can install gemc by checking out the code from the svn repository and typing scons in its directory. read more
• gemc provides an interface to add volumes to the detector and to create the corresponding bank. To learn how to do it, click here

Documentation

• gemc doxygen documentation
• gemc svn repository (php)
• browse gemc svn repository
• Detailed documentation to install gemc
• gemc mailing list -- instructions to subscribe to the gemc newsletter

Reconstruction (SOCRAT)

Overview

SOCRAT (SOftware for Clas12 Reconstruction And Tracking) is the package developed for the event reconstruction in Clas12.
Physics requirements can be found in this note (from Mac and Dan, February 2007). A more recent version can also be found in the TDR.

Getting started

Socrat is available on cvs and svn, so just type e.g. 'svn co Socrat' to get the code. A README file is provided in the main directory, with information on how to run it.

Documentation

The Clas note 2008-015 (June 2008) presents many details on Socrat, as well as its performance.
Further developments of the code were presented at TCB meetings:

• 08/15/2008
• 09/19/2008

and at the Clas collaboration meeeting 10/30/2008

Clas12 Detectors

• Clas12 Torus
• Clas12 Outer TOF
• Clas12 Inner TOF
• Clas12 SVT
• Clas12 Micromegas
• Clas12 Drift Chambers
• Clas12 Cerenkov

Simulation

• Official GEANT4 site
• Getting Started with Sim12
• Getting Started with Sim12 Offsite
• Plug-ins
• Sim12 XML Primer -- Information on the XML useed by Sim12
• Running Sim12 -- Information on using Sim12
• CLAS12 GEANT4 Home page - now obsolete.
• Using GEANT4 on the JLab CUE - gcc 4.1.1
• Getting GEANT4 for your machine
• Other simulation pages
• Sim 12 II Sim12 II home page
• Maurizio Presentation for Oct. 31 Software meeting.

Infrastructure

• Proposal for directory structure
• Maurik's list of software issues
• CLAS12 Coding Standards
• Notes on OpenGL visualization

Software Tools

The CLAS12 system relies on several externally developed and maintained packages to do its work:

• Scons

HDDS

HDDS is an XML-based detector geometry specification language.
See HDDS to get this code and build and install it.

Version Control

• The CLAS12 Subversion How To. (in progress)
• Johann's general computing notes on Subversion set-up and usage.
• Joe added all the existing HDDS software to the CLAS12 Subversion, you can browse the repository at: HDDS SVN Repository.
• Browse the Subversion repository
• Proposal on Subversion repository structure
• Notes on web access to Subversion repositories
• HDDS scheme
• Meeting with IT Division on Subversion Access

Doxygen

The Doxygen documentation for HDDS is automatically generated by a cron job and a script. Update time is every 15 minutes. New Hot Feature: the entire GEANT4 source code is now sucked into doxygen as well and fully cross referenced from our code. Too bad there aren't any more comments in the GEANT4 sources.
The output can be found:

• Sim12 Main Doxygen Documentation (links to HDDS and GEANT4)
• HDDS Main Doxygen Documentation (Links to GEANT4)
• GEANT4 Doxygen Documentation
• Doxygen Home page (downloads etc).

EVIO

• CLAS EVIO Status Page
• EVIO Users Guide v2.0

cMsg

• cMsg Users Guide

Detectors

• Magnetic Fields Mini HowTo
• Solenoid field and implementation
• Torus field
• Maps location: http://clasweb.jlab.org/12gev/field_maps/
• SVT geometry

Hits

• Brief Background on Hits
• Hit Scheme for Sim12
• Sim12 Hits EVIO Output

Action Items, Task List

• Action Items: A list of things we have to do now. Focus is on specific, small jobs. Should take less than a week.
• Task List: A list of important projects. Might take longer than a week. Might need some planning. Volunteers?

Documentation

• Technical Design Report Section

Related Links

• Hall B page
• CLAS Offline page
• Old CLAS at 12 GeV reconstruction page
• GlueXWiki, software section