Geant4 Orsay Workshop K.Amako 1 Geant4 User’s Documents Geant4 Orsay Workshop 18 October, 2000 Katsuya Amako (KEK/CERN)

Geant4 Orsay Workshop K.Amako 2 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

Geant4 Orsay Workshop K.Amako 3 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 practical 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

Geant4 Orsay Workshop K.Amako 4 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 processes. 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

Geant4 Orsay Workshop K.Amako 5 The most recent release is July 2000  In accordance with the code release of Geant [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

Geant4 Orsay Workshop K.Amako 6 Software Reference Manual  This was the major target for improvement in the last release. Current Status - 2

Geant4 Orsay Workshop K.Amako 7 File name #total#with%description filedescriptioncompleted /digits+hit/detector76 /digits+hit/digits44 /digits+hit/hits4493 % /event % /g3tog42200 % /geometry/magneticfield2927 /geometry/magnagement2119 /geometry/solids14184 /geometry/volumes % Current Status - Software Reference Manual - 1

Geant4 Orsay Workshop K.Amako 8 File name #total#with%description filedescriptioncompleted /global/HEPGeometry80 /global/HEPNumerics1010 /global/HEPRandom21 /global/management % /graphics_reps % /intercoms % /interfaces/GAG11 /interfaces/OPACS30 /interfaces/XVT20 /interfaces/basic 86 /interfaces/common6560 % Current Status - Software Reference Manual - 2

Geant4 Orsay Workshop K.Amako 9 File name #total#with%description filedescriptioncompleted /materials /particles/bosons60 /particles/hadrons670 /particles/leptons140 /particles/management2720 /particles/shortlived14016 % /persistency/digits+hits20 /persistency/events10 /persistency/geometry10 /persistency/global61 /persistency/run109 % Current Status - Software Reference Manual - 3

Geant4 Orsay Workshop K.Amako 10 File name #total#with%description filedescriptioncompleted /processes/decay100 % /processes/electromagnetic/lowenergy1811 /processes/electromagnetic/muons80 /processes/electromagnetic/standard216 /processes/electromagnetic/utils51 /processes/electromagnetic/xrays4439 % /processes/management % /processes/optical33100 % /processes/parameterisation15640 % /processes/photolepton_hadron 600 % /processes/transportation2150 % Current Status - Software Reference Manual - 4

Geant4 Orsay Workshop K.Amako 11 File name #total#with%description filedescriptioncompleted /processes/hadronic/cross_sections110 /processes/hadronic/management80 /processes/hadronic/models/generator1720 /processes/hadronic/models/high_energy290 /processes/hadronic/models/isotope_..60 /processes/hadronic/models/low_energy280 /processes/hadronic/models/neutron_hp1040 /processes/hadronic/models/radiative_ /processes/hadronic/stopping260 /processes/hadronic/util1204 % Current Status - Software Reference Manual - 5

Geant4 Orsay Workshop K.Amako 12 File name #total#with%description filedescriptioncompleted /readout44100 % /run99100 % /track % /tracking1200 % /visualization/FukuiRenderer120 /visualization/OPACS50 /visualization/OpenGL420 /visualization/OpenInventor60 /visualization/RayTracer1613 /visualization/VRML140 /visualization/management409 /visualization/modeling11821 % Current Status - Software Reference Manual - 6

Geant4 Orsay Workshop K.Amako 13 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

Geant4 Orsay Workshop K.Amako 14 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

Geant4 Orsay Workshop K.Amako 15 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