Skip to content

Commit

Permalink
Remove obsolete Track Quality code (cms-L1TK#257)
Browse files Browse the repository at this point in the history
* Delete TrackQuality directory

* Update README.md
  • Loading branch information
Chriisbrown authored Feb 20, 2023
1 parent 8180b0a commit 4cd4c3b
Show file tree
Hide file tree
Showing 11 changed files with 0 additions and 1,727 deletions.
28 changes: 0 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,34 +29,6 @@ This would create a project directory \<project> ("projrouter" in case of the ab
5) `make Work/Work.runs/synth_1` (runs synthesis, writes utilization & timing reports to current directory).
6) `make Work/Work.runs/impl_1` (runs implementation, writes utilization & timing reports to current directory). N.B. This step is optional, and not required for code validation.

## Track Quality Specific Instructions
In the TrackQuality directory first run:

setupEnv.sh environment.yml Install


This will install a miniconda python environment under the Install dir within the TrackQuality dir (or manually install the packages listed in environment.yml if you have an existing conda install)

Then run:

source env.sh

to setup the python environment

To first download the testbench .dat files and the python saved model and then generate the track quality HLS from a python saved model format run:

run_TQ_coniferconversion.sh


Once run this will generate the 2 HLS files for the track quality firmware (BDT.h and parameters.h) and a reference datafile that will be compared with the csim output. To run the track quality csim, synth etc.. :

vivado_hls -f script_TQ.tcl

Which generates the project folder trackquality

Note on .dat testbench files:
These testbench files will be generated by the CMSSW emulation. Two files are created, one hls_feature.dat used by conifer to run its own predictions and one hls_hex.dat that contains full 96-bit tttrack_trackwords for the track quality HLS to predict on. This CMSSW emulation relies on changes to the TTTrack_trackword dataformat and as such is currently not part of the cms-L1TK CMSSW fork. A development version of CMSSW to generate the test files is found here: https://github.com/Chriisbrown/cmssw/tree/cbrown-TrackQualityMemfiles

## Format of emData/ files.

### .dat files (test bench input/output data)
Expand Down
145 changes: 0 additions & 145 deletions TrackQuality/BDT.h

This file was deleted.

Loading

0 comments on commit 4cd4c3b

Please sign in to comment.