From db34beccc6fc059eb9b70a7281b8805f9f4203b0 Mon Sep 17 00:00:00 2001
From: Raees Khan <rak177@pitt.edu>
Date: Mon, 7 Nov 2022 10:42:21 -0500
Subject: [PATCH] Updates to FSL documentation

---
 documentation/docs/fullsimlight/fsl/index.md | 67 ++++++++++++++++++--
 1 file changed, 62 insertions(+), 5 deletions(-)

diff --git a/documentation/docs/fullsimlight/fsl/index.md b/documentation/docs/fullsimlight/fsl/index.md
index 6694bf6ba..b833b12d0 100644
--- a/documentation/docs/fullsimlight/fsl/index.md
+++ b/documentation/docs/fullsimlight/fsl/index.md
@@ -36,6 +36,7 @@ The main tab allows configuration of the following parameters.
 - Physics List
 - Number of Threads
 - Number of Events
+- G4UI Verbosity Commands
 
 It also contains the view button which shows the current configuration on the main display. The user can also run FullSimLight in the main display at any time with the current configuration by clicking on the FullSimLight button in the main tab. fsl provides similar buttons to run gmex and gmclash once a geometry input has been selected through the interface.
 
@@ -45,51 +46,107 @@ It also contains the view button which shows the current configuration on the ma
 
 {{ imgutils_image_caption('fsl-gen.png', 
    alt='fsl', 
-   cap='fsl main tab',
+   cap='fsl generator tab',
    width ='700px',
    urlFix=False) 
 }}
 
+The generator tab shown above contains a list of event generators that can be selected for event generation. The options provided are
+
+- Particle Gun
+- Pythia
+- HepMC3 File
+- Generator Plugin
+
+### 1. Particle Gun
+
+To use a particle gun, the user must specify the particle type and momentum vector.
+
+### 2. Pythia
+
+To use Pythia one can select one of the pre-customized options which are
+
+- ttbar
+- higgs
+- minbias
+
+Alternatively one can also provide a custom file. 
+
+### 3. HepMC3 File
+
+HepMC3 files containing events can be used in FullSimLight in the both the standard Asciiv3 format (introduced in HepMC3) as well as the old Ascii format (used in HepMC and HepMC2).
+
+### 4. Generator Plugin
+
+In order to generate events one can also specify a plugin. Visit the Plugin Support page for more details.
 
 ## Magnetic Field Tab
 
 
 {{ imgutils_image_caption('fsl-mag.png', 
    alt='fsl', 
-   cap='fsl main tab',
+   cap='fsl magnetic field tab',
    width ='700px',
    urlFix=False) 
 }}
 
+To set a Magnetic Field, there are two options
+
+- Fixed Axial
+- MAgnetic Field Plugin
+
+
+### 1. Fixed Axial
+
+Sets a constant Magnetic field in the z-direction at the specified magnitude. 
+
+### 2. Magnetic Field Plugin
+
+In order to generate a Magnetic Field one can also specify a plugin. Visit the Plugin Support page for more details. A custom ATLAS Magnetic Field Plugin comes with the GeoModel package ready to use. This is automatically contained in the atlas-conf.json configuration file provided by GeoModel. ***Warning: This Plugin requires the ATLAS Magnetic Field Map to be installed in a standard location. This Map is available to all ATLAS users on request.***
+
 
 ## Regions Tab
 
 
 {{ imgutils_image_caption('fsl-reg.png', 
    alt='fsl', 
-   cap='fsl main tab',
+   cap='fsl regions tab',
    width ='700px',
    urlFix=False) 
 }}
 
+Regions can be added through the regions tab in FSL as shown above. For each region one must specify 
+
+- Region name
+- Root Logical Volumes
+- Electron cut (GeV)
+- Proton cut (GeV)
+- Positron cut (GeV)
+- Gamma cut (GeV)
+
+A list of ATLAS specific regions comes in the atlas-conf.json condfiguration file provided by GeoModel.
 
 ## Sensitive Detectors Tab
 
 
 {{ imgutils_image_caption('fsl-sen.png', 
    alt='fsl', 
-   cap='fsl main tab',
+   cap='fsl sensitive detector tab',
    width ='700px',
    urlFix=False) 
 }}
 
+In order to add Sensitive Detectors one can create plugins which can then be added to the simulation through the menu shown above. Visit the Plugin Support page for more details.
+
 
 ## User Actions Tab
 
 
 {{ imgutils_image_caption('fsl-user.png', 
    alt='fsl', 
-   cap='fsl main tab',
+   cap='fsl user action tab',
    width ='700px',
    urlFix=False) 
 }}
+
+In order to add User Actions one can create plugins which can then be added to the simulation through the menu shown above. Visit the Plugin Support page for more details.
-- 
GitLab