geant4 orsay workshop 001018 k.amako 1 geant4 user’s documents geant4 orsay workshop 18 october,...

Geant4 Orsay Workshop 001018 K.Amako 1

Geant4 User’s Documents

Geant4 Orsay Workshop18 October, 2000

Katsuya Amako(KEK/CERN)


Very very limited manpower in the subgroup comparing to Importance of the subject!

Katsuya Amako (KEK/CERN)

Joe Chuma (TRIUMF)

!! Each person can spend very limited FTE for the work!!

Authors of the documents:

Most of you who are code developers of each category.

!! Again, each person can spend very limited FTE for the work!!

Members of the Use Document Subgroup


Introduction of Geant4 Introduction documents

History, maintenance structure, user support information, etc Original format: html ps, ps.gz, pdf available

Changes in User’s Document since the last release Summary of major changes in each release Original format: html No printed file available

Installation Guide Guide book to set up Geant4 in user’s computing environment Original format: html ps, ps.gz, pdf available

User's Guide: For Application Developers Step-by-step tutorial in the use of Geant4, Usage of the toolkit for practica

l applications, Example codes, Advanced use of the toolkit. The most extensively consulted document especially by novice users. Original format: html ps, ps.gz, pdf available

Structure of User’s Documents - 1


User's Guide: For Toolkit Developers For those who want to contribute to the extension of the functionality

Described the object-oriented analysis and design of Geant4 Still under construction - there are several obsolete parts Original format: latex html (via latex2html), ps, ps.gz, pdf available

Physics Reference Manual Detailed description of the physics models used in the implementation of proces

ses. Implementation into codes is not explained in this manual.

It is described in “User’s Guide: For Application developers”. Original format: latex html (via latex2html), ps, ps.gz, pdf available

[Note] There is a problem in latex2html, which makes the html version not neat. Software Reference Manual

Detailed description of the definitions of classes and their public methods. Original format: ascii generated on demand by the CGI script (Perl)

no printed version available

Structure of User’s Documents - 2


The most recent release is July 2000 In accordance with the code release of Geant4.2.0. [Note] The release of the user docs is always 3 weeks after the code release.

Major changes in the July 2000 release Overview (Top Page)

- Search engine installed. Installation Guide

- All section updated User's Guide: For Application Developers

- Getting started with Geant4 revised - Practical application: Navigation problem fixed, obsolete parts of the example

section corrected. Physics Reference Manual

- Electromagnetic Interaction - Low Energy Extension revised extensively

- Electromagnetic Interaction - Muon revised extensively

Current Status - 1


Software Reference Manual This was the major target for improvement in the last release.

Current Status - 2


File name #total #with %description file descriptioncompleted

-----------------------------------------------------------------------------------------------/digits+hit/detector 7 6/digits+hit/digits 4 4/digits+hit/hits 4 4 93 %----------------------------------------------------------------------------------------------- •/event 22 18 81 %-----------------------------------------------------------------------------------------------/g3tog4 22 0 0 %----------------------------------------------------------------------------------------------- /geometry/magneticfield 29 27/geometry/magnagement 21 19/geometry/solids 141 84/geometry/volumes 17 17 71 %-----------------------------------------------------------------------------------------------

Current Status - Software Reference Manual - 1



-----------------------------------------------------------------------------------------------/global/HEPGeometry 8 0/global/HEPNumerics 10 10/global/HEPRandom 2 1/global/management 29 16 55 %-----------------------------------------------------------------------------------------------/graphics_reps 21 21 100 %-----------------------------------------------------------------------------------------------/intercoms 24 20 83 %-----------------------------------------------------------------------------------------------/interfaces/GAG 1 1/interfaces/OPACS 3 0/interfaces/XVT 2 0/interfaces/basic 8 6/interfaces/common 6 5 60 %-----------------------------------------------------------------------------------------------




-----------------------------------------------------------------------------------------------/materials 16 12-----------------------------------------------------------------------------------------------/particles/bosons 6 0/particles/hadrons 67 0/particles/leptons 14 0/particles/management 27 20/particles/shortlived 14 0 16 %-----------------------------------------------------------------------------------------------/persistency/digits+hits 2 0/persistency/events 1 0/persistency/geometry 1 0/persistency/global 6 1/persistency/run 1 0 9 %-----------------------------------------------------------------------------------------------



File name #total #with %description filedescriptioncompleted

----------------------------------------------------------------------------------------------------------/processes/decay 1 0 0 %----------------------------------------------------------------------------------------------------------/processes/electromagnetic/lowenergy 18 11/processes/electromagnetic/muons 8 0/processes/electromagnetic/standard 21 6/processes/electromagnetic/utils 5 1/processes/electromagnetic/xrays 4 4 39 %----------------------------------------------------------------------------------------------------------/processes/management 19 19 100 %----------------------------------------------------------------------------------------------------------/processes/optical 3 3 100 %----------------------------------------------------------------------------------------------------------/processes/parameterisation 15 6 40 %----------------------------------------------------------------------------------------------------------/processes/photolepton_hadron 6 0 0 %----------------------------------------------------------------------------------------------------------/processes/transportation 2 1 50 %----------------------------------------------------------------------------------------------------------




----------------------------------------------------------------------------------------------------------/processes/hadronic/cross_sections 11 0/processes/hadronic/management 8 0/processes/hadronic/models/generator 172 0/processes/hadronic/models/high_energy 29 0/processes/hadronic/models/isotope_.. 6 0/processes/hadronic/models/low_energy 28 0/processes/hadronic/models/neutron_hp104 0/processes/hadronic/models/radiative_.. 18 17/processes/hadronic/stopping 26 0/processes/hadronic/util 12 0 4 %----------------------------------------------------------------------------------------------------------




-----------------------------------------------------------------------------------------------/readout 4 4 100 %-----------------------------------------------------------------------------------------------/run 9 9 100 %-----------------------------------------------------------------------------------------------/track 20 19 95 %-----------------------------------------------------------------------------------------------/tracking 12 0 0 %-----------------------------------------------------------------------------------------------/visualization/FukuiRenderer 12 0/visualization/OPACS 5 0/visualization/OpenGL 42 0/visualization/OpenInventor 6 0/visualization/RayTracer 16 13/visualization/VRML 14 0/visualization/management 40 9/visualization/modeling 11 8 21 %-----------------------------------------------------------------------------------------------



Proposal - 1

Peer’s reviews of the following user’s documents Introduction of Geant4 Installation Guide User's Guide: For Application Developers

Procedure The document subgroup will assign the reviewer of each section in the

above documents. A reviewer should carefully read the assigned section(s) and report to the

author(s) especially the following points: important subjects missing, incorrect explanations, mistakes, typos, etc If necessary, suggestion of revision, etc.

Time schedule A reviewer’s report to the author end of November The author to revise the section(s) 20th December The release of revised documents January 2001

The project to improve user’s documents - 1


Proposal - 2 Improve the software reference manual

To add class descriptions to header files especially the poorly documented categories ( less than 50% documented).

Time schedule 2 weeks after the next code release (middle of December)

Proposal - 3 Improve the physics reference manual

We’d like to ask Michel Marie, Laszlo Urban and Hans-Peter Wellish to organize the peer reviews as in the Proposal-1.

The project to improve user’s documents - 2


Proposal-1 What do you think about this proposal? Who can join the peer’s reviews? Time schedule OK?

Proposal-2 Time schedule OK?

Proposal-3 What do you think about this proposal?

Especially what Michel, Laszlo and Hans-Peter think about this? Who can join the peer’s reviews? Time schedule?

Other points Plan to improve “Toolkit Developers Guide”. Relation to the training kit related documents. To reinforce manpower of the subgroup

We know there are lot of requests/complains in the current status of the documentation. To improve the situation, the Geant4 group has to consider seriously about this issue (I proposed this point already in the Niigata workshop 2 years ago, but there has been no action taken.)

Discussions