# ffakhry002/integratedreactormodel architecture

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

- Interactive diagram: https://gitdiagram.com/ffakhry002/integratedreactormodel
- Repository: https://github.com/ffakhry002/integratedreactormodel

## Overview

The repository combines an OpenMC reactor-analysis workflow with thermal-hydraulics, depletion and visualization, alongside tools for selecting core configurations and training ML surrogates from reactor results. The main simulation path is documented in the entry point’s references and excerpt; component-level links are included only where the source index, excerpts or README support them. Several substantial subsystems are present in the tree but unsampled, so their internal wiring is not inferred.

Main entry points: [`Integrated Reactor Model/main.py`](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/main.py) (Simulation runner), [`ML/execution/data_handler.py`](https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/execution/data_handler.py) (Training data handler), [`Integrated Reactor Model/eigenvalue/run.py`](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/eigenvalue/run.py) (Eigenvalue solve), [`Integrated Reactor Model/Reactor/materials.py`](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/Reactor/materials.py) (Materials)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_design["Inputs and design"]
  node_inputs_gui["Input editor<br/>[reactor_gui.py]"]
  node_param_gui["Parametric editor"]
  node_input_config["Run configuration<br/>[inputs.py]"]
end

subgraph group_reactor["Reactor simulation"]
  node_run["Simulation runner<br/>[main.py]"]
  node_geometry["Core geometry<br/>[geometry.py]"]
  node_geometry_helpers["Geometry builders"]
  node_materials["Materials<br/>[materials.py]"]
  node_eigenvalue["Eigenvalue solve<br/>[run.py]"]
  node_depletion["Depletion<br/>[run_depletion.py]"]
end

subgraph group_analysis["Analysis and sampling"]
  node_parametric["Parametric study"]
  node_plotting["Results plots<br/>[plotall.py]"]
  node_core_selection["Core configuration sampling"]
end

subgraph group_ml["ML surrogate workflow"]
  node_ml_main["Training entry point<br/>[main.py]"]
  node_ml_data["Result parsing<br/>[txt_to_data.py]"]
  node_ml_handler["Training data handler<br/>[data_handler.py]"]
  node_encoding["Feature encoding"]
  node_restructure["Feature restructuring"]
  node_trainer["Model training<br/>[model_trainer.py]"]
  node_nn_pipeline["Flux layout preparation<br/>[data_pipeline.py]"]
end

subgraph group_thermal["Thermal hydraulics"]
  node_th["Thermal hydraulics<br/>[TH_refactored.py]"]
  node_th_helpers["Thermal models and solvers"]
end

node_engineer(("Reactor analyst"))
node_surrogate_user(("Surrogate consumer"))

node_engineer -->|"edits inputs"| node_inputs_gui
node_inputs_gui -->|"uses defaults"| node_input_config
node_engineer -.->|"configures runs"| node_param_gui
node_run -->|"reads settings"| node_input_config
node_run -->|"builds model"| node_geometry
node_run -->|"runs solve"| node_eigenvalue
node_run -->|"runs depletion"| node_depletion
node_run -->|"runs analyses"| node_th
node_run -->|"generates plots"| node_plotting
node_geometry -->|"delegates builders"| node_geometry_helpers
node_geometry -->|"uses materials"| node_materials
node_eigenvalue -->|"builds materials"| node_materials
node_eigenvalue -->|"builds core"| node_geometry_helpers
node_depletion -->|"uses materials"| node_materials
node_depletion -->|"builds core"| node_geometry_helpers
node_parametric -->|"runs cases"| node_eigenvalue
node_parametric -->|"plots cases"| node_plotting
node_parametric -->|"runs TH analyses"| node_th
node_materials -->|"uses coolant properties"| node_th
node_th -->|"uses solver modules"| node_th_helpers
node_ml_main -->|"parses reactor data"| node_ml_data
node_ml_main -->|"starts trainer"| node_ml_handler
node_ml_handler -->|"loads data"| node_ml_data
node_ml_handler -->|"encodes features"| node_encoding
node_ml_handler -.->|"restructures data"| node_restructure
node_nn_pipeline -->|"pools positions"| node_restructure
node_ml_handler -.->|"supplies training data"| node_trainer
node_trainer -.->|"produces surrogate"| node_surrogate_user

click node_inputs_gui "https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/Inputs_GUI/reactor_gui.py"
click node_param_gui "https://github.com/ffakhry002/integratedreactormodel/tree/main/Integrated%20Reactor%20Model/Parametric_GUI"
click node_input_config "https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/inputs.py"
click node_run "https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/main.py"
click node_geometry "https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/Reactor/geometry.py"
click node_geometry_helpers "https://github.com/ffakhry002/integratedreactormodel/tree/main/Integrated%20Reactor%20Model/Reactor/geometry_helpers"
click node_materials "https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/Reactor/materials.py"
click node_eigenvalue "https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/eigenvalue/run.py"
click node_depletion "https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/depletion/run_depletion.py"
click node_parametric "https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/eigenvalue/parametric_study.py"
click node_plotting "https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/plotting/plotall.py"
click node_core_selection "https://github.com/ffakhry002/integratedreactormodel/tree/main/core_selection"
click node_th "https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/ThermalHydraulics/TH_refactored.py"
click node_th_helpers "https://github.com/ffakhry002/integratedreactormodel/tree/main/Integrated%20Reactor%20Model/ThermalHydraulics/code_architecture/helper_codes"
click node_ml_main "https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/main.py"
click node_ml_data "https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/utils/txt_to_data.py"
click node_ml_handler "https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/execution/data_handler.py"
click node_encoding "https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/ML_models/encodings/encoding_methods.py"
click node_restructure "https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/utils/data_restructure.py"
click node_trainer "https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/execution/model_trainer.py"
click node_nn_pipeline "https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/neural_net_configs/data_pipeline.py"

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_inputs_gui,node_param_gui,node_input_config toneBlue
class node_run,node_geometry,node_geometry_helpers,node_materials,node_eigenvalue,node_depletion toneAmber
class node_parametric,node_plotting,node_core_selection toneMint
class node_ml_main,node_ml_data,node_ml_handler,node_encoding,node_restructure,node_trainer,node_nn_pipeline toneRose
class node_th,node_th_helpers,node_engineer,node_surrogate_user toneIndigo
```

## Components

### Inputs and design

- [Input editor](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/Inputs_GUI/reactor_gui.py): `Integrated Reactor Model/Inputs_GUI/reactor_gui.py`
- [Parametric editor](https://github.com/ffakhry002/integratedreactormodel/tree/main/Integrated%20Reactor%20Model/Parametric_GUI): `Integrated Reactor Model/Parametric_GUI`
- [Run configuration](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/inputs.py): `Integrated Reactor Model/inputs.py`

### Reactor simulation

- [Simulation runner](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/main.py): `Integrated Reactor Model/main.py`
- [Core geometry](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/Reactor/geometry.py): `Integrated Reactor Model/Reactor/geometry.py`
- [Geometry builders](https://github.com/ffakhry002/integratedreactormodel/tree/main/Integrated%20Reactor%20Model/Reactor/geometry_helpers): `Integrated Reactor Model/Reactor/geometry_helpers`
- [Materials](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/Reactor/materials.py): `Integrated Reactor Model/Reactor/materials.py`
- [Eigenvalue solve](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/eigenvalue/run.py): `Integrated Reactor Model/eigenvalue/run.py`
- [Depletion](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/depletion/run_depletion.py): `Integrated Reactor Model/depletion/run_depletion.py`

### Analysis and sampling

- [Parametric study](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/eigenvalue/parametric_study.py): `Integrated Reactor Model/eigenvalue/parametric_study.py`
- [Results plots](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/plotting/plotall.py): `Integrated Reactor Model/plotting/plotall.py`
- [Core configuration sampling](https://github.com/ffakhry002/integratedreactormodel/tree/main/core_selection): `core_selection`

### ML surrogate workflow

- [Training entry point](https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/main.py): `ML/main.py`
- [Result parsing](https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/utils/txt_to_data.py): `ML/utils/txt_to_data.py`
- [Training data handler](https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/execution/data_handler.py): `ML/execution/data_handler.py`
- [Feature encoding](https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/ML_models/encodings/encoding_methods.py): `ML/ML_models/encodings/encoding_methods.py`
- [Feature restructuring](https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/utils/data_restructure.py): `ML/utils/data_restructure.py`
- [Model training](https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/execution/model_trainer.py): `ML/execution/model_trainer.py`
- [Flux layout preparation](https://github.com/ffakhry002/integratedreactormodel/blob/main/ML/neural_net_configs/data_pipeline.py): `ML/neural_net_configs/data_pipeline.py`

### Thermal hydraulics

- [Thermal hydraulics](https://github.com/ffakhry002/integratedreactormodel/blob/main/Integrated%20Reactor%20Model/ThermalHydraulics/TH_refactored.py): `Integrated Reactor Model/ThermalHydraulics/TH_refactored.py`
- [Thermal models and solvers](https://github.com/ffakhry002/integratedreactormodel/tree/main/Integrated%20Reactor%20Model/ThermalHydraulics/code_architecture/helper_codes): `Integrated Reactor Model/ThermalHydraulics/code_architecture/helper_codes`

### Other components

- **Reactor analyst**
- **Surrogate consumer**

## Connections

- Reactor analyst → Input editor: edits inputs
- Input editor → Run configuration: uses defaults (evidence: `Integrated Reactor Model/Inputs_GUI/reactor_gui.py`)
- Reactor analyst → Parametric editor: configures runs
- Simulation runner → Run configuration: reads settings (evidence: `Integrated Reactor Model/main.py`)
- Simulation runner → Core geometry: builds model (evidence: `Integrated Reactor Model/main.py`)
- Simulation runner → Eigenvalue solve: runs solve (evidence: `Integrated Reactor Model/main.py`)
- Simulation runner → Depletion: runs depletion (evidence: `Integrated Reactor Model/main.py`)
- Simulation runner → Thermal hydraulics: runs analyses (evidence: `Integrated Reactor Model/main.py`)
- Simulation runner → Results plots: generates plots (evidence: `Integrated Reactor Model/main.py`)
- Core geometry → Geometry builders: delegates builders (evidence: `Integrated Reactor Model/Reactor/geometry.py`)
- Core geometry → Materials: uses materials (evidence: `Integrated Reactor Model/Reactor/geometry.py`)
- Eigenvalue solve → Materials: builds materials (evidence: `Integrated Reactor Model/eigenvalue/run.py`)
- Eigenvalue solve → Geometry builders: builds core (evidence: `Integrated Reactor Model/eigenvalue/run.py`)
- Depletion → Materials: uses materials (evidence: `Integrated Reactor Model/depletion/run_depletion.py`)
- Depletion → Geometry builders: builds core (evidence: `Integrated Reactor Model/depletion/run_depletion.py`)
- Parametric study → Eigenvalue solve: runs cases (evidence: `Integrated Reactor Model/eigenvalue/parametric_study.py`)
- Parametric study → Results plots: plots cases (evidence: `Integrated Reactor Model/eigenvalue/parametric_study.py`)
- Parametric study → Thermal hydraulics: runs TH analyses (evidence: `Integrated Reactor Model/eigenvalue/parametric_study.py`)
- Materials → Thermal hydraulics: uses coolant properties (evidence: `Integrated Reactor Model/Reactor/materials.py`)
- Thermal hydraulics → Thermal models and solvers: uses solver modules (evidence: `Integrated Reactor Model/ThermalHydraulics/TH_refactored.py`)
- Training entry point → Result parsing: parses reactor data (evidence: `ML/main.py`)
- Training entry point → Training data handler: starts trainer (evidence: `ML/main.py`)
- Training data handler → Result parsing: loads data (evidence: `ML/execution/data_handler.py`)
- Training data handler → Feature encoding: encodes features (evidence: `ML/execution/data_handler.py`)
- Training data handler → Feature restructuring: restructures data
- Flux layout preparation → Feature restructuring: pools positions (evidence: `ML/neural_net_configs/data_pipeline.py`)
- Training data handler → Model training: supplies training data
- Model training → Surrogate consumer: produces surrogate
