Repository cleanup

README.md

@@ -1,54 +1,37 @@
 # L1Trigger-TrackFindingTracklet
 
-This repository contains various data files that are needed to run the L1 tracking. 
+This repository contains various data files that are needed to run the extended
+L1 tracking that includes displaced (triplet) seeding with the "hourglass"
+φ-sector definition.
 
-*** WIRING ***
+## Wiring and modules descriptions
 
-These contain the detailed wiring of the various modules for the "hourglass" phi sector definition, 
-for either the baseline tracking (wires_hourglass.dat) or the extended tracking that includes displaced 
-(triplet) seeding (wires_hourglassExtended.dat)
+### DAT format
 
-wires_hourglass.dat 
+#### Wiring
 
-wires_hourglassExtended.dat 
+This contains the detailed wiring of the various processing and memory modules:
 
-*** PROCESSING MODULES *** 
+[wires_hourglassExtendedAllCombined.dat](wires_hourglassExtendedAllCombined.dat)
 
-These contain the detailed list of processing modules used for the baseline or extended tracking (e.g. VMRouter, TrackletEngine, TrackletCalculator, ...) 
+#### Processing modules
 
-processingmodules_hourglass.dat
+This contains the detailed list of processing modules (e.g. VMRouter,
+TrackletProcessor, MatchProcessor, …):
 
-processingmodules_hourglassExtended.dat
+[processingmodules_hourglassExtendedAllCombined.dat](processingmodules_hourglassExtendedAllCombined.dat)
 
-*** MEMORY MODULES *** 
+#### Memory modules
 
-These similarly contain the detailed memory modules (e.g. InputLink, AllStubs, FullMatch, TrackletParameters, ...)
+This similarly contains the detailed list of memory modules (e.g. InputLink,
+AllStubs, FullMatch, TrackletParameters, …):
 
-memorymodules_hourglass.dat
+[memorymodules_hourglassExtendedAllCombined.dat](memorymodules_hourglassExtendedAllCombined.dat)
 
-memorymodules_hourglassExtended.dat
+### JSON format
 
-*** LUTs FOR EXTENDED TRACKING *** 
-
-These contain LUTs needed for the extended tracking (that allows specifically reconstructing displaced trajectories). Lines in files correspond to different indices, based on phi coordinate and bend of stubs (for the TrackletEngineDisplaced (table_TED) these are the two stubs considered as candidate stub pair, while for the Triplet Engine (table_TRE) it is one of the stubs from the initial stub pair plus third stub forming candidate triplet). These are created through training on muon gun samples. 
-
-table_TED/ => tables for TrackletEngineDisplaced.
-
-table_TRE/ => tables for TripletEngine.
-
-*** CHI2 FIT ***
-
-This contains track derivatives used for the chi2-based track fitting. 
-
-fitpattern.txt
-
-*** MODULES & CABLING *** 
-
-This contains information about the modules and the links that they are associated with from the DTC.
-
-modules_T5v3_27SP_nonant_tracklet.dat
-
-calcNumDTCLinks.txt
-
-dtclinklayerdisk.dat
+This contains an equivalent description of the detailed wiring of the various
+processing and memory modules in an easier-to-edit JSON file format. In the
+near future, this will replace the DAT files listed above:
 
+[seedWiring.json](seedWiring.json)