search

cms-L1TK / project_generation_scripts

Python scripts to generate the wiring map of the tracklet pattern recognition & the top-level HDL that calls the HLS modules in the Hybrid Chain.
1 stars 2 forks source link

Improved doc2 #3

Closed tomalin closed 4 years ago

tomalin commented 4 years ago

Improved documentation in README.md and comments in code for WiresLongVM.py

tomalin commented 4 years ago

I should mention that I made two changes to the code itself in WiresLongVM.py . 1) Used separate variable names fp1, fp2, fp3, fp4 for each of the 4 files written instead of a single name fp, to make it easier to identify which file is being accessed. 2) Simplified adding of entries to maps (which happens several times, and each time can be reduced from 9 lines to 2) by using python dictionaries. e.g. https://github.com/cms-tracklet/project_generation_scripts/compare/improvedDoc2#diff-50f4db734f276c1af14759ba271d38abL774 .

pwittich commented 4 years ago

@djcranshaw can you take a look