Version:
[ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]
1
2 ========================================================
3 GORAD - Geant4 Open-source Radiation Analysis and Design
4 ========================================================
5
6 First release : September 2020 with Geant4 version 10.7
7 Author : Makoto Asai (SLAC National Accelerator Laboratory)
8
9 Introduction
10 ------------
11
12 Gorad (Geant4 Open-sourced Radiation Analysis and Design) is meant to be
13 a turn-key application for radiation analysis and spacecraft design built
14 on top of Geant4. Simulation geometry should be provided in the form of GDML.
15 Gorad is controlled by UI commands, and it works both in interactive mode
16 with Qt window and in batch mode with an input macro file.
17
18 The current Gorad requires Geant4 version 10.7 (release of December 2020).
19 It does not work with earlier version of Geant4. Geant4 has to be installed
20 with multithreading mode and GDML interface enabled. Qt is also recommended
21 for the use of Gorad in interactive mode. Geant4 GDML interface requires
22 Xerces-C++ version 3 or higher. Xerces-C++ has to be compiled with the same
23 compiler Geant4 is compiled. Please refer to the Geant4 installation guide
24 for enabling these options.
25
26 Building and running Gorad
27 --------------------------
28
29 To compile and run Gorad, all the Geant4 environment variables have to be
30 properly set. Use the shell script in the Geant4 installation directory.
31 Compilation of Gorad requires cmake and make same as the compilation of
32 Geant4 itself.
33
34 $ source $G4INSTALL/bin/geant4.(c)sh
35 $ cmake .
36 $ make
37
38 To run Gorad in interactive mode,
39
40 $ ./gorad
41
42 and then, in the keyboard input field, type
43
44 /control/execute <macroFile>
45
46 The user may also use any UI commands shown in the left side menu of the
47 Qt window.
48
49 To run Gorad in batch mode,
50
51 $ ./gorad <macroFIle>
52
53 A sample macro file
54 -------------------
55
56 Associated macro file "run.mac" can be used for both interactive mode
57 and batch mode. It uses a simple cone-shaped geometry (simpleCone.gdml)
58 and King Solar Proton Fluence model (https://doi.org/10.2514/3.62088).
59 It employs both primary particle generation biasing and geometry
60 importance biasing. This sample macro file defines a probe filled by
61 water located at the center of the world volume with dose and flux
62 scorers.
63
64 If this sample macro file is used in interactive mode, it also sets up
65 visualization (through vis.mac). After executing this sample macro, the
66 user can start an event loop with /run/beamOn command.
67
68 If this sample macro file is used in batch mode, it defines 4 histograms.
69 After the event loop, These histograms are dumped to corresponding files
70 and also plotted to a Postscript file. Scores of the dose and flux scorers
71 are also dumped into an output file. In batch mode, this macro executes
72 one million events.
73
74 Gorad manual and additional GDML file
75 -------------------------------------
76
77 Details of the sample macro file and available alternative commands are
78 described in the full manual downloadable from the following URL. Also,
79 additional sample GDML file of partial and simplified Orion Spacecraft
80 is available at the following URL. This is a sample input and it is not
81 mandatory to execute Gorad.
82
83 https://twiki.cern.ch/twiki/bin/view/Geant4/AdvancedExamplesGorad
84
85 Known warning messages while processing a GDML file
86 ---------------------------------------------------
87
88 If the input GDML file uses some material names defined in G4NISTManager,
89 these names are unrecognizable by the GDML perser itself and cause
90 warning messages. For example
91
92 G4GDML: VALIDATION ERROR! ID attribute 'G4_AIR' is referenced but was
93 never declared at line: XX
94
95 These messages are harmless and these materials are properly interpreted
96 once they are set to G4LogicalVolume.
97
98 Acknowledgements
99 ----------------
100
101 Development of Gorad is funded by NASA Johnson Space Center (JSC) under
102 the contract NNJ15HK11B.
103
104
105
106
