# joaoabcoelho/oscprob architecture

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

- Interactive diagram: https://gitdiagram.com/joaoabcoelho/oscprob
- Repository: https://github.com/joaoabcoelho/oscprob

## Overview

OscProb is a ROOT-integrated C++ library for calculating neutrino oscillation and absorption probabilities. A user configures a model and neutrino path, then requests probabilities or averages; Earth models can supply paths through layered or binned matter. The main propagation family includes standard, iterative, sterile, and new-physics variants, with density-matrix methods for decoherence. The README documents additional model capabilities beyond the sampled excerpts. Relationships among unsampled implementations are shown only where documented or supported by the source index.

Main entry points: [`src/PMNS_Fast.cxx`](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Fast.cxx) (Fast standard model), [`src/PremModel.cxx`](https://github.com/joaoabcoelho/oscprob/blob/master/src/PremModel.cxx) (PREM model), [`src/EarthModelBase.cxx`](https://github.com/joaoabcoelho/oscprob/blob/master/src/EarthModelBase.cxx) (Earth model base), [`src/PMNS_Base.cxx`](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Base.cxx) (Oscillation base)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_earth["Earth paths"]
  node_prem["PREM model<br/>[PremModel.cxx]"]
  node_earthbase["Earth model base<br/>[EarthModelBase.cxx]"]
  node_binned["Binned Earth model"]
  node_nupath["Path segments<br/>[NuPath.h]"]
end

subgraph group_propagation["Oscillation core"]
  node_base["Oscillation base<br/>[PMNS_Base.cxx]"]
  node_maltoni["Maltoni averaging<br/>[PMNS_Maltoni.cxx]"]
  node_fast["Fast standard model<br/>[PMNS_Fast.cxx]"]
  node_avg["Averaged probabilities<br/>[PMNS_Avg.cxx]"]
  node_result["Probability results<br/>[PMNS_Base.h]"]
end

subgraph group_variants["Physics models"]
  node_iter["Iterative model<br/>[PMNS_Iter.cxx]"]
  node_sterile["Sterile model<br/>[PMNS_Sterile.cxx]"]
  node_nsi["Vector NSI<br/>[PMNS_NSI.cxx]"]
  node_snsi["Scalar NSI<br/>[PMNS_SNSI.cxx]"]
  node_deco["Simple decoherence<br/>[PMNS_Deco.cxx]"]
  node_density["Density-matrix base"]
  node_oqs["Open quantum systems<br/>[PMNS_OQS.cxx]"]
  node_liv["Lorentz violation<br/>[PMNS_LIV.cxx]"]
  node_sidereal["Sidereal LIV"]
  node_decay["Neutrino decay<br/>[PMNS_Decay.cxx]"]
  node_nunm["Non-unitary mixing<br/>[PMNS_NUNM.cxx]"]
end

subgraph group_other["Additional calculations"]
  node_absorption["High-energy absorption<br/>[Absorption.cxx]"]
end

node_user(("ROOT / PyROOT user"))

node_user -->|"configures and queries"| node_fast
node_fast -->|"returns probabilities"| node_result
node_user -->|"computes absorption"| node_absorption
node_prem -->|"extends"| node_earthbase
node_binned -->|"extends"| node_earthbase
node_earthbase -->|"stores path segments"| node_nupath
node_prem -->|"builds paths"| node_nupath
node_maltoni -->|"extends"| node_base
node_fast -->|"extends"| node_maltoni
node_fast -->|"accepts Earth model"| node_prem
node_iter -->|"extends"| node_fast
node_sterile -->|"extends"| node_maltoni
node_nsi -->|"extends"| node_fast
node_snsi -->|"extends"| node_nsi
node_density -->|"extends"| node_fast
node_deco -->|"extends"| node_density
node_oqs -->|"extends"| node_density
node_liv -->|"extends"| node_fast
node_sidereal -->|"extends"| node_fast
node_decay -->|"extends"| node_base
node_nunm -->|"extends"| node_fast
node_avg -->|"extends"| node_fast
node_base -->|"computes probabilities"| node_result

click node_prem "https://github.com/joaoabcoelho/oscprob/blob/master/src/PremModel.cxx"
click node_earthbase "https://github.com/joaoabcoelho/oscprob/blob/master/src/EarthModelBase.cxx"
click node_binned "https://github.com/joaoabcoelho/oscprob/blob/master/src/EarthModelBinned.cxx"
click node_nupath "https://github.com/joaoabcoelho/oscprob/blob/master/inc/NuPath.h"
click node_base "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Base.cxx"
click node_maltoni "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Maltoni.cxx"
click node_fast "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Fast.cxx"
click node_iter "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Iter.cxx"
click node_sterile "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Sterile.cxx"
click node_nsi "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_NSI.cxx"
click node_snsi "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_SNSI.cxx"
click node_deco "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Deco.cxx"
click node_density "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_DensityMatrix.cxx"
click node_oqs "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_OQS.cxx"
click node_liv "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_LIV.cxx"
click node_sidereal "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_SiderealLIV.cxx"
click node_decay "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Decay.cxx"
click node_nunm "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_NUNM.cxx"
click node_avg "https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Avg.cxx"
click node_absorption "https://github.com/joaoabcoelho/oscprob/blob/master/src/Absorption.cxx"
click node_result "https://github.com/joaoabcoelho/oscprob/blob/master/inc/PMNS_Base.h"

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_prem,node_earthbase,node_binned,node_nupath,node_user toneBlue
class node_base,node_maltoni,node_fast,node_avg,node_result toneAmber
class node_iter,node_sterile,node_nsi,node_snsi,node_deco,node_density,node_oqs,node_liv,node_sidereal,node_decay,node_nunm toneMint
class node_absorption toneRose
```

## Components

### Earth paths

- [PREM model](https://github.com/joaoabcoelho/oscprob/blob/master/src/PremModel.cxx): `src/PremModel.cxx`
- [Earth model base](https://github.com/joaoabcoelho/oscprob/blob/master/src/EarthModelBase.cxx): `src/EarthModelBase.cxx`
- [Binned Earth model](https://github.com/joaoabcoelho/oscprob/blob/master/src/EarthModelBinned.cxx): `src/EarthModelBinned.cxx`
- [Path segments](https://github.com/joaoabcoelho/oscprob/blob/master/inc/NuPath.h): `inc/NuPath.h`

### Oscillation core

- [Oscillation base](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Base.cxx): `src/PMNS_Base.cxx`
- [Maltoni averaging](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Maltoni.cxx): `src/PMNS_Maltoni.cxx`
- [Fast standard model](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Fast.cxx): `src/PMNS_Fast.cxx`
- [Averaged probabilities](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Avg.cxx): `src/PMNS_Avg.cxx`
- [Probability results](https://github.com/joaoabcoelho/oscprob/blob/master/inc/PMNS_Base.h): `inc/PMNS_Base.h`

### Physics models

- [Iterative model](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Iter.cxx): `src/PMNS_Iter.cxx`
- [Sterile model](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Sterile.cxx): `src/PMNS_Sterile.cxx`
- [Vector NSI](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_NSI.cxx): `src/PMNS_NSI.cxx`
- [Scalar NSI](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_SNSI.cxx): `src/PMNS_SNSI.cxx`
- [Simple decoherence](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Deco.cxx): `src/PMNS_Deco.cxx`
- [Density-matrix base](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_DensityMatrix.cxx): `src/PMNS_DensityMatrix.cxx`
- [Open quantum systems](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_OQS.cxx): `src/PMNS_OQS.cxx`
- [Lorentz violation](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_LIV.cxx): `src/PMNS_LIV.cxx`
- [Sidereal LIV](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_SiderealLIV.cxx): `src/PMNS_SiderealLIV.cxx`
- [Neutrino decay](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_Decay.cxx): `src/PMNS_Decay.cxx`
- [Non-unitary mixing](https://github.com/joaoabcoelho/oscprob/blob/master/src/PMNS_NUNM.cxx): `src/PMNS_NUNM.cxx`

### Additional calculations

- [High-energy absorption](https://github.com/joaoabcoelho/oscprob/blob/master/src/Absorption.cxx): `src/Absorption.cxx`

### Other components

- **ROOT / PyROOT user**

## Connections

- ROOT / PyROOT user → Fast standard model: configures and queries (evidence: `README.md`)
- Fast standard model → Probability results: returns probabilities (evidence: `README.md`)
- ROOT / PyROOT user → High-energy absorption: computes absorption (evidence: `README.md`)
- PREM model → Earth model base: extends
- Binned Earth model → Earth model base: extends
- Earth model base → Path segments: stores path segments
- PREM model → Path segments: builds paths (evidence: `inc/NuPath.h`)
- Maltoni averaging → Oscillation base: extends
- Fast standard model → Maltoni averaging: extends
- Fast standard model → PREM model: accepts Earth model
- Iterative model → Fast standard model: extends
- Sterile model → Maltoni averaging: extends
- Vector NSI → Fast standard model: extends
- Scalar NSI → Vector NSI: extends
- Density-matrix base → Fast standard model: extends
- Simple decoherence → Density-matrix base: extends
- Open quantum systems → Density-matrix base: extends
- Lorentz violation → Fast standard model: extends
- Sidereal LIV → Fast standard model: extends
- Neutrino decay → Oscillation base: extends
- Non-unitary mixing → Fast standard model: extends
- Averaged probabilities → Fast standard model: extends
- Oscillation base → Probability results: computes probabilities (evidence: `inc/PMNS_Base.h`)
