Commit 63e7e767 authored by Valentina Fioretti's avatar Valentina Fioretti
Browse files

documentation update

parent 51fdc2ea
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -2,6 +2,7 @@ The following applications are provided as examples on how to use BoGEMMS-HPC. B
- [ScintillationDetector](https://www.ict.inaf.it/gitlab/icsc_g4_hpc/BoGEMMS-HPC/-/tree/main/examples/ScintillationDetector?ref_type=heads): irradiating with X-ray photons a
scintillation detector, generating optical light in the crystal and collecting the signal with a PMT. 
- [ProtonScattering](https://www.ict.inaf.it/gitlab/icsc_g4_hpc/BoGEMMS-HPC/-/tree/main/examples/ProtonScattering?ref_type=heads): low-energy protons scattering at grazing angles with a sample of the eRosita X-ray mirror
- [GDML](https://www.ict.inaf.it/gitlab/icsc_g4_hpc/BoGEMMS-HPC/-/tree/main/examples/GDML?ref_type=heads): importing GDML models into the Geant4 geometry

<details><summary> ScintillationDetector
</summary>
+2 −2
Original line number Diff line number Diff line
@@ -151,7 +151,7 @@ Multithreading is activated by default, but the user can select how many threads
The `PHYS.VERSION` flag sets the name of the physics class to use in the application:
`PHYS.VERSION = <class_name>` [example: OPTPhys]

Each physics class can include several configuration parameters that are set with the configuration file at runtime. For the user custom physics class, the user decides how to name them. The physics class template provides an example on how to create curstom parameters that use the name of the class. E.g. when setting the physics list using the AREMBESPhys physics class:
Each physics class can include several configuration parameters that are set with the configuration file at runtime. For the user custom physics class, the user decides how to name them. The physics class template provides an example on how to create custom parameters. E.g. when setting the physics list using the AREMBESPhys physics class:

- `PHYS.VERSION = AREMBESPhys`
- `AREMBESPhys.PHYSLIST = emstandardSS_QBBC`
@@ -173,4 +173,4 @@ The user can create custom parameters in the user geometry class to modify param

## Macro file

The file <name>.mac contains the commands to configure the source of primary particle and the number of simulated particles. BoGEMMS-HPC uses the Geant4 General Particle Source and all the commands are described in the Geant4 documentation. The user can find in the provided examples different applications of the Geant4 GPS. If the visualization driver is installed, the macro file allows allows to set the driver and the visualization commands. The GDML reading example generates a VRML output file to visualize the imported volumes.
The file <name>.mac contains the commands to configure the source of primary particle and the number of simulated particles. BoGEMMS-HPC uses the Geant4 General Particle Source and all the commands are described in the Geant4 documentation. The user can find in the provided examples different applications of the Geant4 GPS. If the visualization driver is installed, the macro file allows to set the driver and the visualization commands. The GDML reading example generates a VRML output file to visualize the imported volumes.