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 ] 

  1 -------------------------------------------------------------------
  2 
  3      =========================================================
  4      Geant4 - an Object-Oriented Toolkit for Simulation in HEP
  5      =========================================================
  6 
  7                          Examples module
  8                          ---------------
  9 
 10 This module collects three sets of user examples aimed to demonstrate to
 11 the user how to make correct use of the GEANT4 toolkit by implementing
 12 in a correct way those user-classes which the user is supposed to
 13 customize in order to define his/her own simulation setup.
 14 
 15 The "basic" set of examples is oriented to novice users and covering 
 16 the most typical use-cases of a Geant4 application with keeping simplicity 
 17 and ease of use.
 18 
 19 An "extended" set of examples may require some additional libraries besides 
 20 of Geant4. This set covers many specific use cases for actual detector 
 21 simulation. 
 22 
 23 An "advanced" set of examples covers the use-cases typical of a 
 24 "toolkit"-oriented kind of development, where real complete applications 
 25 for different simulation studies are provided; may require additional third 
 26 party products to be built.
 27 
 28 Most of the examples can be run both in interactive and batch mode, and 
 29 input macro files (*.in) and reference output files (*.out) are provided.
 30 See the detailed instructions how to build and how to run an example
 31 in README.HowToRun and README.HowToRunTestEm1. Several tips how to run 
 32 an example in multi-threading mode can be found in README.HowToRunMT.
 33 
 34 Basic and most of the extended examples are considered part of the
 35 system testing suite for validation of the official releases of the
 36 GEANT4 toolkit. Basic and some of the extended and advanced
 37 examples are also used as "acceptance"-tests for the release process.
 38 
 39 The previous set of examples oriented to novice users, "novice",
 40 has been refactored in "basic" and "extended" examples sets in Geant4 10.0.
 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 Geant4 LXR code browser:
 43   http://www-geant4.kek.jp/lxr/source/examples/novice/?v=9.6.p2
 44 
 45 And more on what is common for all examples:
 46 - README.HowToRun
 47 - README.HowToRunMT
 48 
 49 Web: https://geant4-userdoc.web.cern.ch/Doxygen/examples_doc/html/index.html
 50