Geant 4 Users Documents Geant 4 Orsay Workshop

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

Members of the Use Document Subgroup Very very limited manpower in the subgroup comparing to Importance of the subject! n Katsuya Amako (KEK/CERN) n Joe Chuma (TRIUMF) !! Each person can spend very limited FTE for the work!! n 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!! Geant 4 Orsay Workshop 001018 K. Amako 2

Structure of User’s Documents - 1 n Introduction of Geant 4 n Introduction documents History, maintenance structure, user support information, etc n Original format: html è ps, ps. gz, pdf available n Changes in User’s Document since the last release n Summary of major changes in each release n Original format: html èNo printed file available n Installation Guide book to set up Geant 4 in user’s computing environment n Original format: html è ps, ps. gz, pdf available n User's Guide: For Application Developers n Step-by-step tutorial in the use of Geant 4, Usage of the toolkit for practical applications, Example codes, Advanced use of the toolkit. n The most extensively consulted document especially by novice users. n Original format: html è ps, ps. gz, pdf available Geant 4 Orsay Workshop 001018 K. Amako 3

Structure of User’s Documents - 2 n User's Guide: For Toolkit Developers n For those who want to contribute to the extension of the functionality Described the object-oriented analysis and design of Geant 4 n Still under construction - there are several obsolete parts n Original format: latex è html (via latex 2 html), ps. gz, pdf available n Physics Reference Manual n Detailed description of the physics models used in the implementation of processes. n Implementation into codes is not explained in this manual. n It is described in “User’s Guide: For Application developers”. n Original format: latex è html (via latex 2 html), ps. gz, pdf available [Note] There is a problem in latex 2 html, which makes the html version not neat. n Software Reference Manual n Detailed description of the definitions of classes and their public methods. n Original format: ascii è generated on demand by the CGI script (Perl) è no printed version available Geant 4 Orsay Workshop 001018 K. Amako 4

Current Status - 1 n The most recent release is July 2000 è In accordance with the code release of Geant 4. 2. 0. [Note] The release of the user docs is always 3 weeks after the code release. n Major changes in the July 2000 release n Overview (Top Page) - Search engine installed. n Installation Guide - All section updated n User's Guide: For Application Developers - Getting started with Geant 4 revised - Practical application: Navigation problem fixed, obsolete parts of the example section corrected. n Physics Reference Manual - Electromagnetic Interaction - Low Energy Extension è revised extensively - Electromagnetic Interaction - Muon è revised extensively Geant 4 Orsay Workshop 001018 K. Amako 5

Current Status - 2 n Software Reference Manual è This was the major target for improvement in the last release. Geant 4 Orsay Workshop 001018 K. Amako 6

Current Status - Software Reference Manual - 1 File name #with %description file description completed -----------------------------------------------/digits+hit/detector 7 6 /digits+hit/digits 4 4 /digits+hit/hits 4 4 93 % ----------------------------------------------- • /event 22 18 81 % -----------------------------------------------/g 3 tog 4 22 0 0% -----------------------------------------------/geometry/magneticfield 29 27 /geometry/magnagement 21 19 /geometry/solids 141 84 /geometry/volumes 17 17 71 % ------------------------------------------------ Geant 4 Orsay Workshop #total 001018 K. Amako 7

Current Status - Software Reference Manual - 2 File name #with %description file description completed -----------------------------------------------/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 % -----------------------------------------------Geant 4 Orsay Workshop #total 001018 K. Amako 8

Current Status - Software Reference Manual - 3 File name #with %description file description completed -----------------------------------------------/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% -----------------------------------------------Geant 4 Orsay Workshop #total 001018 K. Amako 9

Current Status - Software Reference Manual - 4 File name #with %description file description completed -----------------------------------------------------/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 % -----------------------------------------------------Geant 4 Orsay Workshop #total 001018 K. Amako 10

Current Status - Software Reference Manual - 5 File name #with %description file description completed -----------------------------------------------------/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_hp 104 0 /processes/hadronic/models/radiative_. . 18 17 /processes/hadronic/stopping 26 0 /processes/hadronic/util 12 0 4% ----------------------------------------------------- Geant 4 Orsay Workshop #total 001018 K. Amako 11

Current Status - Software Reference Manual - 6 File name #with %description file description completed -----------------------------------------------/readout 4 4 100 % -----------------------------------------------/run 9 9 100 % -----------------------------------------------/track 20 19 95 % -----------------------------------------------/tracking 12 0 0% -----------------------------------------------/visualization/Fukui. Renderer 12 0 /visualization/OPACS 5 0 /visualization/Open. GL 42 0 /visualization/Open. Inventor 6 0 /visualization/Ray. Tracer 16 13 /visualization/VRML 14 0 /visualization/management 40 9 /visualization/modeling 11 8 21 % -----------------------------------------------Geant 4 Orsay Workshop #total 001018 K. Amako 12

The project to improve user’s documents - 1 n Proposal - 1 Peer’s reviews of the following user’s documents n Introduction of Geant 4 n Installation Guide n User's Guide: For Application Developers n Procedure n The document subgroup will assign the reviewer of each section in the above documents. n A reviewer should carefully read the assigned section(s) and report to the author(s) especially the following points: n important subjects missing, n incorrect explanations, mistakes, typos, etc n If necessary, suggestion of revision, etc. n Time schedule n A reviewer’s report to the author n The author to revise the section(s) n The release of revised documents Geant 4 Orsay Workshop è end of November è 20 th December è January 2001 001018 K. Amako 13

The project to improve user’s documents - 2 n Proposal - 2 Improve the software reference manual n To add class descriptions to header files especially the poorly documented categories ( less than 50% documented). n Time schedule n 2 weeks after the next code release (middle of December) n. Proposal - 3 Improve the physics reference manual n We’d like to ask Michel Marie, Laszlo Urban and Hans-Peter Wellish to organize the peer reviews as in the Proposal-1. Geant 4 Orsay Workshop 001018 K. Amako 14

Discussions n. Proposal-1 n What do you think about this proposal? n Who can join the peer’s reviews? n Time schedule OK? n. Proposal-2 n Time schedule OK? n. Proposal-3 n What do you think about this proposal? n Especially what Michel, Laszlo and Hans-Peter think about this? n Who can join the peer’s reviews? n Time schedule? n. Other points n Plan to improve “Toolkit Developers Guide”. n Relation to the training kit related documents. n To reinforce manpower of the subgroup n We know there are lot of requests/complains in the current status of the documentation. To improve the situation, the Geant 4 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. ) Geant 4 Orsay Workshop 001018 K. Amako 15