Skip to content

Commit 6ee41fd

Browse files
authored
Update documentation with new configuration parameters
1 parent 2bed690 commit 6ee41fd

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

docs/configuration.md

+18-13
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,21 @@ There are other parameters that tune the functionality of the simulation,
2525
but the parameters listed here are directly related to how the physics
2626
of the simulation is done.
2727

28-
Parameter | Required | Location | Description
29-
---------------------|----------|-----------------------|-------------
30-
A' Mass | Yes | G4APrime | Mass of dark photon in MeV
31-
MG/ME Data | Yes | g4db::G4DarkBreMModel | Library of dark brem events
32-
Use Muons | Yes | g4db::G4DarkBreMModel | Choice to dark brem off muons or electrons
33-
Minimum DB Threshold | No | g4db::G4DarkBreMModel | Minimum energy in GeV lepton needs to have to DB (default twice A' mass)
34-
Mixing Strength | No | g4db::G4DarkBreMModel | Mixing strength between dark photon and SM photon (default 1.0)
35-
Scaling Method | No | g4db::G4DarkBreMModel | Choice of how to scale the outgoing kinematics from the library (default ForwardOnly)
36-
Xsec Method | No | g4db::G4DarkBreMModel | Choice of WW approximation variant to calculate the total cross section. Options include Full, Improved, HyperImproved, and Auto (default is Auto where Full is used if the A' to lepton mass ratio is below the max and Improved is used otherwise)
37-
Maximum mass ratio | No | g4db::G4DarkBreMModel | If using Auto Xsec Method, the maximum ratio of A' to lepton mass to transition from Full WW to Improved WW (default 50.0)
38-
A' LHE ID | No | g4db::G4DarkBreMModel | If MG/ME Data is in the form of LHE files, the PDG ID of the A' inside of those files (default 622)
39-
Only One per Event | No | G4DarkBremsstrahlung | Limit the dark brem process to only one interaction per event (default false)
40-
Global Bias | No | G4DarkBremsstrahlung | Bias the dark brem process everywhere by this factor (default 1.0)
28+
Parameter | Required | Location | Description
29+
----------------------|----------|-----------------------|-------------
30+
A' Mass | Yes | G4APrime | Mass of dark photon in MeV
31+
A' tau | No | G4APrime | Proper lifetime of dark photon in seconds, only relevant if decay mode is set to GeantDecay (default -1, meaning no decay)
32+
Decay Mode | No | G4APrime | Choice of whether to allow the A' to decay and the decay distribution. The only decay channel is e+/e- (default NoDecay)
33+
MG/ME Data | Yes | g4db::G4DarkBreMModel | Library of dark brem events
34+
Use Muons | Yes | g4db::G4DarkBreMModel | Choice to dark brem off muons or electrons
35+
Minimum DB Threshold | No | g4db::G4DarkBreMModel | Minimum energy in GeV lepton needs to have to DB (default twice A' mass)
36+
Mixing Strength | No | g4db::G4DarkBreMModel | Mixing strength between dark photon and SM photon (default 1.0)
37+
Scaling Method | No | g4db::G4DarkBreMModel | Choice of how to scale the outgoing kinematics from the library (default ForwardOnly)
38+
Xsec Method | No | g4db::G4DarkBreMModel | Choice of WW approximation variant to calculate the total cross section. Options include Full, Improved, HyperImproved, and Auto (default is Auto where Full is used if the A' to lepton mass ratio is below the max and Improved is used otherwise)
39+
Maximum mass ratio | No | g4db::G4DarkBreMModel | If using Auto Xsec Method, the maximum ratio of A' to lepton mass to transition from Full WW to Improved WW (default 50.0)
40+
A' LHE ID | No | g4db::G4DarkBreMModel | If MG/ME Data is in the form of LHE files, the PDG ID of the A' inside of those files (default 622)
41+
Scale A' | No | g4db::G4DarkBreMModel | Whether to scale the outgoing dark photon energy along with the recoil lepton (default false, meaning the dark photon will conserve total momentum while ignoring the nuclear recoil)
42+
Min A' decay distance | No | g4db::G4DarkBreMModel | When A' decay mode is set to FlatDecay, this is the minimum lab-frame distance in mm the A' will travel before decaying (default 0)
43+
Max A' decay distance | No | g4db::G4DarkBreMModel | When A' decay mode is set to FlatDecay, this is the maximum lab-frame distance in mm the A' will travel before decaying (default 1)
44+
Only One per Event | No | G4DarkBremsstrahlung | Limit the dark brem process to only one interaction per event (default false)
45+
Global Bias | No | G4DarkBremsstrahlung | Bias the dark brem process everywhere by this factor (default 1.0)

0 commit comments

Comments
 (0)