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