# sundmanbo/opencalphad architecture

> Architecture diagram of the GitHub repository sundmanbo/opencalphad, 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/sundmanbo/opencalphad
- Repository: https://github.com/sundmanbo/opencalphad

## Overview

OpenCalphad is thermodynamic software for multicomponent equilibria, property and phase diagrams, database development, and simulation integration. The main workflow is to provide thermodynamic data and conditions, calculate equilibrium, then inspect thermodynamic and phase-composition results. The README also documents command-line use, OCASI integration, and parallel equilibrium calculations. The excerpts show the Python API calling raw bindings and producing result objects; most Fortran internals are unsampled, so their relationships are shown only as unverified where useful.

Main entry points: [`src/models/gtp3.F90`](https://github.com/sundmanbo/opencalphad/blob/master/src/models/gtp3.F90) (Equilibrium results), [`OCisoCbinding/pyOC/pyOC.py`](https://github.com/sundmanbo/opencalphad/blob/master/OCisoCbinding/pyOC/pyOC.py) (Python API), [`src/minimizer/matsmin.F90`](https://github.com/sundmanbo/opencalphad/blob/master/src/minimizer/matsmin.F90) (Equilibrium minimizer), [`src/pmain1.F90`](https://github.com/sundmanbo/opencalphad/blob/master/src/pmain1.F90) (Command line)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interfaces["User interfaces"]
  node_cli["Command line<br/>[pmain1.F90]"]
  node_python["Python API<br/>[pyOC.py]"]
end

subgraph group_thermo["Thermodynamic calculation"]
  node_database[("Thermodynamic database")]
  node_conditions["Conditions and phases<br/>[gtp3.F90]"]
  node_models["Thermodynamic models<br/>[gtp3.F90]"]
  node_minimizer["Equilibrium minimizer<br/>[matsmin.F90]"]
  node_numerics["Numerical routines<br/>[ocnum.F90]"]
  node_equilibrium["Equilibrium results<br/>[gtp3.F90]"]
  node_properties["Property results<br/>[gtp3.F90]"]
end

subgraph group_analysis["Diagrams and simulation"]
  node_diagrams["Phase diagrams<br/>[smp2.F90]"]
  node_macro["Macro workflows"]
  node_parallel["Parallel calculations<br/>[sim-alnipt.F90]"]
  node_simulation(("Simulation software"))
end

subgraph group_bindings["Integration bindings"]
  node_rawbind["Raw bindings<br/>[liboctq.F90]"]
  node_ocasi["OCASI interface<br/>[liboctqisoc.F90]"]
  node_cppapi["C interface<br/>[octqc.h]"]
end

node_user(("Engineer"))

node_user -.->|"runs calculations"| node_cli
node_user -.->|"uses API"| node_python
node_python -.->|"calls raw API"| node_rawbind
node_cli -.->|"sets conditions"| node_conditions
node_python -.->|"sets conditions"| node_conditions
node_database -.->|"supplies data"| node_models
node_conditions -.->|"requests equilibrium"| node_minimizer
node_minimizer -.->|"evaluates models"| node_models
node_minimizer -.->|"uses routines"| node_numerics
node_minimizer -.->|"produces results"| node_equilibrium
node_models -.->|"calculates properties"| node_properties
node_python -->|"retrieves results"| node_equilibrium
node_cli -.->|"generates diagrams"| node_diagrams
node_macro -.->|"directs calculations"| node_cli
node_simulation -.->|"integrates through"| node_ocasi
node_ocasi -.->|"exposes calculations"| node_equilibrium
node_parallel -.->|"calculates in parallel"| node_equilibrium
node_equilibrium -.->|"supports simulation"| node_simulation

click node_cli "https://github.com/sundmanbo/opencalphad/blob/master/src/pmain1.F90"
click node_python "https://github.com/sundmanbo/opencalphad/blob/master/OCisoCbinding/pyOC/pyOC.py"
click node_rawbind "https://github.com/sundmanbo/opencalphad/blob/master/OCisoCbinding/liboctq.F90"
click node_ocasi "https://github.com/sundmanbo/opencalphad/blob/master/OCisoCbinding/liboctqisoc.F90"
click node_cppapi "https://github.com/sundmanbo/opencalphad/blob/master/OCisoCbinding/octqc.h"
click node_conditions "https://github.com/sundmanbo/opencalphad/blob/master/src/models/gtp3.F90"
click node_models "https://github.com/sundmanbo/opencalphad/blob/master/src/models/gtp3.F90"
click node_minimizer "https://github.com/sundmanbo/opencalphad/blob/master/src/minimizer/matsmin.F90"
click node_numerics "https://github.com/sundmanbo/opencalphad/blob/master/src/numlib/ocnum.F90"
click node_equilibrium "https://github.com/sundmanbo/opencalphad/blob/master/src/models/gtp3.F90"
click node_properties "https://github.com/sundmanbo/opencalphad/blob/master/src/models/gtp3.F90"
click node_diagrams "https://github.com/sundmanbo/opencalphad/blob/master/src/stepmapplot/smp2.F90"
click node_macro "https://github.com/sundmanbo/opencalphad/tree/master/examples/macros"
click node_parallel "https://github.com/sundmanbo/opencalphad/blob/master/examples/TQ4lib/F90/parallel-alnipt/sim-alnipt.F90"

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_cli,node_python toneBlue
class node_database,node_conditions,node_models,node_minimizer,node_numerics,node_equilibrium,node_properties toneAmber
class node_diagrams,node_macro,node_parallel,node_simulation toneMint
class node_rawbind,node_ocasi,node_cppapi toneRose
class node_user toneIndigo
```

## Components

### User interfaces

- [Command line](https://github.com/sundmanbo/opencalphad/blob/master/src/pmain1.F90): `src/pmain1.F90`
- [Python API](https://github.com/sundmanbo/opencalphad/blob/master/OCisoCbinding/pyOC/pyOC.py): `OCisoCbinding/pyOC/pyOC.py`

### Thermodynamic calculation

- **Thermodynamic database**
- [Conditions and phases](https://github.com/sundmanbo/opencalphad/blob/master/src/models/gtp3.F90): `src/models/gtp3.F90`
- [Thermodynamic models](https://github.com/sundmanbo/opencalphad/blob/master/src/models/gtp3.F90): `src/models/gtp3.F90`
- [Equilibrium minimizer](https://github.com/sundmanbo/opencalphad/blob/master/src/minimizer/matsmin.F90): `src/minimizer/matsmin.F90`
- [Numerical routines](https://github.com/sundmanbo/opencalphad/blob/master/src/numlib/ocnum.F90): `src/numlib/ocnum.F90`
- [Equilibrium results](https://github.com/sundmanbo/opencalphad/blob/master/src/models/gtp3.F90): `src/models/gtp3.F90`
- [Property results](https://github.com/sundmanbo/opencalphad/blob/master/src/models/gtp3.F90): `src/models/gtp3.F90`

### Diagrams and simulation

- [Phase diagrams](https://github.com/sundmanbo/opencalphad/blob/master/src/stepmapplot/smp2.F90): `src/stepmapplot/smp2.F90`
- [Macro workflows](https://github.com/sundmanbo/opencalphad/tree/master/examples/macros): `examples/macros`
- [Parallel calculations](https://github.com/sundmanbo/opencalphad/blob/master/examples/TQ4lib/F90/parallel-alnipt/sim-alnipt.F90): `examples/TQ4lib/F90/parallel-alnipt/sim-alnipt.F90`
- **Simulation software**

### Integration bindings

- [Raw bindings](https://github.com/sundmanbo/opencalphad/blob/master/OCisoCbinding/liboctq.F90): `OCisoCbinding/liboctq.F90`
- [OCASI interface](https://github.com/sundmanbo/opencalphad/blob/master/OCisoCbinding/liboctqisoc.F90): `OCisoCbinding/liboctqisoc.F90`
- [C interface](https://github.com/sundmanbo/opencalphad/blob/master/OCisoCbinding/octqc.h): `OCisoCbinding/octqc.h`

### Other components

- **Engineer**

## Connections

- Engineer → Command line: runs calculations (evidence: `README.md`)
- Engineer → Python API: uses API (evidence: `README.md`)
- Python API → Raw bindings: calls raw API
- Command line → Conditions and phases: sets conditions
- Python API → Conditions and phases: sets conditions
- Thermodynamic database → Thermodynamic models: supplies data (evidence: `README.md`)
- Conditions and phases → Equilibrium minimizer: requests equilibrium
- Equilibrium minimizer → Thermodynamic models: evaluates models
- Equilibrium minimizer → Numerical routines: uses routines
- Equilibrium minimizer → Equilibrium results: produces results
- Thermodynamic models → Property results: calculates properties (evidence: `README.md`)
- Python API → Equilibrium results: retrieves results (evidence: `OCisoCbinding/pyOC/pyOC.py`)
- Command line → Phase diagrams: generates diagrams (evidence: `README.md`)
- Macro workflows → Command line: directs calculations
- Simulation software → OCASI interface: integrates through (evidence: `README.md`)
- OCASI interface → Equilibrium results: exposes calculations (evidence: `README.md`)
- Parallel calculations → Equilibrium results: calculates in parallel (evidence: `README.md`)
- Equilibrium results → Simulation software: supports simulation (evidence: `README.md`)
