| Geant4 Cross Reference |
>> 1 $Id: README 77949 2013-11-29 21:19:29Z ihrivnac $
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 "basic" set of examples is oriented to novice users and covering
16 the most typical use-cases of a Geant4 applica 17 the most typical use-cases of a Geant4 application with keeping simplicity
17 and ease of use. 18 and ease of use.
18 19
19 An "extended" set of examples may require some 20 An "extended" set of examples may require some additional libraries besides
20 of Geant4. This set covers many specific use c 21 of Geant4. This set covers many specific use cases for actual detector
21 simulation. 22 simulation.
22 23
23 An "advanced" set of examples covers the use-c 24 An "advanced" set of examples covers the use-cases typical of a
24 "toolkit"-oriented kind of development, where 25 "toolkit"-oriented kind of development, where real complete applications
25 for different simulation studies are provided; 26 for different simulation studies are provided; may require additional third
26 party products to be built. 27 party products to be built.
27 28
28 Most of the examples can be run both in intera 29 Most of the examples can be run both in interactive and batch mode, and
29 input macro files (*.in) and reference output 30 input macro files (*.in) and reference output files (*.out) are provided.
30 See the detailed instructions how to build and 31 See the detailed instructions how to build and how to run an example
31 in README.HowToRun and README.HowToRunTestEm1. 32 in README.HowToRun and README.HowToRunTestEm1. Several tips how to run
32 an example in multi-threading mode can be foun 33 an example in multi-threading mode can be found in README.HowToRunMT.
33 34
34 Basic and most of the extended examples are co 35 Basic 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 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 The previous set of examples oriented to novice users, "novice",
40 has been refactored in "basic" and "extended" 41 has been refactored in "basic" and "extended" examples sets in Geant4 10.0.
41 The source code of the last version of the ori 42 The source code of the last version of the original novice examples set
42 (in 9.6.p02 release) can be viewed in the Gean 43 (in 9.6.p02 release) can be viewed in the Geant4 LXR code browser:
43 http://www-geant4.kek.jp/lxr/source/examples 44 http://www-geant4.kek.jp/lxr/source/examples/novice/?v=9.6.p2
44 << 45 Old novice examples are now mapped as follows in the 10.0 release:
45 And more on what is common for all examples: << 46 - N01 - removed
46 - README.HowToRun << 47 - N02 - basic/B2
47 - README.HowToRunMT << 48 - N03 - basic/B4
48 << 49 - N04 - extended/runAndEvent/RE05
49 Web: https://geant4-userdoc.web.cern.ch/Doxyge << 50 - N05 - extended/parameterisations/Par01
>> 51 - N06 - extended/optical/OpNovice
>> 52 - N07 - extended/runAndEvent/RE06
>> 53
>> 54 Basic examples
>> 55 ExampleB1
>> 56 - Simple geometry with a few solids
>> 57 - Scoring total dose in a selected volume user action classes
>> 58
>> 59 ExampleB2
>> 60 - Simplified tracker geometry with global constant magnetic field
>> 61 - Scoring within tracker via G4 sensitive detector and hits
>> 62 - Started from novice/N02 example
>> 63
>> 64 ExampleB3
>> 65 - Schematic Positron Emitted Tomography system
>> 66 - Radioactive source
>> 67 - Scoring within Crystals via G4 scorers
>> 68
>> 69 ExampleB4
>> 70 - Simplified calorimeter with layers of two materials
>> 71 - Scoring within layers in four ways: via user actions (a), via user own
>> 72 object (b), via G4 sensitive detector and hits (c) and via scorers (d)
>> 73 - Started from novice/N03 example
>> 74
>> 75 Extended level examples
>> 76 analysis
>> 77 - Histogramming through the AIDA interface
>> 78 biasing
>> 79 - Examples of event biasing, scoring and reverse-MC
>> 80 common
>> 81 - A set of common classes which can be reused in other examples demonstrating
>> 82 just a particular feature
>> 83 electromagnetic
>> 84 - Specific EM physics simulation with histogramming
>> 85 errorpropagation
>> 86 - Use of the error propagation utility (Geant4e)
>> 87 eventgenerator
>> 88 - Applications using interface to HepMC
>> 89 exoticphysics
>> 90 - Exotic simulation applications (classical magnetic monopole, etc...)
>> 91 field
>> 92 - Specific simulation setups in magnetic field
>> 93 g3tog3
>> 94 - Examples of usage of the g3tog4 converter tool
>> 95 geometry
>> 96 - Specific geometry examples and tools: OLAP tool for detection
>> 97 of overlapping geometries
>> 98 hadronic
>> 99 - Specific hadronic physics simulation with histogramming
>> 100 medical
>> 101 - Specific examples for medical physics applications
>> 102 optical
>> 103 - Examples of generic optical processes simulation setups
>> 104 parallel
>> 105 - Examples of event-level parallelism in Geant4 using either the
>> 106 TOP-C library, Intel-TBB library or MPI technique
>> 107 parameterisations
>> 108 - Examples for fast shower parameterisations according to specific models
>> 109 persistency
>> 110 - Persistency of geometry (GDML or ASCII) and simulation output
>> 111 polarisation
>> 112 - Use of physics processes including polarization
>> 113 radioactivedecay
>> 114 - Examples to simulate the decays of radioactive isotopes and
>> 115 induced radioactivity resulted from nuclear interactions
>> 116 runAndEvent
>> 117 - Examples to demonstrate how to connect the information between
>> 118 primary particles and hits and utilize user-information classes
>> 119 visualization
>> 120 - Specific visualization features and graphical customisations
>> 121
>> 122 Advanced level examples
>> 123 air_shower
>> 124 - Simulation of the ULTRA detector for UV and charged particles
>> 125 detection in cosmic rays
>> 126 amsEcal
>> 127 - Simplified AMS Ecal calorimeter structure
>> 128 brachytherapy
>> 129 - Setup for brachytherapy Ir-192 HDR source
>> 130 ChargeExchangeMC
>> 131 - Charge Exchange Monte Carlo
>> 132 composite_calorimeter
>> 133 - Test-beam simulation used in CMS against real data taken
>> 134 in 1996 in a CMS Hadron calorimeter test-beam at LHC
>> 135 dnageometry
>> 136 - Setup of a realistic nucleus model of a cell, including chromosomes,
>> 137 in combination with Geant4-DNA physics
>> 138 dnaphysics
>> 139 - Simulation of track structures in liquid water using the Geant4-DNA
>> 140 physics processes and models
>> 141 eRosita
>> 142 - Simplified eROSITA X-ray telescope setup for instrumental background
>> 143 simulations for fluorescence measurements.
>> 144 gammaknife
>> 145 - Application specifically developed to simulate an advanced device for
>> 146 Stereotactic Radiosurgery; reproduces a Leksell Gamma-Knife unit model C
>> 147 gammaray_telescope
>> 148 - Simulation of a typical telescope for gamma ray analysis
>> 149 hadrontherapy
>> 150 - Simulation of a hadron therapy beam line
>> 151 human_phantom
>> 152 - Anthropomorphic phantoms (male and female) based on MIRD/ORNL model
>> 153 with geometry description derived from GDML persistent files
>> 154 iort_therapy
>> 155 - Application specifically developed to address typical needs related to
>> 156 the Intra-Operative Radio-Therapy (IORT) technique
>> 157 lAr_calorimeter
>> 158 - Simulation of the Liquid Argon Calorimeter of the ATLAS
>> 159 Detector at LHC
>> 160 medical_linac
>> 161 - Simulation of energy deposit in a Phantom filled with water
>> 162 for a typical linac used for intensity modulated radiation therapy
>> 163 microbeam
>> 164 - Simulation of the cellular irradiation beam line installed on the AIFIRA
>> 165 electrostatic accelerator facility located at CENBG, France
>> 166 microdosimetry
>> 167 - Simulation of DNA physics processes with track of a 10 keV Helium+
>> 168 (positive charge is +e) particle in liquid water.
>> 169 nanobeam
>> 170 - Simulation of the beam optics of the nanobeam line installed on the AIFIRA
>> 171 electrostatic accelerator facility located at CENBG, France.
>> 172 purging_magnet
>> 173 - Simulation of electrons traveling through a 3D magnetic field of a
>> 174 strong purging magnet used for treatment head in a medical environment
>> 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