Merge pull request #2 from Zehvogel/updates

Small clean-up

README.md

@@ -1,36 +1,41 @@
 # FullSim
 
+The main documentation is in the subdirectories.
+
 ## Setup
 
-source key4hep stable
-```
+source either key4hep stable
+
+```sh
 source /cvmfs/sw.hsf.org/key4hep/setup.sh
 ```
-source key4hep nightlies
-```
+
+or source key4hep nightlies
+
+```sh
 source /cvmfs/sw-nightlies.hsf.org/key4hep/setup.sh
 ```
 
-```
+```sh
 git clone https://github.com/key4hep/CLDConfig.git
 
 cd CLDConfig/CLDConfig/
 ```
 
 ## Simulation
 
-```
-ddsim --compactFile $K4GEO/FCCee/CLD/compact/FCCee_o1_v04/FCCee_o1_v04.xml \
+```sh
+ddsim --compactFile $K4GEO/FCCee/CLD/compact/CLD_o2_v06/CLD_o2_v06.xml \
             --inputFiles ee_Zmumu_91.hepmc \
             --numberOfEvents 10000 --steeringFile fcc_steer.py \
             --outputFile Zmumu_91_10000ev_SIM_edm4hep.root
 ```
 
 ### Simulation with ParticleGun
 
-```
-ddsim --compactFile $K4GEO/FCCee/CLD/compact/FCCee_o1_v04/FCCee_o1_v04.xml \
-      --outputFile outputSIM_edm4hep.root \
+```sh
+ddsim --compactFile $K4GEO/FCCee/CLD/compact/CLD_o2_v06/CLD_o2_v06.xml \
+      --outputFile outputSIM.edm4hep.root \
       --steeringFile cld_steer.py \
       --random.seed 0123456789 \
       --enableGun \
@@ -43,19 +48,17 @@ ddsim --compactFile $K4GEO/FCCee/CLD/compact/FCCee_o1_v04/FCCee_o1_v04.xml \
       --numberOfEvents 10000
 ```
 
-
 > **Note**
-> 
-> simulation output file format must be **_edm4hep.root** or **.slcio**
+>
+> simulation output file format must be **.edm4hep.root** or **.slcio**
 
 ## Reconstruction
 
-```
+```sh
 k4run CLDReconstruction.py --inputFiles outputSIM_edm4hep.root \
             --outputBasename outputREC \
             --VXDDigitiserResUV=0.001 \
-            --GeoSvc.detectors=$K4GEO/FCCee/CLD/compact/CLD_o2_v05/CLD_o2_v05.xml \
+            --GeoSvc.detectors=$K4GEO/FCCee/CLD/compact/CLD_o2_v06/CLD_o2_v06.xml \
             --trackingOnly \
             -n 100
 ```
-

TrackingPerformance/Condor/README.md

@@ -1,19 +1,23 @@
-### Running CLD Full Simulation and Reconstruction on Condor
+# Running CLD Full Simulation and Reconstruction on Condor
 
 To execute simulation and reconstruction processes for CLD Full Simulation on Condor, follow these steps. Before running the scripts, ensure to set the desired variables within them according to your requirements.
 
 **Important Note:** The values for **Nevts** (Total Number of Events) and **Nevt_per_job** (Number of Events per Job) should be identical for both Simulation and Reconstruction processes.
 
-##### Run Simulation
+## Run Simulation
+
 Start by running the simulation process. Set the necessary variables within the **condorJobs_sim.py** script.
-```
+
+```sh
 python condorJobs_sim.py
 ```
 
-##### Run Reconstruction
+## Run Reconstruction
+
 After completing the simulation, proceed with the reconstruction process. Similar to the simulation step, ensure that the variables in the **condorJobs_reco.py** script are correctly set.
-```
+
+```sh
 python condorJobs_reco.py
 ```
 
-Make sure to verify the consistency of **Nevts** and **Nevt_per_job* between both scripts. Also, check that each step is completed successfully before moving to the next. If any issues arise, recheck the variable settings in the scripts to ensure they match your simulation and reconstruction needs.
+Make sure to verify the consistency of **Nevts** and **Nevt_per_job* between both scripts. Also, check that each step is completed successfully before moving to the next. If any issues arise, recheck the variable settings in the scripts to ensure they match your simulation and reconstruction needs.

TrackingPerformance/Plotting/README.md

@@ -1,41 +1,41 @@
-### Generating Performance Plots from Fullsim Outputs
+# Generating Performance Plots from Fullsim Outputs
 
 To generate performance plots using the outputs from Fullsim, follow these steps. Ensure that you correctly adjust the paths and variables in the provided scripts as needed.
 
 **Merge Reconstruction Outputs:** Start by merging the output from the reconstruction process. Before running the script, set the necessary variables within it to match your configuration.
 
-```
+```sh
 python mergeRecOutputs.py
 ```
 
 **Produce Root Tree with Desired Variables:** create a root tree with desired variables
 
-```
-fccanalysis run analysis_tracking.py 
+```sh
+fccanalysis run analysis_tracking.py
 ```
 
 **Plot Fitted Distribution and Generate Performance Plot:** plot the fitted distribution for the chosen variables and generate the performance plot
 
-```
-python plots_tracking.py 
+```sh
+python plots_tracking.py
 ```
 
-To generate superimposed plots using the root outputs. Run the ```SuperimposedCanvas.py``` script:
+To generate superimposed plots using the root outputs. Run the `SuperimposedCanvas.py` script:
 
-```
+```sh
 python SuperimposedCanvas.py
 ```
 
-#### Ratio plots
+## Ratio plots
 
-Use ```plots_tracking_sep.py``` instead of ```plots_tracking.py```, to create root outputs for each theta and momentum
+Use `plots_tracking_sep.py` instead of `plots_tracking.py`, to create root outputs for each theta and momentum
 
-```
+```sh
 python plots_tracking_sep.py
 ```
 
-To generate ratio plots using the root outputs. Run the ```SuperimposedCanvas_ratio.py``` script, it will generate ratio plots for each variable (theta and momentum) and for Superimposed plots
+To generate ratio plots using the root outputs. Run the `SuperimposedCanvas_ratio.py` script, it will generate ratio plots for each variable (theta and momentum) and for Superimposed plots
 
-```
+```sh
 python SuperimposedCanvas_ratio.py
 ```