# jeffersonlab/sbs-replay architecture

> Architecture diagram of the GitHub repository jeffersonlab/sbs-replay, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jeffersonlab/sbs-replay
- Repository: https://github.com/jeffersonlab/sbs-replay

## Overview

SBS-replay is a toolkit for replaying SBS detector data and analyzing or calibrating the resulting ROOT data. The principal workflow is replay configuration of the analyzer, followed by detector-specific post-processing and analysis; calibration and plotting are separate analysis branches rather than a single pipeline. The repository also includes a crate-map conversion utility and HCal control and event-display interfaces. Relationships among sampled modules are cited where visible; broader subsystem capabilities and the replay-to-analysis handoff follow the README, since most scripts were not sampled.

Main entry points: [`replay`](https://github.com/jeffersonlab/sbs-replay/tree/master/replay) (Replay configurations), [`DB/make_sbssim_cratemap.py`](https://github.com/jeffersonlab/sbs-replay/blob/master/DB/make_sbssim_cratemap.py) (Crate-map conversion), [`scripts/hodo/TOFcal_consolidated.C`](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/hodo/TOFcal_consolidated.C) (Hodoscope timing), [`scripts/ecal/ECAL_HCAL_calib_parsed_output.C`](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/ecal/ECAL_HCAL_calib_parsed_output.C) (ECAL-HCAL calibration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_replay["Data replay"]
  node_replay_scripts["Replay configurations"]
  node_crate_map["Crate-map conversion"]
end

subgraph group_calibration["Detector calibration"]
  node_hodo_calib["Hodoscope timing"]
  node_hodo_tree["Hodoscope tree reader<br/>[gmn_tree.C]"]
  node_ecal_calib["ECAL-HCAL calibration"]
  node_ecal_tree["Parsed GEP tree<br/>[gep_tree_parsed.C]"]
  node_gem_calib["GEM calibration"]
  node_hcal_calib["HCAL calibration"]
  node_bbcal_calib["BBCal calibration"]
end

subgraph group_analysis["Physics analysis"]
  node_beam_analysis["Beam analysis"]
  node_optics_fit["BigBite optics fit"]
  node_optics_tree["Optics tree reader<br/>[gmn_tree.C]"]
  node_np_uniformity["HCAL N/P uniformity"]
  node_elastic_tree["Elastic tree reader<br/>[gmn_elastic_tree.C]"]
  node_ecal_profiles["ECAL shower profiles"]
  node_qa_plots["BBCal quality plots"]
  node_online_plots["Online monitoring plots"]
  node_overlay["Histogram overlays<br/>[overlay.C]"]
end

subgraph group_operations["Detector operations"]
  node_hcal_gui["HCal control and display"]
  node_grinch_display["GRINCH monitoring"]
end

node_operator(("Analyst"))
node_rawdata["CODA data"]
node_analyzer["Hall A analyzer"]
node_root_output["ROOT output"]

node_operator -->|"selects run"| node_replay_scripts
node_rawdata -->|"provides events"| node_analyzer
node_replay_scripts -->|"configures and runs"| node_analyzer
node_analyzer -->|"writes results"| node_root_output
node_operator -.->|"runs conversion"| node_crate_map
node_crate_map -->|"reads crate map"| node_rawdata
node_root_output -->|"provides input"| node_hodo_calib
node_hodo_calib -->|"uses reader"| node_hodo_tree
node_root_output -->|"provides input"| node_ecal_calib
node_ecal_calib -->|"uses reader"| node_ecal_tree
node_root_output -->|"provides input"| node_gem_calib
node_root_output -->|"provides input"| node_hcal_calib
node_root_output -->|"provides input"| node_bbcal_calib
node_root_output -->|"provides input"| node_beam_analysis
node_root_output -->|"provides input"| node_optics_fit
node_optics_fit -->|"uses reader"| node_optics_tree
node_root_output -->|"provides input"| node_np_uniformity
node_np_uniformity -->|"uses reader"| node_elastic_tree
node_root_output -->|"provides input"| node_ecal_profiles
node_root_output -->|"provides input"| node_qa_plots
node_root_output -->|"provides input"| node_online_plots
node_online_plots -->|"calls overlay"| node_overlay
node_operator -.->|"uses interface"| node_hcal_gui
node_operator -.->|"runs monitoring"| node_grinch_display

click node_replay_scripts "https://github.com/jeffersonlab/sbs-replay/tree/master/replay"
click node_crate_map "https://github.com/jeffersonlab/sbs-replay/blob/master/DB/make_sbssim_cratemap.py"
click node_hodo_calib "https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/hodo/TOFcal_consolidated.C"
click node_hodo_tree "https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/hodo/gmn_tree.C"
click node_ecal_calib "https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/ecal/ECAL_HCAL_calib_parsed_output.C"
click node_ecal_tree "https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/ecal/gep_tree_parsed.C"
click node_gem_calib "https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/gems"
click node_hcal_calib "https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/hcal"
click node_bbcal_calib "https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/bbcal"
click node_beam_analysis "https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/beam"
click node_optics_fit "https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/optics/Optics_BigBite_automatic.C"
click node_optics_tree "https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/optics/gmn_tree.C"
click node_np_uniformity "https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/misc/HCAL_np_ratio_uniformity.C"
click node_elastic_tree "https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/misc/gmn_elastic_tree.C"
click node_ecal_profiles "https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/ecal/ECAL_shower_profiles.C"
click node_qa_plots "https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/qa/qualityA_plots_BBCAL.C"
click node_online_plots "https://github.com/jeffersonlab/sbs-replay/tree/master/onlineGUIconfig/scripts"
click node_overlay "https://github.com/jeffersonlab/sbs-replay/blob/master/onlineGUIconfig/scripts/overlay.C"
click node_hcal_gui "https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/hcal/GUI"
click node_grinch_display "https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/grinch"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_replay_scripts,node_crate_map toneBlue
class node_hodo_calib,node_hodo_tree,node_ecal_calib,node_ecal_tree,node_gem_calib,node_hcal_calib,node_bbcal_calib toneAmber
class node_beam_analysis,node_optics_fit,node_optics_tree,node_np_uniformity,node_elastic_tree,node_ecal_profiles,node_qa_plots,node_online_plots,node_overlay toneMint
class node_hcal_gui,node_grinch_display toneRose
class node_operator,node_rawdata,node_analyzer,node_root_output toneIndigo
```

## Components

### Data replay

- [Replay configurations](https://github.com/jeffersonlab/sbs-replay/tree/master/replay): `replay`
- [Crate-map conversion](https://github.com/jeffersonlab/sbs-replay/blob/master/DB/make_sbssim_cratemap.py): `DB/make_sbssim_cratemap.py`

### Detector calibration

- [Hodoscope timing](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/hodo/TOFcal_consolidated.C): `scripts/hodo/TOFcal_consolidated.C`
- [Hodoscope tree reader](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/hodo/gmn_tree.C): `scripts/hodo/gmn_tree.C`
- [ECAL-HCAL calibration](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/ecal/ECAL_HCAL_calib_parsed_output.C): `scripts/ecal/ECAL_HCAL_calib_parsed_output.C`
- [Parsed GEP tree](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/ecal/gep_tree_parsed.C): `scripts/ecal/gep_tree_parsed.C`
- [GEM calibration](https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/gems): `scripts/gems`
- [HCAL calibration](https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/hcal): `scripts/hcal`
- [BBCal calibration](https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/bbcal): `scripts/bbcal`

### Physics analysis

- [Beam analysis](https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/beam): `scripts/beam`
- [BigBite optics fit](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/optics/Optics_BigBite_automatic.C): `scripts/optics/Optics_BigBite_automatic.C`
- [Optics tree reader](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/optics/gmn_tree.C): `scripts/optics/gmn_tree.C`
- [HCAL N/P uniformity](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/misc/HCAL_np_ratio_uniformity.C): `scripts/misc/HCAL_np_ratio_uniformity.C`
- [Elastic tree reader](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/misc/gmn_elastic_tree.C): `scripts/misc/gmn_elastic_tree.C`
- [ECAL shower profiles](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/ecal/ECAL_shower_profiles.C): `scripts/ecal/ECAL_shower_profiles.C`
- [BBCal quality plots](https://github.com/jeffersonlab/sbs-replay/blob/master/scripts/qa/qualityA_plots_BBCAL.C): `scripts/qa/qualityA_plots_BBCAL.C`
- [Online monitoring plots](https://github.com/jeffersonlab/sbs-replay/tree/master/onlineGUIconfig/scripts): `onlineGUIconfig/scripts`
- [Histogram overlays](https://github.com/jeffersonlab/sbs-replay/blob/master/onlineGUIconfig/scripts/overlay.C): `onlineGUIconfig/scripts/overlay.C`

### Detector operations

- [HCal control and display](https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/hcal/GUI): `scripts/hcal/GUI`
- [GRINCH monitoring](https://github.com/jeffersonlab/sbs-replay/tree/master/scripts/grinch): `scripts/grinch`

### Other components

- **Analyst**
- **CODA data**
- **Hall A analyzer**
- **ROOT output**

## Connections

- Analyst → Replay configurations: selects run
- CODA data → Hall A analyzer: provides events
- Replay configurations → Hall A analyzer: configures and runs
- Hall A analyzer → ROOT output: writes results
- Analyst → Crate-map conversion: runs conversion
- Crate-map conversion → CODA data: reads crate map (evidence: `DB/make_sbssim_cratemap.py`)
- ROOT output → Hodoscope timing: provides input
- Hodoscope timing → Hodoscope tree reader: uses reader (evidence: `scripts/hodo/TOFcal_consolidated.C`)
- ROOT output → ECAL-HCAL calibration: provides input
- ECAL-HCAL calibration → Parsed GEP tree: uses reader (evidence: `scripts/ecal/ECAL_HCAL_calib_parsed_output.C`)
- ROOT output → GEM calibration: provides input
- ROOT output → HCAL calibration: provides input
- ROOT output → BBCal calibration: provides input
- ROOT output → Beam analysis: provides input
- ROOT output → BigBite optics fit: provides input
- BigBite optics fit → Optics tree reader: uses reader (evidence: `scripts/optics/Optics_BigBite_automatic.C`)
- ROOT output → HCAL N/P uniformity: provides input
- HCAL N/P uniformity → Elastic tree reader: uses reader (evidence: `scripts/misc/HCAL_np_ratio_uniformity.C`)
- ROOT output → ECAL shower profiles: provides input
- ROOT output → BBCal quality plots: provides input
- ROOT output → Online monitoring plots: provides input
- Online monitoring plots → Histogram overlays: calls overlay (evidence: `onlineGUIconfig/scripts/bbcal_corr_plots.C`)
- Analyst → HCal control and display: uses interface
- Analyst → GRINCH monitoring: runs monitoring
