Part 1 - the training and fwX BDT generation

Step 0: python and root

Option 1) on lxplus - without any installation

If you are a CERN user this is the easiest option as it does not require to download or install anything. All required software comes nicely bundled from CERN SFT through CVMFS.

ssh user@lxplus.cern.ch
source /cvmfs/sft.cern.ch/lcg/views/LCG_106/x86_64-el9-gcc13-opt/setup.sh

Option 2) on your laptop without access to CVMFS

You need to make sure you have these installed

Convince yourself with

root
python --version
python -c "import numpy"

Step 1: fwX download 

mkdir -p fwxTutorial
cd fwxTutorial
git clone https://gitlab.com/PittHongGroup/fwX.git
export PYTHONPATH=`pwd -P`/fwX:${PYTHONPATH}

Step 2: A Hello World example

A simple running example to generate a toy-BDT, can be found at fwX/examples/bdt/binary/hello_world/hello_world.py

Run the example

mkdir workdir_helloworld
cd workdir_helloworld
python ../fwX/examples/bdt/binary/hello_world/hello_world.py

This generates a number of files in the workdir_helloworld

TMVAOutput.root    # the TMVA training sets, the training evaluation, etc 
dataset/           # the C-code for the trained BDT
fwX-config.json    # the file with the BDT description for fwX synthesis
fwX-testpoints.txt # the file with 5000 fwX testpoints
moons.png          # the visualization of the dataset
roc.png            # the roc-curve

Step 3: The electron-vs-photon example

This example will be used then further in the tutorial, ie. in Parts 2 and 3

Start again from the directory fwxTutorial, and create a workdir. Then download the dataset using get_dataset.py, it will take about 1 minute.

mkdir workdir_egamma
cd workdir_egamma
python ../fwX/examples/datasets/em_calorimeter_shower_images/get_dataset.py

This has created a local file calorimetry.root with the training data. Now run the e-gamma example fwX/examples/bdt/binary/e_gamma_example/e_gamma_example.py

python ../fwX/examples/bdt/binary/e_gamma_example/e_gamma_example.py --data-set calorimetry.root

This will produce files fwX-config.json and fwX-testpoints.txt which will be used in Vivado HLS synthesis and for verification with testbench.