README.md

Running Output Monitor Algorithm (FPGATrackSimOutputMonitorAlg)

0. Clone and build the directory following FPGATrackSim/README.md

From the top-level working directory (FPGATrackSim/ if you followed the build instructions),

1. Source the build

   source build/x86_64-*-gcc62-opt/setup.sh

2. Create a work dir and a run dir

   mkdir workspace
   cd workspace
   mkdir rundir

3. Create an executable file run

   touch run
   chmod +x run

4. Copy the following contents into that file.

   #!/bin/bash
   
   FPGATrackSimLogHitFile='/eos/atlas/atlascerngroupdisk/det-htt/HTTsim/ATLAS-P2-ITK-23-00-01/21.9.15/eta0103phi0305/References/loghits__21.9.15-ATLAS-P2-ITK-23-00-01__EF_TaskForce_dev23__EF_TaskForce_dev23__dev_21-02-15.root'
   
   cd rundir/
   FPGATrackSimOutputMonitorAlg_tf.py \
       --maxEvents 5 \
       --InFileName $FPGATrackSimLogHitFile \

5. Run the script. Note you must have eos mounted for this to work (i.e. lxplus)

   ./run

Running Map Maker Algorithm (FPGATrackSimMapMakerAlg)

The Map Maker algorithm will output a plane map, region map, and subregion map. It will also prodouce a radii file and etapattern file, which can be used with the bit shift implementation of the Hough Transform.

Do the same as above, but run a different transform. If you haven't already set up your working environment then:

0. Clone and build the directory following FPGATrackSim/README.md

From the top-level working directory (FPGATrackSim/ if you followed the build instructions),

1. Source the build

   source build/x86_64-*-gcc62-opt/setup.sh

2. Create a work dir and a run dir

   mkdir workspace
   cd workspace
   mkdir rundir

3. Create an executable file run

   touch run
   chmod +x run

4. Copy the following contents into that file.

#!/bin/bash

FPGATrackSimInputRawHits='/eos/atlas/atlascerngroupdisk/det-htt/HTTsim/ATLAS-P2-RUN4-01-01-00/single_mu.root'
OutputName='MMtest_'

cd rundir/

FPGATrackSimMapMakerAlg_tf.py \
    --maxEvents 1000 \
    --trim 0.1 \
    --region 0 \
    --InFileName $FPGATrackSimInputRawHits \
    --OutFileName $OutputName \
    --KeyString "strip,barrel,2" \
    --nSlices 10 \

5. Run the script. Note you must have eos mounted for this to work (i.e. lxplus)

   ./run

In this example trim 0.1 will result in ignoring modules that are hit by less than 0.1 % of all tracks.

To run with 2D slicing, use the KeyString2 argument to define the second key layer. Layers can be given as a physical layer ("strip,barrel,2") or a logical layer ("plane 0"). Endcap Layers must be specified as positive or negative: "strip,posEndcap,2".

Note that when using 2D slicing the MM will produce maps with a number of slices at the order of nSlices². And always ensure that the input FPGATrackSimRawHit file is compatible with the region argument.