source: trunk/examples/README @ 1303

$Id: README,v 1.15 2009/11/20 16:22:14 gcosmo Exp $
-------------------------------------------------------------------

     =========================================================
     Geant4 - an Object-Oriented Toolkit for Simulation in HEP
     =========================================================

                         Examples module
                         ---------------

This module collects three sets of user examples aimed to demonstrate to
the user how to make correct use of the GEANT4 toolkit by implementing
in a correct way those user-classes which the user is supposed to
customize in order to define his/her own simulation setup.
One set of examples is oriented to "novice" users and covering all
possible general use-cases typical of an "application"-oriented kind of
development. An "extended" set of examples require some additional
libraries besides of Geant4. This set covers some specific use cases
for actual detector simulation. An "advanced" set of examples covers
the use-cases typical of a "toolkit"-oriented kind of development,
where real complete applications for different simulation studies are
provided; may require additional third party products to be built.
Most of the examples can be run both in interactive and batch mode, and 
input macro files (*.in) and reference output files (*.out) are provided.
Novice and most of the extended examples are considered part of the
system testing suite for validation of the official releases of the
GEANT4 toolkit. Novice examples and some of the extended and advanced
examples are also used as "acceptance"-tests for the release process.

Novice level examples
 ExampleN01
   - Mandatory user classes
   - Demonstrates how Geant4 kernel works
 ExampleN02
   - Simplified tracker geometry with uniform magnetic field
   - Electromagnetic processes
 ExampleN03
   - Simplified calorimeter geometry
   - Electromagnetic processes
   - Various materials
 ExampleN04
   - Simplified collider detector with a readout geometry
   - Full "ordinary" processes
   - PYTHIA primary events
   - Event filtering by stack
 ExampleN05
   - Simplified BaBar calorimeter
   - EM shower parametrisation
 ExampleN06
   - Optical photon processes
 ExampleN07
   - Regions and parameterised materials

Extended level examples
 analysis
   - Histogramming through the AIDA interface
 biasing
   - Examples of event biasing, scoring and reverse-MC
 electromagnetic
   - Specific EM physics simulation with histogramming
 errorpropagation
   - Use of the error propagation utility (Geant4e)
 eventgenerator
   - Applications using interface to HepMC
 exoticphysics
   - Exotic simulation applications (classical magnetic monopole, etc...)
 field
   - Specific simulation setups in magnetic field
 g3tog3
   - Examples of usage of the g3tog4 converter tool
 geometry
   - Specific geometry examples and tools: OLAP tool for detection
     of overlapping geometries
 hadronic
   - Specific hadronic physics simulation with histogramming
 medical
   - Specific examples for medical physics applications
 optical
   - Examples of generic optical processes simulation setups
 parallel
   - Examples of event-level parallelism in Geant4 using the
     TOP-C distribution, and distributed runs through DIANE
 parameterisations
   - Examples for fast shower parameterisations according to specific models
 persistency
   - Persistency of geometry (GDML or ASCII) and simulation output
 radioactivedecay
   - Examples to simulate the decays of radioactive isotopes and
     induced radioactivity resulted from nuclear interactions
 runAndEvent
   - Examples to demonstrate how to connect the information between
     primary particles and hits and utilize user-information classes
 visualization
   - Specific visualization features and graphical customisations

Advanced level examples
 air_shower
   - Simulation of the ULTRA detector for UV and charged particles
     detection in cosmic rays
 brachytherapy
   - Setup for brachytherapy Ir-192 HDR source
 composite_calorimeter
   - Test-beam simulation used in CMS against real data taken
     in 1996 in a CMS Hadron calorimeter test-beam at LHC
 gammaray_telescope
   - Simulation of a typical telescope for gamma ray analysis
 hadrontherapy
   - Simulation of a hadron therapy beam line
 human_phantom
   - Anthropomorphic phantoms (male and female) based on MIRD/ORNL model
     with geometry description derived from GDML persistent files
 lAr_calorimeter
   - Simulation of the Liquid Argon Calorimeter of the ATLAS
     Detector at LHC
 medical_linac
   - Simulation of energy deposit in a Phantom filled with water
     for a typical linac used for intensity modulated radiation therapy
 microbeam
   - Simulation of the cellular irradiation beam line installed on the AIFIRA
     electrostatic accelerator facility located at CENBG, France
 microdosimetry
   - Simulation of DNA physics processes with track of a 10 keV Helium+
     (positive charge is +e) particle in liquid water.
 nanobeam
   - Simulation of the beam optics of the nanobeam line installed on the AIFIRA
     electrostatic accelerator facility located at CENBG, France.
 purging_magnet
   - Simulation of electrons traveling through a 3D magnetic field of a
     strong purging magnet used for treatment head in a medical environment
 radioprotection
   - Application for the evaluation of dose in astronauts, vehicle concepts
     and Moon surface habitat configurations, in a space radiation environment
 Rich
   - Rich Test Beam Simulation
 underground_physics
   - Setup of an underground dark matter experiment
 xray_fluorescence
   - Test beam to characterize the response function of an
     HPGe detector used to measure fluorescence emissions
 xray_telescope
   - Realistic simulation of an X-ray Telescope