Gabriele Cosmo
182 lines
7.3 KiB
Plaintext
182 lines
7.3 KiB
Plaintext
$Id: README 85751 2014-11-05 09:43:53Z gcosmo $
|
|
-------------------------------------------------------------------
|
|
|
|
=========================================================
|
|
Geant4 - an Object-Oriented Toolkit for Simulation in HEP
|
|
=========================================================
|
|
|
|
Examples module
|
|
---------------
|
|
|
|
This module collects four 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.
|
|
|
|
The "basic" set of examples is oriented to novice users and covering
|
|
the most typical use-cases of a Geant4 application with keeping simplicity
|
|
and ease of use.
|
|
|
|
An "extended" set of examples may require some additional libraries besides
|
|
of Geant4. This set covers many 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.
|
|
See the detailed instructions how to build and how to run an example
|
|
in README.HowToRun and README.HowToRunTestEm1. Several tips how to run
|
|
an example in multi-threading mode can be found in README.HowToRunMT.
|
|
|
|
Basic and most of the extended examples are considered part of the
|
|
system testing suite for validation of the official releases of the
|
|
GEANT4 toolkit. Basic and some of the extended and advanced
|
|
examples are also used as "acceptance"-tests for the release process.
|
|
|
|
The previous set of examples oriented to novice users, "novice",
|
|
has been refactored in "basic" and "extended" examples sets in Geant4 10.0.
|
|
The source code of the last version of the original novice examples set
|
|
(in 9.6.p02 release) can be viewed in the Geant4 LXR code browser:
|
|
http://www-geant4.kek.jp/lxr/source/examples/novice/?v=9.6.p2
|
|
Old novice examples are now mapped as follows in the 10.0 release:
|
|
- N01 - removed
|
|
- N02 - basic/B2
|
|
- N03 - basic/B4
|
|
- N04 - extended/runAndEvent/RE05
|
|
- N05 - extended/parameterisations/Par01
|
|
- N06 - extended/optical/OpNovice
|
|
- N07 - extended/runAndEvent/RE06
|
|
|
|
Basic examples
|
|
ExampleB1
|
|
- Simple geometry with a few solids
|
|
- Scoring total dose in a selected volume user action classes
|
|
|
|
ExampleB2
|
|
- Simplified tracker geometry with global constant magnetic field
|
|
- Scoring within tracker via G4 sensitive detector and hits
|
|
- Started from novice/N02 example
|
|
|
|
ExampleB3
|
|
- Schematic Positron Emitted Tomography system
|
|
- Radioactive source
|
|
- Scoring within Crystals via G4 scorers
|
|
|
|
ExampleB4
|
|
- Simplified calorimeter with layers of two materials
|
|
- Scoring within layers in four ways: via user actions (a), via user own
|
|
object (b), via G4 sensitive detector and hits (c) and via scorers (d)
|
|
- Started from novice/N03 example
|
|
|
|
Extended level examples
|
|
analysis
|
|
- Histogramming through the AIDA interface
|
|
biasing
|
|
- Examples of event biasing, scoring and reverse-MC
|
|
common
|
|
- A set of common classes which can be reused in other examples demonstrating
|
|
just a particular feature
|
|
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 either the
|
|
TOP-C library, Intel-TBB library or MPI technique
|
|
parameterisations
|
|
- Examples for fast shower parameterisations according to specific models
|
|
persistency
|
|
- Persistency of geometry (GDML or ASCII) and simulation output
|
|
polarisation
|
|
- Use of physics processes including polarization
|
|
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
|
|
amsEcal
|
|
- Simplified AMS Ecal calorimeter structure
|
|
brachytherapy
|
|
- Setup for brachytherapy Ir-192 HDR source
|
|
ChargeExchangeMC
|
|
- Charge Exchange Monte Carlo
|
|
composite_calorimeter
|
|
- Test-beam simulation used in CMS against real data taken
|
|
in 1996 in a CMS Hadron calorimeter test-beam at LHC
|
|
dnageometry
|
|
- Setup of a realistic nucleus model of a cell, including chromosomes,
|
|
in combination with Geant4-DNA physics
|
|
eRosita
|
|
- Simplified eROSITA X-ray telescope setup for instrumental background
|
|
simulations for fluorescence measurements.
|
|
gammaknife
|
|
- Application specifically developed to simulate an advanced device for
|
|
Stereotactic Radiosurgery; reproduces a Leksell Gamma-Knife unit model C
|
|
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
|
|
iort_therapy
|
|
- Application specifically developed to address typical needs related to
|
|
the Intra-Operative Radio-Therapy (IORT) technique
|
|
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
|
|
microelectronics
|
|
- Simulating tracks of a 5 MeV proton in silicon.
|
|
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
|
|
- Modeling a simplified diamond microdosimeter for radioprotection
|
|
applications in space environments.
|
|
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
|
|
|