Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/examples/README

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /examples/README (Version 11.3.0) and /examples/README (Version 10.6.p1)


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