Documentation, examples and user support

Documentation, examples and user support

Makoto Asai (SLAC PPA/SCA) November 12th, 2014 Geant4 tutorial @ ANS Winter Meeting 2014

Geant4 User Documenta0on

•  Four manuals distributed at every Geant4 release –  Installa0on Guide –  Applica0on Developer’s Guide –  Toolkit Developer’s Guide –  Physics Reference Manual

•  Many validated examples of varying complexity •  Basic Examples: core components of toolkit •  Extended Examples: extensions, configura0on op0ons •  Advanced Examples: complete “prac0cal” applica0ons

•  Online discussion forums for users and collaborators

Documentation, examples and user support - M. Asai (SLAC)


•  The four Users’ Guides are generally updated and published at the same 0me as the toolkit is released.

•  http://www.geant4.org/geant4/support/userdocuments.shtml!

•  All four Users’ Guides are available as PDF documents (some of them quite long).

•  The Installa'on, Applica'on and Toolkit Guides are also available in HTML form, broken into chapters.




Applica0on Developer’s Guide

•  The Applica'on Developer’s Guide covers all of the classes, and all of the soSware categories, you might need when wri0ng your own user applica0on.

–  Geometry: shapes, materials, and structure –  Physics processes and physics lists –  Genera0ng par0cles for events –  User ac0ons: customizing the event loop –  Collec0ng data during events –  User interface: macros and commands –  Visualiza0on


Toolkit Developer’s Guide and Physics Reference Manual

•  The Toolkit Developer’s Guide covers the design philosophy and organiza0on of the toolkit, with informa0on useful to both Geant4 collabora0on members and users who want to add new features not available in the distribu0on.

–  Defining special purpose solids for complex geometries

–  Crea0ng new physics processes or models

–  Crea0ng run or event managers with special features

•  The Toolkit Developer’s Guide is currently being revised to provide more complete and up to date guidance.

•  The Physics Reference Manual provides a detailed summary of the physics implemented in each of the processes and models (EM, hadronic, and op0cal) with references to the source publica0ons.


Geant4 Example Applica0ons

•  As part of the toolkit distribu0on, Geant4 provides an extensive set of examples covering a wide range of complexity.

Basic: complete applica0ons demonstra0ng simple features of toolkit, useful for tutorial purposes

Extended: demonstrate specific, more complex use cases; some require use of external (non-‐Geant4) libraries

Advanced: complex, “experiment-‐level” applica0ons with complex geometries and physics focused on par0cular user communi0es

•  Documenta0on is in README files and Web pages


Basic Examples

Example B1 •  Few simple solids, simple placements •  Scoring total dose in a selected

volume user action classes Example B2

•  Magnetic field, parametrised placements

•  Scoring within tracker via G4 sensitive detector and hits

•  Geant4 physics list (FTFP_BERT) with step limiter

Example B3 (Schematic PET system) •  Simple placements with rotations •  Scoring within Crystals via G4

scorers •  Radioactive source, modular physics

list using builders

Example B4 (Layered calorimeter) •  Geometry with replicas

(G4PVReplica) •  Multiple scoring methods •  Histograms (1D) and ntuple saved in

the output file

Example B5 (Double-arm spectrometer)

•  Complex geometry with rotation, replicas and parametrisation

•  Scoring within multiple volumes via G4 sensitive detector and hits

•  Local UI commands defined using G4GenericMessenger

•  Histograms (1D, 2D) and ntuple saved in the output file


Extended Examples

analysis Histogramming through G4tools

biasing Examples of event biasing, scoring and reverse-‐MC

common A set of common classes which can be reused in other extended examples demonstraAng just a parAcular feature

electromagneAc Specific EM physics simulaAon with histogramming

errorpropagaAon Use of the error propagaAon uAlity (Geant4e)

eventgenerator ApplicaAons demonstraAng various ways of primary event generaAon: using Geant4 parAcle gun, Geant4 general parAcle source, using interface to HepMC, Pythia


Extended Examples (con0nued)

exoAcphysics ExoAc simulaAon applicaAons (classical magneAc monopole, phonon, etc...)

field Specific simulaAon setups in magneAc field

g3tog4 Examples of usage of the g3tog4 converter tool

geometry Specific geometry examples and tools

hadronic Specific hadronic physics simulaAon with histogramming

medical Specific examples for medical physics applicaAons

opAcal Examples of generic opAcal processes simulaAon setups

parallel Examples of event-‐level parallelism in Geant4 using the TOP-‐C distribuAon, and TBB and MPI techniques

parameterisaAon Examples for fast shower parameterisaAons according to specific models (gflash)


Extended Examples (con0nued)

persistency Persistency of geometry (GDML or ASCII) and simulaAon output

polarisaAon Use of physics processes including polarizaAon

radioacAvedecay Examples to simulate the decays of radioacAve isotopes and induced radioacAvity resulted from nuclear interacAons

runAndEvent Examples to demonstrate Geant4 kernels, i.e. run and event categories, and sensiAve detector and scoring funcAonaliAes

visualizaAon Specific visualizaAon features and graphical customisaAons


Advanced Examples

amsEcal SimulaAon of an ElectromagneAc calorimeter allowing precise and three dimensional imaging of a lateral and longitudinal shower development

Brachytherapy Dosimetry for endocavitary, intersAAal and superficial brachytherapy

ChargeExchangeMC

SimulaAon of charge exchange real experiment performed at the Petesburg Nuclear Physics InsAtute (PNPI, Russia)

Composite calorimeter A composite electromagneAc and hadronic calorimeter, similar to a CMS test beam set-‐up

Dnaphysics SimulaAon of a track structure in liquid water using the Geant4 DNA very low energy processes


Advanced Examples (con0nued)

Dnageometry SimulaAon of a realisAc cell nucleus, including DNA content

eRosita PIXE simulaAon with Geant4 ?

Gamma-‐knife A device for StereotacAc Radiosurgery with Co60 sources for treatment of cerebral diseases

Gamma-‐ray telescope A simplified typical gamma-‐ray telescope (such as GLAST), with advanced descripAon of the detector response

Hadrontherapy SimulaAon of a transport beam line for proton and ion therapy

Human_phantom

iort_therapy



Medical Linac A typical LINAC accelerator for IMRT, simular to one used in the clinical pracAce

Microbeam SimulaAon of a cellular irradiaAon microbeam line using a high resoluAon cellular phantom

Microdosimetry CombinaAon of Geant4 EM processes with Geant4-‐DNA processes

Microelectronics CombinaAon of Geant4 EM processes with G4MicroElec processes

Nanobeam SimulaAon of a nanobeam line facility

Purging magnet Electrons traveling through the magneAc field of a strong purging magnet in a radiotherapy treatment head

RadioprotecAon Dose distribuAons in interplanetary space radiaAon enviroment, for the radioprotecAon of astronauts in space vehicles and planetary habitat.



RICH A RICH detector in a set-‐up similar to the LHCb test beam

Underground physics A simplified typical dark ma]er detector (such as the Boulby Mine experiment)

X-‐ray fluorescence Elemental composiAon of material samples through X-‐ray fluorescence spectra

X-‐ray telescope A simplified typical X-‐ray telescope (such as XMM-‐Newton or Chandra)


Hypernews Discussion Forums

•  Mul0ple topical sec0ons for discussion among users and between users and Geant4 developers

•  http://hypernews.slac.stanford.edu/HyperNews/geant4/cindex!


LXR Source Code Browser

•  A Web interface to all of the Geant4 source code is available through KEK

•  http://www-geant4.kek.jp/LXR/

–  Code selectable by release number –  Annotated: headers, classes, func0ons hyperlinks

•  A Doxygen generated interface is also available, but not all code has necessary annota0ons

•  http://www-geant4.kek.jp/Reference/!


Following up - 1

•  Please keep maintaining your Geant4 installation updated. –  Irregular patch releases may be more important than regular releases. –  Check our web page regularly to find release news, or register to Geant4

announcement mailing list.

http://geant4.slac.stanford.edu/


•  If you have a question 1.  Look for our documents.

•  Users guides, Twiki pages, tips pages, examples and their READMEs 2.  Post your question on Geant4 HyperNews

http://hypernews.slac.stanford.edu/HyperNews/geant4/cindex •  Please make sure to do a bit of survey that no one has already asked

the same question before. 3.  As the final method, write us a mail.

•  Avoid anonymous mail account such as hotmail, gmail, etc., if possible. 4.  Or, catch us at meetings/conferences.

•  Apologies if we cannot recognize you…

Following up - 2



Past tutorials



Documents

Documentation, examples and user support