# msimoncelli/phono3py-wte architecture

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

- Interactive diagram: https://gitdiagram.com/msimoncelli/phono3py-wte
- Repository: https://github.com/msimoncelli/phono3py-wte

## Overview

phono3py-wte is a plugin that adds Wigner transport-equation conductivity calculations to phono3py. The runtime path is phono3py variant registration, construction of a velocity solver and either an RTA or LBTE conductivity solver, then Wigner conductivity calculations. The velocity solver computes phonon velocity operators and symmetry-averaged quantities; the conductivity solvers use those quantities for population and coherence contributions. The README names no further capabilities, and the graph reflects only relationships visible in the excerpts.

Main entry points: [`src/wte/velocity_solvers.py`](https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/velocity_solvers.py) (Velocity solver), [`src/wte/kappa_solvers.py`](https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/kappa_solvers.py) (WTE RTA solver), [`src/wte/__init__.py`](https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/__init__.py) (WTE registration), [`src/wte/velocity_operator.py`](https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/velocity_operator.py) (Velocity operator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_integration["Plugin integration"]
  node_registration["WTE registration<br/>[__init__.py]"]
end

subgraph group_velocity["Velocity calculation"]
  node_velocity_solver["Velocity solver"]
  node_velocity_operator["Velocity operator"]
end

subgraph group_conductivity["Conductivity solvers"]
  node_rta_solver["WTE RTA solver<br/>[kappa_solvers.py]"]
  node_lbte_solver["WTE LBTE solver<br/>[kappa_solvers.py]"]
end

node_phono3py(("phono3py framework"))

node_registration -->|"registers variant"| node_phono3py
node_phono3py -->|"constructs callback"| node_velocity_solver
node_phono3py -->|"constructs callback"| node_rta_solver
node_phono3py -->|"constructs callback"| node_lbte_solver
node_velocity_solver -->|"computes with"| node_velocity_operator
node_rta_solver -->|"reads operator data"| node_velocity_solver
node_lbte_solver -->|"reads operator data"| node_velocity_solver

click node_registration "https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/__init__.py"
click node_velocity_solver "https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/velocity_solvers.py"
click node_velocity_operator "https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/velocity_operator.py"
click node_rta_solver "https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/kappa_solvers.py"
click node_lbte_solver "https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/kappa_solvers.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_registration toneBlue
class node_velocity_solver,node_velocity_operator toneAmber
class node_rta_solver,node_lbte_solver toneMint
class node_phono3py toneIndigo
```

## Components

### Plugin integration

- [WTE registration](https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/__init__.py): `src/wte/__init__.py`

### Velocity calculation

- [Velocity solver](https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/velocity_solvers.py): `src/wte/velocity_solvers.py`
- [Velocity operator](https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/velocity_operator.py): `src/wte/velocity_operator.py`

### Conductivity solvers

- [WTE RTA solver](https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/kappa_solvers.py): `src/wte/kappa_solvers.py`
- [WTE LBTE solver](https://github.com/msimoncelli/phono3py-wte/blob/main/src/wte/kappa_solvers.py): `src/wte/kappa_solvers.py`

### Other components

- **phono3py framework**

## Connections

- WTE registration → phono3py framework: registers variant (evidence: `src/wte/__init__.py`)
- phono3py framework → Velocity solver: constructs callback
- phono3py framework → WTE RTA solver: constructs callback
- phono3py framework → WTE LBTE solver: constructs callback
- Velocity solver → Velocity operator: computes with (evidence: `src/wte/velocity_solvers.py`)
- WTE RTA solver → Velocity solver: reads operator data (evidence: `src/wte/kappa_solvers.py`)
- WTE LBTE solver → Velocity solver: reads operator data (evidence: `src/wte/kappa_solvers.py`)
