CMS Simulation Package CMSIM

Users' Guide
and
Reference Manual

CMS detector simulation software group

Abstract:

The purpose of this simulation package is to offer a central facility for Monte-Carlo studies of the CMS detector with different configurations. It allows a non specialist to have a full GEANT simulation of the apparatus with a simple interface. Conversely it provides the specialist the full description of the subdetectors that are inside the one he is in charge. The package allows the user to run different phases of the detector simulation: generation (cmgen), particle tracking in the detector with hits recording (cmsim), pile-up, signal and noise simulation (cmraw), reconstruction (cmrec) and analysis (cmana).

This document is continuously updated and revised. It is available in the web via the cmsdoc/software pages. One can also get the ps copy of the document from /afs/cern.ch/cms/cmsim/manual/manual.ps

 
• Contents
• User's Guide
  • User's Guide
    • Introduction
      • General
      • Basic framework
    • Computing environment
      • CERN machines
      • Installation on other platforms
      • CMS unix environment
      • Code maintenance by CVS
      • CMS data base
      • Example job scripts
      • Event scanning
    • Naming conventions
      • Materials and tracking media naming conventions
      • volume naming convention
    • Program structure and data flow
      • General
      • Events kinematics generation - CMKIN
      • GEANT detector description - CMGEO
      • GEANT tracking and HITS generation - CMSIM
      • Events pile-up, noise and digitising - CMRAW
      • Trigger Simulation - CMTRG
      • Reconstruction - CMREC
      • Utilities
    • User control cards
      • General
      • Printing, histograming and drawing control cards
      • Events and structures i/o control cards
      • Program flow control cards
      • Other control cards
    • Histograming
    • User hooks
• Reference Manual
  • Steering code - CMSI
    • General
    • Initialisation - UGINIT
    • CMS geometry preparation
    • Simulation steering
    • Kinematics
      • Kinematics data structure
      • Vertex fluctuation
      • Reconstruction steering
    • Termination phase
  • Detector description code and constants
    • General
    • Magnetic field
    • Materials and media definitions
    • Rotation matrices
    • Detector geometry
      • Hierarchy of keywords and geometry tree
    • GEANT geometry by TZ titles
    • GEANT hits by TZ titles
    • GEANT drawing by TZ titles
    • Detectors and hit formats
      • Detector Sets and Detector elements
      • Hit format for the tracker and muon system
      • The digitisation format
      • User parameters for detector element
    • Particle descriptions
    • CMSIM Data Base
  • Event generation - KINE file
    • General
    • CMKIN flowchart
    • CMKIN sample jobs
  • Tracker simulation - TRAK file
    • General
      • File structure
      • Contact persons
    • Tracker control flags
      • Debug control
      • Tracker geometry control
      • HITS recording control
      • Digitization and hit reconstruction control
      • Event reconstruction control
    • Bank descriptions
      • HITS format
      • DIGI formats
      • RHIT format
      • TPAR - track parameters banks
      • TKVX - track fit parameters with vertex constraint
      • TVTX - vertex parameters bank
    • Tracker geometry and materials
    • stepping for tracker
    • Tracker signals digitization
      • Pixel digitization
      • Silicon digitization
      • MSGC digitization
    • Tracker hits reconstruction
      • Pixel hits reconstruction
    • Track finding
      • Kalman filtering track finder
      • Template track finder
    • Track fitting, TO BE UPDATED!!!!
    • Vertex finding
    • Vertex fitting
  • ECAL software
    • ECAL simulation software
      • File structure
      • Geometry
      • ECAL and Endcap Preshower HITS structure
      • ECAL DIGI structure
      • Access to the crystals and preshower strips.
      • Basic geometrical information and routines to build analysis software
    • ECAL analysis software
  • HCAL simulation
  • MUON simulation
    • MUON simulation
      • General
      • RPC Muon Trigger Software
      • CSC Simulation
      • DTBX Simulation
  • Very forward calorimeter simulation - VCAL
  • Utilities
    • The GEANT extensions
      • Vertex and Kinematic Information
      • Hits and Digitisation
      • Reconstructed Hits and Trigger Primitives
      • Input & Output
    • The General utilities
      • Accessing Set/Detector Information
      • Accessing Geometry Parameters
      • Iterating over Detector Elements
      • Information on pile-up events
      • Access to HEPEVT common block
      • Accessing Hits, Digitisations, etc. using key words
      • Coordinate Transformations
      • Relating reconstructed hits or digits to simulated hits
    • The CMDB file-based database system
      • The CMDB directory structure
      • The CMDB file structure
      • Overriding the CMDB default directory and file names
      • Adding files to the CMDB data structure
      • Multiple file specification
      • Transporting the CMDB data structure
  • User Zebra interface - SZPK file
    • General
    • Zebra Bank Access
      • ZEBRA Data structures
    • UNIX temporary space (not yet implemented for cms)
  • Level-1 Calorimeter Trigger software
    • General
      • File structure
      • How to switch on L-1 calo trigger
    • Flow chart to simulate L-1 calo trigger
    • L-1 calo trigger banks CTRI
      • Structure of banks
      • How to get access to the banks
    • Eta-phi indexes of the trigger objects
    • Control cards
• References
  • Appendices
    • Code Administration
      • Code and titles administrators
      • Code submission and update policy
    • List of Pure Materials
    • Examples of Material Mixtures
    • List of Standard Rotation Matrices
    • Geometry Title Examples
    • Bank Descriptions
• Index
• About this document ...