Warning, /geant4/examples/README.md is written in an unsupported language. File is not indexed.
0001 # Geant4 examples {#mainpage}
0002
0003 This module collects three sets of user examples aimed to demonstrate to
0004 the user how to make correct use of the GEANT4 toolkit by implementing
0005 in a correct way those user-classes which the user is supposed to
0006 customize in order to define his/her own simulation setup.
0007
0008 The **"basic"** set of examples is oriented to novice users and covering
0009 the most typical use-cases of a Geant4 application with keeping simplicity
0010 and ease of use.
0011
0012 An **"extended"** set of examples may require some additional libraries besides
0013 of Geant4. This set covers many specific use cases for actual detector
0014 simulation.
0015
0016 An **"advanced"** set of examples covers the use-cases typical of a
0017 "toolkit"-oriented kind of development, where real complete applications
0018 for different simulation studies are provided; may require additional third
0019 party products to be built.
0020
0021 Most of the examples can be run both in interactive and batch mode, and
0022 input macro files (*.in) and reference output files (*.out) are provided.
0023 Basic and most of the extended examples are considered part of the
0024 system testing suite for validation of the official releases of the
0025 GEANT4 toolkit. Basic and some of the extended and advanced
0026 examples are also used as "acceptance"-tests for the release process.
0027
0028 See more on each examples category pages:
0029 - [Basic examples](\ref README_basic)
0030 - [Extended examples](\ref README_extended)
0031 - <a href="https://www.geant4.org/docs/advanced_examples_doc/index">
0032 <b>Advanced Examples </b></a>
0033
0034 And more on what is common for all examples:
0035 - [How to build and run an example](\ref README_HowToRun)
0036 - [Tips how to run an example in multi-threading mode](\ref README_HowToRunMT)
0037 - [How to navigate in the examples documentation](\ref README_HowToNavigate)
0038
0039 Web: https://geant4-userdoc.web.cern.ch/Doxygen/examples_doc/html/index.html
