Presentation is loading. Please wait.

Presentation is loading. Please wait.

Geant4 ESTEC Workshop 990923 K.Amako 1 Geant4 User’s Documents Geant4 ESTEC Workshop 23 September, 1999 Katsuya Amako (KEK)

Similar presentations


Presentation on theme: "Geant4 ESTEC Workshop 990923 K.Amako 1 Geant4 User’s Documents Geant4 ESTEC Workshop 23 September, 1999 Katsuya Amako (KEK)"— Presentation transcript:

1 Geant4 ESTEC Workshop K.Amako 1 Geant4 User’s Documents Geant4 ESTEC Workshop 23 September, 1999 Katsuya Amako (KEK)

2 Geant4 ESTEC Workshop K.Amako 2 Katsuya Amako (KEK) Joe Chuma (TRIUMF) Very limited manpower comparing to the importance of the subject! Members of the Use Document Subgrup

3 Geant4 ESTEC Workshop K.Amako 3 Introduction of Geant4 Introduction documents Original format: html Installation Guide Guide book to set up Geant4 in a user’s computing environment Original format: html 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. Original format: html Structure of User’s Documents - 1

4 Geant4 ESTEC Workshop K.Amako 4 User's Guide: For Toolkit Developers For those who want to contribute to the extension of the functionality To describe object-oriented analysis and design Original format: latex Physics Reference Manual Detailed description of the physics models Original format: latex Software Reference Manual Detailed description of the definitions of classes and their public methods Original format: ascii header file -> perl-cgi (by S. Mani) Structure of User’s Documents - 2

5 Geant4 ESTEC Workshop K.Amako 5 We released the 2nd version of the use documents in accordance with the “July code release”. In this release we concentrated to revise the following documents: Introduction to Geant4 Installation Guide User’s Guide: For Application Developers Physics Reference Manual Current Status - 1

6 Geant4 ESTEC Workshop K.Amako 6 Major topics added/updated in the “July release” are: new scheme of physics lists, new scheme of user actions, provide links to example codes and read-me docs from the example section, explanation of granular libraries usage, explanation of STL usage, low energy physics, proof reading of document with an eye on checking the English usage, grammar and basic "look and feel”. Current Status - 2

7 Geant4 ESTEC Workshop K.Amako 7 There is always a time lag between the code release and the document release.  3 weeks delay in the “July release”.  Code developers and document writers are same. There is a structural problem in the HTML version of Physics Reference Manual.  Latex2html cannot handle properly the bibliography sections. Note in the new release

8 Geant4 ESTEC Workshop K.Amako 8 We need to update the following documents: User’s Guide: For Toolkit Developers Software Reference Manual We won’t touch on the following documents: Selected Useful Notes from Users Selected Useful Examples form Users Bug Reports and Fixes FAQ Next Steps

9 Geant4 ESTEC Workshop K.Amako 9 The sections currently available are only OOA/OOD Tracking Visualization Global Guide to extend functionality Geometry Electromagnetic Field Issues we need to agree upon: Time scale – User’s Guide: For Toolkit Developer

10 Geant4 ESTEC Workshop K.Amako 10 Issues we need to agree upon: The common format for header files. Do we need to provide descriptions for all methods? Time scale – Software Reference Manual


Download ppt "Geant4 ESTEC Workshop 990923 K.Amako 1 Geant4 User’s Documents Geant4 ESTEC Workshop 23 September, 1999 Katsuya Amako (KEK)"

Similar presentations


Ads by Google