ORGANISATION OF ATLFAST PACKAGE The Organisation of the Atlfast Package has evolved greatly over its development. A number of major changes have occured recently. Below is a description of all the Sub-Packages of some recent releases and the functions of these sub-packages. Release 3.1.0 (Atlfast-01-00-18) Release 3.0.1 (Atlfast-01-00-17) RELEASE 3.1.0 (Atlfast-01-00-18) Doxygen Documentation Atlfast consists of the following packages (the first three were formerly combined as AtlfastCode): AtlfastAlgs AtlfastEvent AtlfastUtils AtlfastAnalysis AtlfastExamples TestAtlfast As of release 3.1.0 the AtlfastAlg package needs to be included in the DLL list in the jobOptions file instead of AtlfastCode. The other two packages are installed libraries and don't need to be accessed via the job options file.: ApplicationMgr.DLLs += { "AtlfastAlgs"}; All the jobOptions files are now in the AtlfastAlg/share directory. The names of all the required files start with the keyword Atlfast. Thus there are now the following files: AtlfastOptions.txt (previously jobOptions.txt) AtlfastStandardOptions.txt (previously StandardAtlfastOptions.txt) AtlfastDoNotTouch.txt All these should be copied into the TestRelease/run directory when the TestRelease package is built. AtlfastAlgs Package This package contains all the core Atlfast code. It has all the Algorithms needed to run atlfast and all the code required solely by the algorithms and which shouldn't be needed by other packages. The contents of this package means that it shouldn't need to be checked out or referenced by any users. If any users find themselves including any headers from AtlfastAlgs could they please contact the Atlfast team as the header should probably be moved to another package. The AtlfastAlgs package contains the following algorithms. Atlfast::AtlfastB Atlfast::AtlfastProtoJetMaker Atlfast::CellMaker Atlfast::ClusterMaker Atlfast::DefaultReconstructedParticleMaker Atlfast::EventHeaderMaker Atlfast::FinalStateParticleDumper Atlfast::GlobalEventDataMaker Atlfast::HepMCEventWriter Atlfast::IKinematicDumper Atlfast::Isolator Atlfast::JetMaker Atlfast::Monitor Atlfast::ReconstructedParticleDumper Atlfast::ReconstructedParticleHistogramMaker Atlfast::SimpleDiff Atlfast::SimpleTest Atlfast::StandardHistogramMaker Atlfast::StandardNtupleMaker Atlfast::TestTrackViewer Atlfast::TrackMaker Atlfast::TrackMaker2 Atlfast::TrackNtupleMaker AtlfastEvent Package AtlfastEvent contains all the code for the "data objects" Atlfast outputs into the TES. This is the package you will need to reference if you wish to use any of the Atlfast output entities in your own anlysis package. AtlfastEvent contains the following ContainedObjects: Atlfast::Cell Atlfast::Cluster Atlfast::Jet Atlfast::ReconstructedParticle Atlfast::SimpleTestStatistic Atlfast::Track In addition AtlfastEvent also has the Atlfast Output Objects kinematical interface class Atlfast::IKinematic, which could be useful to users. AtlfastUtils Package AtlfastUtils contains utility classes used by the various atlfast algorithms but which have little or no dependence themselves on other Atlfast objects. They were designed so that they would be useful and easily incorporated into the packages of other users. It is highly recomended that anyone writing their own analysis package should look into AtlfastUtils to see if there is anything they could use before they start writing their own code. Some of the highlights are: Atlfast::TesIO: Designed for retrieving and storing all types of Objects to and from the Transient Event Store via StoreGate. Atlfast::HeaderPrinter: Designed for printing out information about your objects so you can check they were initialised properly Atlfast::ChargeService: Service providing the electromagnetic charge of HepMC::GenParticle and Atlfast::ReconstructedParticle HepMC_helper: This contains various operator classes designed for selecting certain HepMC::GenParticle with various cuts set. It is particullary useful when used in conjuction with Atlfast::TesIO. AtlfastExamples AtlfastExamples is a very simple package containg just two Algorithms. These are designed to be examples on how to write your own algorithms. Atlfast::AnalysisSkeleton Atlfast::AtlfastExample1 TestAtlfast TestAtlfast is a package designed to test all the workings of Atlfast during it's development. It should only be of interest to developers of the code and not the users. It contains a number of classes and algorithms designed to do unit testing on the Atlfast objects. It is still in its early stage of development. It also contains a number of python programs designed to perform regression testing on Atlfast. This compares average numbers as well as Histograms for all the Atlfast output entities from reference files from previous releases. To do this it has to invoke Atlfast::SimpleTest from the AtlfastAlgs package. RELEASE 3.0.1 (Atlfast-01-00-17) Atlfast Package This Package contains the following sub-packages: AtlfastCode AtlfastExamples TestExamples To get the Atlfast Package: cmt co -r Atlfast-01-00-17 Simulation/Atlfast With this you will get the following directory structure: Simulation/Atlfast/Atlfast-01-00-17/ The Atlfast-01-00-17 directory contains the following directories Atlfast AtlfastCompF cmt share src test All these are of no real interest to the user and most are empty relics of Past Atlfast incarnations. The only one that is of real interest in the cmt directory. This contains the requirements document which links in the correct version of AtlfastCode into the Atlfast package. AtlfastCode Package This package contains all the source code and files needed to run Atlfast. AtlfastCode can be got in two ways. If you have already checked out the Atlfast package then you can do the following: cmt co -requirements Simulation/Atlfast/Atlfast-01-00-017/cmt/requirements Or the AtlfastCode can be checked out directly: cmt co -r AtlfastCode-01-03-02 Simulation/Atlfast/AtlfastCode Both these methods give the same directory structure: Simulation/Atlfast/AtlfastCode/AtlfastCode-01-03-02/ The AtlfastCode-01-03-02 directory contains the following directories AtlfastCode cmt doc share src test AtlfastCode: contains all the header files for Atlfast. cmt: contains the requirements file for AtlfastCode. doc: contains documentation on the design of Atlfast and the user requirements files. share: contains all the files needed to run atlfast. These are copied into the run directory when AtlfastCode is built. src: contains all the source code for Atlfast. test: contains files for testing AtlfastCode. Not required by the user. in addition to these directories, the AtlfastCode-01-03-02 directory contains the ChangeLog which describes the evolution of AtlfastCode. AtlfastExamples Package This Package contains a couple of files showing examples of how to write Analysis Algorithms in Atlfast. Its structure is similar to AtlfastCode and it can be obtained as follows: cmt co -r AtlfastExamples-00-00-03 Simulation/Atlfast/AtlfastExamples TestAtlfast Package This Package was written by the AtlfastCode developers and is used to test Atlfast. It should not be of any use the the users of Atlfast. cmt co -r TestAtlfast-00-00-03 Simulation/Atlfast/TestAtlfast