source: trunk/documents/UserDoc/DocBookUsersGuides/IntroductionToGeant4/xml/Introduction/ChapIntroduction.xml~ @ 1345

Last change on this file since 1345 was 1345, checked in by garnier, 14 years ago

update CVS

File size: 17.8 KB
Line 
1<!-- ******************************************************** -->
2<!--                                                          -->
3<!--  [History]                                               -->
4<!--    Converted to DocBook: Katsuya Amako, Aug-2006         -->
5<!--                                                          -->
6<!-- ******************************************************** -->
7
8
9<!-- ******************* Chapter **************************** -->
10<chapter id="chap.G4Scope">
11<title>
12Geant4 Scope of Application
13</title>
14
15<para>
16Geant4 is a free software package composed of tools which can be
17used to accurately simulate the passage of particles through
18matter. All aspects of the simulation process have been included in
19the toolkit:
20
21<itemizedlist spacing="compact">
22  <listitem><para>
23    the geometry of the system,
24  </para></listitem>
25  <listitem><para>
26    the materials involved,
27  </para></listitem>
28  <listitem><para>
29    the fundamental particles of interest,
30  </para></listitem>
31  <listitem><para>
32    the generation of primary events,
33  </para></listitem>
34  <listitem><para>
35    the tracking of particles through materials and electromagnetic fields,
36  </para></listitem>
37  <listitem><para>
38    the physics processes governing particle interactions,
39  </para></listitem>
40  <listitem><para>
41    the response of sensitive detector components,
42  </para></listitem>
43  <listitem><para>
44    the generation of event data,
45  </para></listitem>
46  <listitem><para>
47    the storage of events and tracks,
48  </para></listitem>
49  <listitem><para>
50    the visualization of the detector and particle trajectories, and
51  </para></listitem>
52  <listitem><para>
53    the capture and analysis of simulation data at different levels
54    of detail and refinement.
55  </para></listitem>
56</itemizedlist>
57</para>
58
59<para>
60Users may construct stand-alone applications or applications built
61upon another object-oriented framework. In either case the toolkit
62will support them from the initial problem definition to the
63production of results and graphics for publication. To this end,
64the toolkit includes:
65
66<itemizedlist spacing="compact">
67  <listitem><para>
68    user interfaces,
69  </para></listitem>
70  <listitem><para>
71    built-in steering routines, and
72  </para></listitem>
73  <listitem><para>
74    command interpreters
75  </para></listitem>
76</itemizedlist>
77
78which operate at every level of the simulation.
79</para>
80
81<para>
82At the heart of Geant4 is an abundant set of physics models to
83handle the interactions of particles with matter across a very wide
84energy range. Data and expertise have been drawn from many sources
85around the world and in this respect, Geant4 acts as a repository
86which incorporates a large part of all that is known about particle
87interactions.
88</para>
89
90<para>
91Geant4 is written in C++ and exploits advanced
92software-engineering techniques and object-oriented technology to
93achieve transparency. For example, the way in which cross sections
94are input or computed is separated from the way in which they are
95used or accessed. The user can overload both of these features.
96Similarly, the computation of the final state can be divided into
97alternative or complementary models, according to the energy range,
98the particle type, and the material. To build a specific
99application the user-physicist chooses from among these options and
100implements code in user action classes supplied by the toolkit. A
101serious problem with previous simulation codes was the difficulty
102of adding new or variant physics models; development was difficult
103due to the increased size, complexity and interdependency of the
104procedure-based code. In contrast, object-oriented methods help
105manage complexity and limit dependencies by defining a uniform
106interface and common organizational principles for all physics
107models. Within this framework the functionality of models can be
108more easily recognized and understood, and the creation and
109addition of new models is a well-defined procedure that entails
110little or no modification to the existing code.
111</para>
112
113</chapter>
114
115
116<!-- ******************* Chapter **************************** -->
117<chapter id="chap.HistoryG4">
118<title>
119History of Geant4
120</title>
121
122<para>
123These ideas first appeared in two studies done independently at
124CERN and KEK in 1993. Both groups sought to investigate how modern
125computing techniques could be applied to improve the existing
126FORTRAN based Geant3 simulation program. Activities were merged in
127the fall of 1994 and a formal proposal, RD44, to construct an
128entirely new program based on object-oriented technology was
129submitted to CERN's Detector Research and Development Committee.
130The initiative grew to become a large international collaboration
131of physicist programmers and software engineers from a number of
132institutes and universities participating in a range of high-energy
133physics experiments in Europe, Japan, Canada and the United States.
134The objective was to write a detector simulation program which had
135the functionality and flexibility necessary to meet the
136requirements of the next generation of subatomic physics
137experiments. The initial scope quickly widened when it became
138apparent that such a tool would also benefit the nuclear,
139accelerator, space and medical physics community, with more
140individuals joining from these fields of science.
141</para>
142
143<para>
144The RD44 project represented a pioneering effort in redesigning
145a major CERN software package for a modern object-oriented (OO)
146environment based on C++. The R&amp;D phase was completed in
147December 1998 with the delivery of the first production release.
148The collaboration was subsequently renamed Geant4 and reinstated on
149the basis of a formal Memorandum of Understanding (MoU) signed by
150many of the same national institutes, laboratories and large HEP
151experiments who participated in RD44. The agreement addresses the
152program management, maintenance and user support during the
153production phase and the continued development and refinement of
154the toolkit. It is subject to tacit renewal every two years and
155sets out a collaboration structure defined by a Collaboration Board
156(CB), a Technical Steering Board (TSB) and several working
157groups. In February 2006 a new MoU came into effect and CB and TSB
158were renamed to Oversight Board (OB) and Steering Board (SB)
159respectively.
160</para>
161
162<para>
163The collaboration now profits from the accumulated experience of
164many contributors to the field of Monte Carlo simulation of physics
165detectors and physical processes. While geographically distributed
166software development and large-scale object-oriented systems are no
167longer a novelty, Geant4, in terms of the size and scope of the
168code and the number of contributors, may well represent the largest
169and most ambitious project of its kind outside the corporate world.
170A clean overall problem decomposition has led to a clear
171hierarchical structure of domains. Every section of the Geant4
172software, which corresponds to a releasable component (library), is
173individually managed by a working group of experts. In addition,
174there is a working group for each of the activities: testing and
175quality assurance, software management and documentation
176management. A release coordinator heads each group. This consequent
177distribution of responsibility among a relative large number of
178people permits a support structure whereby outside users can
179address questions directly to the appropriate expert.
180</para>
181
182</chapter>
183
184
185<!-- ******************* Chapter **************************** -->
186<chapter id="chap.OverviewG4Func">
187<title>
188Overview of Geant4 Functionality
189</title>
190
191<para>
192The Geant4 class category diagram is shown in Fig. 1.
193</para>
194
195<para>
196Categories at the bottom of the diagram are used by virtually
197all higher categories and provide the foundation of the
198toolkit.
199</para>
200
201<para>
202The
203
204<itemizedlist spacing="compact">
205  <listitem><para>
206    <emphasis>global</emphasis>
207  </para></listitem>
208</itemizedlist>
209
210category covers the system of units, constants, numerics and random
211number handling.
212</para>
213
214<para>
215The two categories:
216
217<itemizedlist spacing="compact">
218  <listitem><para>
219    <emphasis>materials</emphasis>
220  </para></listitem>
221  <listitem><para>
222    <emphasis>particles</emphasis>
223  </para></listitem>
224</itemizedlist>
225
226implement facilities necessary to describe the physical properties
227of particles and materials for the simulation of particle-matter
228interactions.
229</para>
230
231<para>
232The
233
234<itemizedlist spacing="compact">
235  <listitem><para>
236    <emphasis>geometry</emphasis>
237  </para></listitem>
238</itemizedlist>
239
240module offers the ability to describe a geometrical structure and
241propagate particles efficiently through it.
242</para>
243
244<para>
245<mediaobject>
246  <imageobject>
247    <imagedata fileref="./AllResources/classCategory.gif"
248               format="GIF" align="center"/>
249  </imageobject>
250  <caption>
251      Fig. 1 Geant4 class categories
252  </caption>
253</mediaobject>
254</para>
255
256<para>
257Above these reside categories required to describe the tracking
258of particles and the physical processes they undergo. The
259
260<itemizedlist spacing="compact">
261  <listitem><para>
262    <emphasis>track</emphasis>
263  </para></listitem>
264</itemizedlist>
265
266category contains classes for tracks and steps, used by the
267
268<itemizedlist spacing="compact">
269  <listitem><para>
270    <emphasis>processes</emphasis>
271  </para></listitem>
272</itemizedlist>
273
274category, which contains implementations of models of physical
275interactions: electromagnetic interactions of leptons, photons,
276hadrons and ions, and hadronic interactions.
277</para>
278
279<para>
280All processes are invoked by the
281
282<itemizedlist spacing="compact">
283  <listitem><para>
284    <emphasis>tracking</emphasis>
285  </para></listitem>
286</itemizedlist>
287
288category, which manages their contribution to the evolution of a
289track's state and provides information in sensitive volumes for
290hits and digitization.
291</para>
292
293<para>
294Above these the
295
296<itemizedlist spacing="compact">
297  <listitem><para>
298    <emphasis>event</emphasis>
299  </para></listitem>
300</itemizedlist>
301
302category manages events in terms of their tracks and the
303
304<itemizedlist spacing="compact">
305  <listitem><para>
306    <emphasis>run</emphasis>
307  </para></listitem>
308</itemizedlist>
309
310category manages collections of events that share a common beam and
311detector implementation. A
312
313<itemizedlist spacing="compact">
314  <listitem><para>
315    <emphasis>readout</emphasis>
316  </para></listitem>
317</itemizedlist>
318
319category allows the handling of pile-up.
320</para>
321
322<para>
323Finally capabilities that use all of these categories and
324connect to facilities outside the toolkit through abstract
325interfaces, provide <emphasis>visualization</emphasis>,
326<emphasis>persistency</emphasis> and user
327<emphasis>interface</emphasis> capabilities.
328</para>
329
330</chapter>
331
332
333<!-- ******************* Chapter **************************** -->
334<chapter id="chap.G4UserSupport">
335<title>
336Geant4 User Support
337</title>
338
339<para>
340The collaboration offers support for Geant4, providing
341
342<itemizedlist spacing="compact">
343  <listitem><para>
344    assistance with problems relating to the code,
345  </para></listitem>
346  <listitem><para>
347    consultation on using the toolkit, and
348  </para></listitem>
349  <listitem><para>
350    response to enhancement requests.
351  </para></listitem>
352</itemizedlist>
353</para>
354
355<para>
356A user can also expect assistance in
357
358<itemizedlist spacing="compact">
359  <listitem><para>
360    investigating aberrant results.
361  </para></listitem>
362</itemizedlist>
363</para>
364
365<para>
366Users of the software who encounter a problem in running the code
367can use an
368
369<itemizedlist spacing="compact">
370  <listitem><para>
371    Internet-based
372    <ulink url="http://geant4.web.cern.ch/geant4/problemreport/">
373    problem reporting system
374    </ulink>.
375  </para></listitem>
376</itemizedlist>
377</para>
378
379<para>
380The system is open to all users. It is set up automatically to
381assign problem reports to the responsible person according to the
382category affected. The contact person may then respond directly or
383forward it to a colleague. This system is a customized version of
384the open source reporting tool
385<ulink url="https://bugzilla.mozilla.org/">
386Bugzilla
387</ulink>
388.
389Besides routing the
390problem to specialists, it tracks and documents the responses until
391the problem is resolved.
392</para>
393
394<para>
395New requirements, such as requests for new functionality, are
396presented to and decided by the Steering Board (SB). The
397SB sets the priorities and agrees on time-scales for the
398fulfillment of new requirements. Such support is guaranteed to
399collaboration members, while requests from non-members are handled
400on a <emphasis>best effort</emphasis> basis.
401</para>
402
403<para>
404For each member organisation a contact person
405<ulink url="http://geant4.web.cern.ch/geant4/collaboration/SteeringBoard.shtml">
406(SB member)
407</ulink>
408has been designated who acts as a first reference for
409Geant4 users in that locality, which may include affiliated
410institutions, user groups, and others in the same geographic area.
411The contact person will respond to enquiries, help resolve simple
412problems, and forward more specialized queries to the relevant
413expert(s).
414</para>
415
416<para>
417Beyond that, a list of frequently asked questions
418<ulink url="http://geant4.web.cern.ch/geant4/support/faq.shtml">
419(FAQs)
420</ulink>
421,
422and an internet-based
423<ulink url="http://geant4-hn.slac.stanford.edu:5090/Geant4-HyperNews/index">
424user forum
425</ulink>
426complete the available Geant4 user support.
427</para>
428
429</chapter>
430
431
432<!-- ******************* Chapter **************************** -->
433<chapter id="sect.SoftwareKnowledge">
434<title>Software Knowledge Required to Use the Geant4 Toolkit
435</title>
436
437<para>
438In general, there are three types of users:
439
440<itemizedlist spacing="compact">
441   <listitem><para>
442     the <emphasis role="bold">end user</emphasis>,
443   </para></listitem>
444   <listitem><para>
445     the <emphasis role="bold">application programmer</emphasis>,
446   </para></listitem>
447</itemizedlist>
448
449and for large simulation tasks:
450
451<itemizedlist spacing="compact">
452  <listitem><para>
453    the <emphasis role="bold">framework provider</emphasis>.
454  </para></listitem>
455</itemizedlist>
456</para>
457
458<para>
459The <emphasis role="bold">end user</emphasis> runs the simulation
460program by controlling run time parameters. The interface with the
461program may be a graphical user interface, an interactive command
462line interface, or the macro-based system for batch. The end user
463needs a basic knowledge of how to control the program flow but does
464not necessarily have to know object-oriented programming or C++.
465</para>
466
467<para>
468The <emphasis role="bold">application programmer</emphasis> is central
469to any simulation task. A firm knowledge of C++ is required to implement
470code in user action classes to specify, at a minimum, the detector description,
471the relevant particles and physics processes, and the initial event
472kinematics. A manual for the application programmer is found in the
473<ulink url="http://geant4.web.cern.ch/geant4/UserDocumentation/UsersGuides/ForApplicationDeveloper/html/index.html">
474User's Guide: For Application Developers
475</ulink>
476.
477</para>
478
479<para>
480Using standard components of Geant4, a
481<emphasis role="bold">framework provider</emphasis>
482would add interfaces to external tools, such as for example, to
483Computer Aided Design (CAD) programs, Object-Oriented Data Base
484Management Systems (ODBMS) and graphics systems. This requires the
485development of new classes overloading standard Geant4
486functionality and hence a solid understanding of object-oriented
487Programming. A manual for the framework provider is found in the
488<ulink url="http://geant4.web.cern.ch/geant4/UserDocumentation/UsersGuides/ForToolkitDeveloper/html/index.html">
489User's Guide: For Toolkit Developers
490</ulink>
491.
492</para>
493
494<para>
495<emphasis role="bold">References</emphasis>
496</para>
497
498<para>
499All user documentation can be found on the Geant4 homepage
500<ulink url="http://cern.ch/geant4">
501http://cern.ch/geant4
502</ulink>
503.
504</para>
505
506<para>
507References for Object-Oriented Technology:
508
509<itemizedlist spacing="compact">
510  <listitem><para>
511    Grady Booch, Object-Oriented Analysis and Design with
512    Applications The Benjamin/Cummings Publishing Co. Inc, 1994, ISBN
513    0-8053-5340-2
514  </para></listitem>
515  <listitem><para>
516    R.C.Martin, Designing Object-Oriented C++ Applications Using
517    The Booch Method, Prentice Hall 1995, ISBN 0-13-203837-4;
518  </para></listitem>
519  <listitem><para>
520    E. Gamma, et al., Design Patterns - Elements of Reusable
521    Object-Oriented Software, Addison Wesley 1995, ISBN
522    0-201-63361-2;
523  </para></listitem>
524</itemizedlist>
525</para>
526
527<para>
528References for C++:
529
530<itemizedlist spacing="compact">
531  <listitem><para>
532    B.Stroustrup, C++ Programming Language 3rd Edition, Addison
533    Wesley, ISBN: 0-201-88954-4
534  </para></listitem>
535  <listitem><para>I.Pohl, Object-Oriented Programming Using C++, 2nd Edition,
536    Addison Wesley, ISBN: 0-201-89550-1.
537  </para></listitem>
538</itemizedlist>
539</para>
540
541</chapter>
542
543
544<!-- ******************* Chapter **************************** -->
545<chapter id="sect.ComputingEnv">
546<title>
547Computing Environment Required by the Geant4 Toolkit
548</title>
549
550<para>
551The Geant4 toolkit is available for a variety of operating systems:
552
553<itemizedlist spacing="compact">
554  <listitem><para>
555    flavors of UNIX,
556  </para></listitem>
557  <listitem><para>
558    Linux,
559  </para></listitem>
560  <listitem><para>
561    and Windows systems.
562  </para></listitem>
563</itemizedlist>
564</para>
565
566<para>
567In order to link and build the program only two underlying software
568packages are mandatory:
569
570<itemizedlist spacing="compact">
571  <listitem><para>
572    CLHEP (Class Library of High Energy Physics) and the
573  </para></listitem>
574  <listitem><para>
575    STL (Standard Template Library for fundamental classes like C++
576    containers and strings).
577  </para></listitem>
578</itemizedlist>
579</para>
580
581<para>
582The Geant4 source code is available from the
583<ulink url="http://geant4.web.cern.ch/geant4/">
584Geant4 web pages
585</ulink>
586while CLHEP is available from the
587<ulink url="http://proj-clhep.web.cern.ch/proj-clhep/">
588CLHEP Home Page
589</ulink>
590.
591For details on setting up the computing environment see the
592<ulink url="http://geant4.web.cern.ch/geant4/UserDocumentation/UsersGuides/InstallationGuide/html/index.html">
593Installation Guide
594</ulink>
595.
596</para>
597
598</chapter>
Note: See TracBrowser for help on using the repository browser.