| Geant4 Cross Reference |
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 three 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
45 And more on what is common for all examples: 45 And more on what is common for all examples:
46 - README.HowToRun 46 - README.HowToRun
47 - README.HowToRunMT 47 - README.HowToRunMT
48 48
49 Web: https://geant4-userdoc.web.cern.ch/Doxyge 49 Web: https://geant4-userdoc.web.cern.ch/Doxygen/examples_doc/html/index.html
50 50