Import Geant4 10.0.0 source tree

examples/README

@@ -1,4 +1,4 @@
-$Id: README,v 1.16 2010-11-29 10:34:36 gcosmo Exp $
+$Id: README 77949 2013-11-29 21:19:29Z ihrivnac $
 -------------------------------------------------------------------
 
      =========================================================
@@ -13,30 +13,44 @@ 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 "novice" set of examples is oriented to novice users and covering all
-possible general use-cases typical of an "application"-oriented kind of
-development. As several examples in this "novice" set became too complicated, 
-a new "basic" set, covering the most typical use-cases of a Geant4 application
-with keeping simplicity and ease of use, is provided and is going to replace
-the "novice" set in future.
+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 require some additional
-libraries besides of Geant4. This set covers some 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.
+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.
+in README.HowToRun and README.HowToRunTestEm1. Several tips how to run 
+an example in multi-threading mode can be found in README.HowToRunMT.
 
-Basic, novice and most of the extended examples are considered part of the
+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, novice and some of the extended and advanced
+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 
@@ -56,30 +70,7 @@ Basic examples
    - 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)
-
-Novice level examples
- ExampleN01
-   - Mandatory user classes
-   - Demonstrates how Geant4 kernel works
- ExampleN02
-   - Simplified tracker geometry with uniform magnetic field
-   - Electromagnetic processes
- ExampleN03
-   - Simplified calorimeter geometry
-   - Electromagnetic processes
-   - Various materials
- ExampleN04
-   - Simplified collider detector with a readout geometry
-   - Full "ordinary" processes
-   - PYTHIA primary events
-   - Event filtering by stack
- ExampleN05
-   - Simplified BaBar calorimeter
-   - EM shower parametrisation
- ExampleN06
-   - Optical photon processes
- ExampleN07
-   - Regions and parameterised materials
+   - Started from novice/N03 example
 
 Extended level examples
  analysis
@@ -111,12 +102,14 @@ Extended level examples
  optical
    - Examples of generic optical processes simulation setups
  parallel
-   - Examples of event-level parallelism in Geant4 using the
-     TOP-C distribution, and MPI technique
+   - 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
@@ -139,9 +132,18 @@ Advanced level examples
  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
+ dnaphysics
+   - Simulation of track structures in liquid water using the Geant4-DNA
+     physics processes and models
  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
@@ -149,6 +151,9 @@ Advanced level examples
  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
@@ -167,11 +172,6 @@ Advanced level examples
  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
-   - Application for the evaluation of dose in astronauts, vehicle concepts
-     and Moon surface habitat configurations, in a space radiation environment
- Rich
-   - Rich Test Beam Simulation
  underground_physics
    - Setup of an underground dark matter experiment
  xray_fluorescence