USER GUIDE
Welcome to the Athena-Atlfast user guide.
All users should now have started using CMT. SRT is now no longer used in Athena-Atlfast development. For the latest tag of Atlfast and the vesrion of CMT it uses please see Tags.
Users unfamiliar with CMT should familiarise themselves with the basics by looking at the CMT primer. Further instructions on using CMT in the context of atlfast are given in getting started with CMT.
Atlfast is designed to be used in two ways:
Firstly, Atlfast comes with some Standard Analysis Algorithms which can be used to produce ntuples containg information about all the Atlfast Output entities. These algorithms can be used to produce either HBOOK or Root files and no real knowledge of C++ is required to produce them. A description of how to configure your athena-atlfast job to produce the Atlfast ntuples is given.
Secondly, Atlfast can be used as part of your own Athena analysis package. You can use Atlfast output entities in your Athena algorithms to perform your own analysis and produce your own histograms and ntuples etc. A dedicated analysis package called AtlfastAnalysis has been written that uses the Atlfast output to perform analysis. This is designed to be checked out by the user and modified in their own way. There is also a tutorial on starting to write your own analysis package to help users get started with athena and Atlfast. A description of the structure of the Atlfast Package is given to help the user understand and use Atlfast properly in there own analysis jobs
At no stage should the user need to checkout the Atlfast package directly. If they are interested in the syntax of the code, this can be seen on the CVS web. If for some reason the user really wants to get hold of the Atlfast source code etc. Instructions on checking out and building the code are given here
A Summary of all the links is given below:
Getting Started with CMT: Description of using CMT in the context of Atlfast.
Configuring Atlfast: This describes the basics on how to setup an Athena-Atlfast job.
Standard Atlfast Analysis Algorithms: This describes the NtupleMaking Algorithms that are part of Athena-Atlfast.
Atlfast Physics: This gives an extended description of each Atlfast Algorithms functionality and use and its configuration options.
AtlfastAnalysis package: This describes the extensive Analysis package that has been developed to run with Athena-Atlfast.
Writing your own Analysis Package: This explains how to write your own Athena Analysis Algorithms and develop your own package.
Atlfast Package Organisation: This describes the structure and organisation of the AtlfastPackage.
Checking out and building the Code: This describes how to get the Atlfast source code and compile it yourself.
Atlfast & Python: This describes how to run Athena-Atlfast interactively using Python.
Getting Started with CMT (4.4.0)
(Note: You should always check the CMT page for the latest cmt release information.)
NEW User Guide has been updated for CMT-4.4.0
Release CMT-4.4.0 uses CMT version 12. This should be platform independant. I have run it on redhat6.1 and redhat7.1. However, to build your own code you will require gcc-2.95.2 compiler. To just run Athena-Atlfast this does not matter. Below is how to run athena-atlfast. Information on using CMT-2.2.0 is still available
All commands given here assume you are using zsh or another type of born shell. However, the instructions are exactly the same for c-shells such as tcsh, except you should replace all the setup.sh with setup.csh.
Stage One:
Firstly you will need a requirements file in your $HOME directory. The version linked from here is for cmt 4.4.0. This must be edited so that the YourTests is set to the directory in which you are going to run Atlfast
macro TestArea "$HOME/YourTests"
This requirements file assumes you are running with a CERN machine style setup. I have used this alternative requirements file to run on my laptop with redhat 7.1. It allows you to define your own compiler path rather than the CERN standard.
Now you need to set up CMT. You will only need to do this once unless you change your $HOME/requirements document. All you need is to type the following.
source /afs/cern.ch/sw/contrib/CMT/v1r12p20020606/mgr/setup.sh
cmt config
Now you have to "Login" to CMT. This has to be done every time you login to the computer.
source setup.sh
You are now ready to rock!
Stage Two:
You can now checkout code from CVS using cmt. This will require access to the Atlas CVS repositry, so if you get an error such of cvs permission denied, you may not have permission and will need to request this.
To run Atlfast you will only need to checkout the TestRelease package.
cd $HOME/YourTests
cmt co TestRelease
This will give you a directory called TestRelease. This contains a second directory called TestRelease--xx-xx-xx where --xx--xx--xx is the TestRelease tag.
Change directory to the cmt directory in the TestRelease/TestRelease--xx-xx-xx directory. Here is where the specific requirements for you job can be setup.
cd TestRelease/TestRelease-xx-xx-xx/cmt
This directory contains another requirements file. This needs to be edited. To run Atlfast you will need to uncomment the following lines.
use Control Control-*
use Event Event-*
use Generators Generators-*
use Simulation Simulation-*
you will now need to configure the cmt to the requirements you have chosen and set the run-time environment
cmt broadcast cmt config
source setup.sh
You now need to install the TestRelase code.
cmt broadcast gmake
Stage Three:
You are now almost ready to run Athena-Atlfast. TestRelase will have built you a run directory in the same directory as the cmt directory. All the files need to run Atlfast should also have been copied into the run directory by cmt. So to run Athena-Atlfast you just need to change to the run directory and issue the athena run command
cd ../run
athena AtlfastOptions.txt
Ta-da, you have just run Athena-Atlfast. The output should be a ntuple called atlfast.ntup. Now you will need to know how to configure Atlfast to your specific needs. This is explained in Configuring Atlfast.
|