Babar logo
HEPIC E,S & H Databases PDG HEP preprints
Organization Detector Computing Physics Documentation
Personnel Glossary Sitemap Search Hypernews
Workbook Home Introduction Account Setup QuickTour Packages Modules Unwrap page!
Event Information Tcl Commands Editing Compile and Link Run the Job Debugging
Check this page with the
W3C Validator
(More checks...)
Parameters Tcl Files Find Data Batch Analysis ROOT Tutorial

How to use the Workbook

The Workbook is divided into two sections: the Workbook Core, and Other Workbook Pages. The Workbook Core is the "mandatory" section, and Other Workbook Pages is the "optional" section.

The Workbook Core

All users should work through the Workbook Core. The Workbook Core is made up of different sections. Many of the later sections assume that you have completed the earlier sections, so it is important to complete the sections in order.

Some of the Workbook Core sections include tutorials/examples, while others are mostly read-only documents. The examples will teach you how to use BaBar software, and can be very useful as a guide later on when you are ready to perform your own analysis. The read-only sections are also very useful, because they will help you to understand what you were doing in the tutorials.

Once you have completed the Workbook Core, you will have mastered the fundamentals of working with BaBar software and running analysis code.

Other Workbook Pages

The "Other Workbook Pages" are pages that do not belong in the Workbook Core. Unlike the pages of the Core, they are not interdependent - you can choose to read/try any or none of them, and you do not have to complete them in any particular order.

The Other Workbook Pages have been futher divided into four different categories:

Workbook Contents

Here is a list of the contents of the BaBar Workbook, with a brief description of each section.

The descriptions may help you to decide what pages in the "Other" section you want to use.

Workbook Core

The following sections should be completed in order.
  1. Introduction
    How to use the Workbook.
  2. Account Setup
    How to set up your SLAC Account.
  3. QuickTour
    A quick tutorial in which you perform all the basic steps of a BaBar analysis. This section is the core of the Workbook; most other pages refer back to it as the main example.
  4. Packages and releases
    Packages and releases: what they are, how they are named, and how they are organized in BaBar's file system. How to use SRT/CVS commands to check out releases and packages.
  5. Modules and the Framework
    Introduction to modules. How modules are put together to make an analysis job.
  6. Event Information
    How to access the event information, and what information is available. Includes tables of the main particle candidate lists and event variables in the Event Store database.
  7. Tcl: Run-time job control
    How to interact with the Framework and talk to modules.
  8. Editing module code
    How to write code in modules. Using the main C++ objects: HepHistogram, HepTuple, BtaCandidate, and HepAList.
  9. Compile and Link
    All about gmake, BaBar's compile-and-link utility.
  10. Run the job
    How to run BaBar executables. Program flow. The workdir package.
  11. Debugging
    Using the debuggers to track run-time errors.
  12. Run-time parameters
    How to make module parameters into run-time parameters.
  13. Tcl files
    Basic Tcl commands. How Tcl files work. Tcl files in the context of packages.
  14. Find Data
    Using BbkDatasetTcl to find data, and to produce tcl files that can be used as input to an analysis job.
  15. Batch Processing
    How to use the batch system. Batch commands. The batch queues and what they are for. Computing CPU time for batch system log files.
  16. Analysis Tools
    An overview of important analysis tools, including PID, vertexing and fitting, particle composition, and more.
  17. ROOT I
    An introduction to ROOT. Focus is on histograms. Soon will be updated to include a section on TTrees.

Other Workbook pages

You may refer to these pages if and when you need to.

Back to Workbook Front Page

Send comments to Workbook Team.