# llnl/interpml architecture

> Architecture diagram of the GitHub repository llnl/interpml, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/llnl/interpml
- Repository: https://github.com/llnl/interpml

## Overview

a. Training Flow
- Data generation → Interpolation Engine

b. Validation Flow
- Interpolation → Metrics computation

c. Application Flow
- Airfoil data → Interpolation → Results

##### Key Architectural Elements

- experiments/data_store
- airfoil/data with dimensional subdivisions
- Results storage (airfoil/results)

b. Processing Pipeline (Use flowchart style)
- Batch processing scripts
- To metric computation
- Validation steps

##### Integration Points

- Core interpolation library
- Experimental framework
- Application implementation

b. External dependencies:
- Python environment
- Required libraries (from REQUIREMENTS.txt)

##### Additional Elements

- Component types
- Special symbols

b. Version information:
- Current version (1.0)
- License type (MIT)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core ["Core Interpolation Engine"]
        InterpML["InterpML Package"]:::core
        Interpolants["Interpolation Module"]:::core
        Dedup["Deduplication Module"]:::core
        Version["Version Control"]:::core
        
        InterpML --> Interpolants
        InterpML --> Dedup
        InterpML --> Version
    end

    subgraph Experimental ["Experimental Framework"]
        DataGen["Data Generation"]:::exp
        MetricsComp["Metrics Computation"]:::exp
        BatchProc["Batch Processing"]:::exp
        ResultStore[("Results Storage")]:::storage
        
        DataGen --> MetricsComp
        MetricsComp --> ResultStore
        BatchProc --> DataGen
    end

    subgraph Application ["Application Layer (Airfoil)"]
        direction TB
        AirfoilMain["Airfoil Implementation"]:::app
        
        subgraph DataDims ["Dimensional Data"]
            Dim2["2D Data"]:::data
            Dim4["4D Data"]:::data
            Dim6["6D Data"]:::data
            Dim8["8D Data"]:::data
        end
        
        subgraph Processing ["Processing Pipeline"]
            TestProc["Test Processing"]:::proc
            ValidProc["Validation Processing"]:::proc
            ResultsAnalysis["Results Analysis"]:::proc
        end
        
        DataStore[("Data Storage")]:::storage
        ResultsViz["Visualization"]:::viz
        Validation["Validation"]:::valid
        
        AirfoilMain --> DataDims
        DataDims --> Processing
        Processing --> ResultsViz
        Processing --> Validation
    end

    DataGen --> InterpML
    InterpML --> Processing
    Processing --> ResultStore

    %% Click Events
    click InterpML "https://github.com/LLNL/interpML/tree/main/interpml/"
    click Interpolants "https://github.com/LLNL/interpML/blob/main/interpml/interpolants.py"
    click Dedup "https://github.com/LLNL/interpML/blob/main/interpml/dedup.py"
    click Version "https://github.com/LLNL/interpML/blob/main/interpml/version.py"
    click DataGen "https://github.com/LLNL/interpML/blob/main/experiments/scripts/data_gen.py"
    click MetricsComp "https://github.com/LLNL/interpML/blob/main/experiments/scripts/data_metrics.py"
    click BatchProc "https://github.com/LLNL/interpML/blob/main/experiments/scripts/batch_data_gen.sh"
    click ResultStore "https://github.com/LLNL/interpML/tree/main/experiments/data_store/final_results/"
    click AirfoilMain "https://github.com/LLNL/interpML/tree/main/airfoil/"
    click Dim2 "https://github.com/LLNL/interpML/tree/main/airfoil/data/Dim_2/"
    click Dim4 "https://github.com/LLNL/interpML/tree/main/airfoil/data/Dim_4/"
    click Dim6 "https://github.com/LLNL/interpML/tree/main/airfoil/data/Dim_6/"
    click Dim8 "https://github.com/LLNL/interpML/tree/main/airfoil/data/Dim_8/"
    click TestProc "https://github.com/LLNL/interpML/blob/main/airfoil/run_scripts/af_latent_test_dD.py"
    click ValidProc "https://github.com/LLNL/interpML/blob/main/airfoil/run_scripts/af_latent_valid_dD.py"
    click ResultsAnalysis "https://github.com/LLNL/interpML/blob/main/airfoil/plots/plot_convergence_af_dD.py"
    click ResultsViz "https://github.com/LLNL/interpML/tree/main/airfoil/plots/"
    click Validation "https://github.com/LLNL/interpML/blob/main/airfoil/notebooks/delaunay_validate_and_interp.ipynb"

    %% Styling
    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef exp fill:#2ecc71,stroke:#27ae60,color:white
    classDef app fill:#e74c3c,stroke:#c0392b,color:white
    classDef data fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef proc fill:#9b59b6,stroke:#8e44ad,color:white
    classDef storage fill:#f1c40f,stroke:#f39c12,color:black
    classDef viz fill:#1abc9c,stroke:#16a085,color:white
    classDef valid fill:#e67e22,stroke:#d35400,color:white
```
