| Geant4 Cross Reference |
>> 1 $Id: README,v 1.16 2010-11-29 10:34:36 gcosmo Exp $
1 ---------------------------------------------- 2 -------------------------------------------------------------------
2 3
3 ========================================= 4 =========================================================
4 Geant4 - an Object-Oriented Toolkit for S 5 Geant4 - an Object-Oriented Toolkit for Simulation in HEP
5 ========================================= 6 =========================================================
6 7
7 Examples module 8 Examples module
8 --------------- 9 ---------------
9 10
10 This module collects three sets of user exampl << 11 This module collects four sets of user examples aimed to demonstrate to
11 the user how to make correct use of the GEANT4 12 the user how to make correct use of the GEANT4 toolkit by implementing
12 in a correct way those user-classes which the 13 in a correct way those user-classes which the user is supposed to
13 customize in order to define his/her own simul 14 customize in order to define his/her own simulation setup.
14 15
15 The "basic" set of examples is oriented to nov << 16 The "novice" set of examples is oriented to novice users and covering all
16 the most typical use-cases of a Geant4 applica << 17 possible general use-cases typical of an "application"-oriented kind of
17 and ease of use. << 18 development. As several examples in this "novice" set became too complicated,
18 << 19 a new "basic" set, covering the most typical use-cases of a Geant4 application
19 An "extended" set of examples may require some << 20 with keeping simplicity and ease of use, is provided and is going to replace
20 of Geant4. This set covers many specific use c << 21 the "novice" set in future.
21 simulation. << 22
22 << 23 An "extended" set of examples require some additional
23 An "advanced" set of examples covers the use-c << 24 libraries besides of Geant4. This set covers some specific use cases
24 "toolkit"-oriented kind of development, where << 25 for actual detector simulation. An "advanced" set of examples covers
25 for different simulation studies are provided; << 26 the use-cases typical of a "toolkit"-oriented kind of development,
26 party products to be built. << 27 where real complete applications for different simulation studies are
>> 28 provided; may require additional third party products to be built.
27 29
28 Most of the examples can be run both in intera 30 Most of the examples can be run both in interactive and batch mode, and
29 input macro files (*.in) and reference output 31 input macro files (*.in) and reference output files (*.out) are provided.
30 See the detailed instructions how to build and 32 See the detailed instructions how to build and how to run an example
31 in README.HowToRun and README.HowToRunTestEm1. << 33 in README.HowToRun and README.HowToRunTestEm1.
32 an example in multi-threading mode can be foun <<
33 34
34 Basic and most of the extended examples are co << 35 Basic, novice and most of the extended examples are considered part of the
35 system testing suite for validation of the off 36 system testing suite for validation of the official releases of the
36 GEANT4 toolkit. Basic and some of the extended << 37 GEANT4 toolkit. Basic, novice and some of the extended and advanced
37 examples are also used as "acceptance"-tests f 38 examples are also used as "acceptance"-tests for the release process.
38 39
39 The previous set of examples oriented to novic << 40 Basic examples
40 has been refactored in "basic" and "extended" << 41 ExampleB1
41 The source code of the last version of the ori << 42 - Simple geometry with a few solids
42 (in 9.6.p02 release) can be viewed in the Gean << 43 - Scoring total dose in a selected volume user action classes
43 http://www-geant4.kek.jp/lxr/source/examples << 44
44 << 45 ExampleB2
45 And more on what is common for all examples: << 46 - Simplified tracker geometry with global constant magnetic field
46 - README.HowToRun << 47 - Scoring within tracker via G4 sensitive detector and hits
47 - README.HowToRunMT << 48 - Started from novice/N02 example
48 << 49
49 Web: https://geant4-userdoc.web.cern.ch/Doxyge << 50 ExampleB3
>> 51 - Schematic Positron Emitted Tomography system
>> 52 - Radioactive source
>> 53 - Scoring within Crystals via G4 scorers
>> 54
>> 55 ExampleB4
>> 56 - Simplified calorimeter with layers of two materials
>> 57 - Scoring within layers in four ways: via user actions (a), via user own
>> 58 object (b), via G4 sensitive detector and hits (c) and via scorers (d)
>> 59
>> 60 Novice level examples
>> 61 ExampleN01
>> 62 - Mandatory user classes
>> 63 - Demonstrates how Geant4 kernel works
>> 64 ExampleN02
>> 65 - Simplified tracker geometry with uniform magnetic field
>> 66 - Electromagnetic processes
>> 67 ExampleN03
>> 68 - Simplified calorimeter geometry
>> 69 - Electromagnetic processes
>> 70 - Various materials
>> 71 ExampleN04
>> 72 - Simplified collider detector with a readout geometry
>> 73 - Full "ordinary" processes
>> 74 - PYTHIA primary events
>> 75 - Event filtering by stack
>> 76 ExampleN05
>> 77 - Simplified BaBar calorimeter
>> 78 - EM shower parametrisation
>> 79 ExampleN06
>> 80 - Optical photon processes
>> 81 ExampleN07
>> 82 - Regions and parameterised materials
>> 83
>> 84 Extended level examples
>> 85 analysis
>> 86 - Histogramming through the AIDA interface
>> 87 biasing
>> 88 - Examples of event biasing, scoring and reverse-MC
>> 89 common
>> 90 - A set of common classes which can be reused in other examples demonstrating
>> 91 just a particular feature
>> 92 electromagnetic
>> 93 - Specific EM physics simulation with histogramming
>> 94 errorpropagation
>> 95 - Use of the error propagation utility (Geant4e)
>> 96 eventgenerator
>> 97 - Applications using interface to HepMC
>> 98 exoticphysics
>> 99 - Exotic simulation applications (classical magnetic monopole, etc...)
>> 100 field
>> 101 - Specific simulation setups in magnetic field
>> 102 g3tog3
>> 103 - Examples of usage of the g3tog4 converter tool
>> 104 geometry
>> 105 - Specific geometry examples and tools: OLAP tool for detection
>> 106 of overlapping geometries
>> 107 hadronic
>> 108 - Specific hadronic physics simulation with histogramming
>> 109 medical
>> 110 - Specific examples for medical physics applications
>> 111 optical
>> 112 - Examples of generic optical processes simulation setups
>> 113 parallel
>> 114 - Examples of event-level parallelism in Geant4 using the
>> 115 TOP-C distribution, and MPI technique
>> 116 parameterisations
>> 117 - Examples for fast shower parameterisations according to specific models
>> 118 persistency
>> 119 - Persistency of geometry (GDML or ASCII) and simulation output
>> 120 radioactivedecay
>> 121 - Examples to simulate the decays of radioactive isotopes and
>> 122 induced radioactivity resulted from nuclear interactions
>> 123 runAndEvent
>> 124 - Examples to demonstrate how to connect the information between
>> 125 primary particles and hits and utilize user-information classes
>> 126 visualization
>> 127 - Specific visualization features and graphical customisations
>> 128
>> 129 Advanced level examples
>> 130 air_shower
>> 131 - Simulation of the ULTRA detector for UV and charged particles
>> 132 detection in cosmic rays
>> 133 amsEcal
>> 134 - Simplified AMS Ecal calorimeter structure
>> 135 brachytherapy
>> 136 - Setup for brachytherapy Ir-192 HDR source
>> 137 ChargeExchangeMC
>> 138 - Charge Exchange Monte Carlo
>> 139 composite_calorimeter
>> 140 - Test-beam simulation used in CMS against real data taken
>> 141 in 1996 in a CMS Hadron calorimeter test-beam at LHC
>> 142 eRosita
>> 143 - Simplified eROSITA X-ray telescope setup for instrumental background
>> 144 simulations for fluorescence measurements.
>> 145 gammaray_telescope
>> 146 - Simulation of a typical telescope for gamma ray analysis
>> 147 hadrontherapy
>> 148 - Simulation of a hadron therapy beam line
>> 149 human_phantom
>> 150 - Anthropomorphic phantoms (male and female) based on MIRD/ORNL model
>> 151 with geometry description derived from GDML persistent files
>> 152 lAr_calorimeter
>> 153 - Simulation of the Liquid Argon Calorimeter of the ATLAS
>> 154 Detector at LHC
>> 155 medical_linac
>> 156 - Simulation of energy deposit in a Phantom filled with water
>> 157 for a typical linac used for intensity modulated radiation therapy
>> 158 microbeam
>> 159 - Simulation of the cellular irradiation beam line installed on the AIFIRA
>> 160 electrostatic accelerator facility located at CENBG, France
>> 161 microdosimetry
>> 162 - Simulation of DNA physics processes with track of a 10 keV Helium+
>> 163 (positive charge is +e) particle in liquid water.
>> 164 nanobeam
>> 165 - Simulation of the beam optics of the nanobeam line installed on the AIFIRA
>> 166 electrostatic accelerator facility located at CENBG, France.
>> 167 purging_magnet
>> 168 - Simulation of electrons traveling through a 3D magnetic field of a
>> 169 strong purging magnet used for treatment head in a medical environment
>> 170 radioprotection
>> 171 - Application for the evaluation of dose in astronauts, vehicle concepts
>> 172 and Moon surface habitat configurations, in a space radiation environment
>> 173 Rich
>> 174 - Rich Test Beam Simulation
>> 175 underground_physics
>> 176 - Setup of an underground dark matter experiment
>> 177 xray_fluorescence
>> 178 - Test beam to characterize the response function of an
>> 179 HPGe detector used to measure fluorescence emissions
>> 180 xray_telescope
>> 181 - Realistic simulation of an X-ray Telescope
50 182