mkFit: a repository for vectorized, parallelized charged particle track reconstruction

Outline

Section 1: Test platforms

Section 2: How to checkout the code

Section 3: How to run the code

Section 4: How to make changes to the main development branch

Section 5: The benchmark and validation suite

Section 5.i: Running the main script

Section 5.ii: Some (must read) advice on benchmarking

Section 5.iii: (Optional) Using additional scripts to display plots on the web

Section 5.iv: Interpreting the results

Section 5.iv.a: Benchmark results

Section 5.iv.b: Validation results

Section 5.iv.c: Other plots

Section 6: Submit an issue

Section 7: Condensed description of code

mkFit/mkFit.cc

Section 9.ii.a.b: Phi3

Section 9.ii.b: Set up `mkFit` as an external

Section 9.ii.c: Pull CMSSW code and build

Section 9.iii Recipes for the impatient on phi3

Section 9.iii.a: Offline tracking

Section 9.iii.b HLT tracking (iter0)

Section 9.iv More thorough instructions

Section 9.iv.a: Offline tracking

Section 9.iv.a.a: Customize functions

Section 9.iv.a.b: Timing measurements

Section 9.iv.a.c: Producing MultiTrackValidator plots

Section 9.v: Interpretation of results

Section 9.v.a: MultiTrackValidator plots

Section 9.v.b: Timing

Section 10: Other useful information

Section 10.i: Important Links

Section 10.ii: Tips and Tricks

Section 10.ii.a: Missing Libraries and Debugging

Section 10.ii.b: SSH passwordless login for benchmarking scripts and web scripts

Section 10.iii: Acronyms/Abbreviations: