feat: pre-commit hook to update banks README (#505)

Author: c-dilks

etc/bankdefs/util/dumpBankIDs.rb .github/make_banks_readme.rbetc/bankdefs/util/dumpBankIDs.rb renamed to .github/make_banks_readme.rb

@@ -51,13 +51,8 @@
 # dump a table
 puts """# Bank Group and Item IDs
 
-This file was generated by
-```bash
-#{$0} #{ARGV.join ' '}
-```
-
-> [!IMPORTANT]
-> Please re-run this script if you modify any of the bank definitions.
+> [!NOTE]
+> Iguana banks, which are defined in the Iguana repository, use group number 30000.
 
 """
 

.github/make_banks_readme_precommit.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+.github/make_banks_readme.rb etc/bankdefs/hipo4 > etc/bankdefs/hipo4/README.md

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+- repo: local
+  hooks:
+    - id: make_banks_readme
+      name: make banks readme
+      entry: .github/make_banks_readme_precommit.sh
+      language: script
+      pass_filenames: false

etc/bankdefs/hipo4/README.md

@@ -1,12 +1,7 @@
 # Bank Group and Item IDs
 
-This file was generated by
-```bash
-etc/bankdefs/util/dumpBankIDs.rb etc/bankdefs/hipo4
-```
-
-> [!IMPORTANT]
-> Please re-run this script if you modify any of the bank definitions.
+> [!NOTE]
+> Iguana banks, which are defined in the Iguana repository, use group number 30000.
 
 
 ## Group 40
@@ -381,13 +376,24 @@ etc/bankdefs/util/dumpBankIDs.rb etc/bankdefs/hipo4
 
 | Item ID | Name | Description |
 | --- | --- | --- |
-| 12 | `AHDC::tdc` | TDC bank for the ALERT Wire Chamber |
+| 10 | `AHDC::wf` | Waveform bank for the AHDC |
+| 11 | `AHDC::adc` | ADC bank for the ALERT Wire Chamber |
 
 ## Group 22500
 
 | Item ID | Name | Description |
 | --- | --- | --- |
-| 11 | `ATOF::adc` | ADC bank for the ALERT time-of-flight detector |
+| 12 | `ATOF::tdc` | TDC bank for the ALERT TOF |
+| 21 | `ATOF::hits` | Reconstructed ATOF hits |
+| 22 | `ATOF::clusters` | Clusters in ATOF |
+
+## Group 22600
+
+| Item ID | Name | Description |
+| --- | --- | --- |
+| 21 | `RECOIL::hits` | RECOIL hits |
+| 22 | `RECOIL::clusters` | reconstructed clusters from RECOIL |
+| 23 | `RECOIL::crosses` | reconstructed crosses from RECOIL |
 
 ## Group 23000
 
@@ -399,3 +405,5 @@ etc/bankdefs/util/dumpBankIDs.rb etc/bankdefs/hipo4
 | 24 | `AHDC::PreClusters` | Pre Clusters info |
 | 25 | `AHDC::Clusters` | Clusters info |
 | 26 | `AHDC::KFTrack` | Reco Kalman Filter Tracks |
+| 30 | `AHDC_AI::Prediction` | Prediction given by AI |
+| 31 | `ALERT::Projections` | Track Projections to ATOF |