# inet-framework/inet architecture

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

## Overview

INET is a communication-network simulation framework for OMNeT++/OMNEST. Users define a topology and parameters, select simulation configurations, run tasks (optionally building first or distributing work to a cluster), then inspect results such as plots. The README documents this workflow and the framework’s wired/wireless, physical-layer, and application models. The graph groups those model domains with the sampled Python simulation tooling and a representative power-storage/visualization subsystem. Source excerpts are limited, so unshown implementation links are omitted rather than inferred.

Main entry points: [`python/inet/main.py`](https://github.com/inet-framework/inet/blob/master/python/inet/main.py) (INET command line), [`src`](https://github.com/inet-framework/inet/tree/master/src) (Topology models), [`python/inet/simulation/task.py`](https://github.com/inet-framework/inet/blob/master/python/inet/simulation/task.py) (Simulation tasks), [`python/inet/simulation/project.py`](https://github.com/inet-framework/inet/blob/master/python/inet/simulation/project.py) (Project management)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Simulation workflow"]
  node_topology["Topology models"]
  node_configuration["Simulation configuration<br/>[config.py]"]
  node_cli["INET command line<br/>[main.py]"]
  node_project["Project management<br/>[project.py]"]
  node_build["Simulation build<br/>[build.py]"]
  node_tasks["Simulation tasks<br/>[task.py]"]
  node_results["Result plotting<br/>[plot.py]"]
end

subgraph group_models["Network models"]
  node_protocols["Protocol models"]
  node_applications["Application models"]
  node_physical["Physical layer"]
end

subgraph group_runtime["Simulation runtime"]
  node_execution["OMNeT++ execution<br/>[subprocess.py]"]
  node_cluster["Cluster execution<br/>[cluster.py]"]
end

subgraph group_power["Power and visualization"]
  node_energy["Energy storage"]
  node_energy_contract["Storage contracts<br/>[IEpEnergyStorage.h]"]
  node_visualizer["Storage visualization"]
  node_canvas["Canvas display"]
  node_osg["3D display"]
end

node_author(("Simulation author"))

node_author -->|"defines topology"| node_topology
node_author -->|"sets parameters"| node_configuration
node_configuration -.->|"selects runs"| node_cli
node_cli -->|"selects project"| node_project
node_cli -->|"starts tasks"| node_tasks
node_tasks -->|"uses project config"| node_project
node_tasks -->|"builds before run"| node_build
node_tasks -.->|"runs simulation"| node_execution
node_cli -->|"starts cluster"| node_cluster
node_project -->|"copies distribution"| node_cluster
node_author -->|"runs simulation"| node_cli
node_execution -.->|"produces results"| node_results
node_author -.->|"inspects results"| node_results
node_topology -.->|"uses models"| node_protocols
node_topology -.->|"uses models"| node_applications
node_topology -.->|"uses models"| node_physical
node_energy -->|"implements contract"| node_energy_contract
node_visualizer -->|"reads capacity"| node_energy_contract
node_canvas -->|"extends base"| node_visualizer
node_osg -->|"extends base"| node_visualizer

click node_topology "https://github.com/inet-framework/inet/tree/master/src"
click node_configuration "https://github.com/inet-framework/inet/blob/master/python/inet/simulation/config.py"
click node_cli "https://github.com/inet-framework/inet/blob/master/python/inet/main.py"
click node_project "https://github.com/inet-framework/inet/blob/master/python/inet/simulation/project.py"
click node_build "https://github.com/inet-framework/inet/blob/master/python/inet/simulation/build.py"
click node_tasks "https://github.com/inet-framework/inet/blob/master/python/inet/simulation/task.py"
click node_execution "https://github.com/inet-framework/inet/blob/master/python/inet/simulation/subprocess.py"
click node_cluster "https://github.com/inet-framework/inet/blob/master/python/inet/common/cluster.py"
click node_results "https://github.com/inet-framework/inet/blob/master/python/inet/scave/plot.py"
click node_protocols "https://github.com/inet-framework/inet/tree/master/src/inet"
click node_applications "https://github.com/inet-framework/inet/tree/master/src/inet/applications"
click node_physical "https://github.com/inet-framework/inet/tree/master/src/inet/physicallayer"
click node_energy "https://github.com/inet-framework/inet/blob/master/src/inet/power/storage/SimpleEpEnergyStorage.cc"
click node_energy_contract "https://github.com/inet-framework/inet/blob/master/src/inet/power/contract/IEpEnergyStorage.h"
click node_visualizer "https://github.com/inet-framework/inet/blob/master/src/inet/visualizer/base/EnergyStorageVisualizerBase.cc"
click node_canvas "https://github.com/inet-framework/inet/blob/master/src/inet/visualizer/canvas/power/EnergyStorageCanvasVisualizer.cc"
click node_osg "https://github.com/inet-framework/inet/blob/master/src/inet/visualizer/osg/power/EnergyStorageOsgVisualizer.cc"

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_topology,node_configuration,node_cli,node_project,node_build,node_tasks,node_results toneBlue
class node_protocols,node_applications,node_physical toneAmber
class node_execution,node_cluster toneMint
class node_energy,node_energy_contract,node_visualizer,node_canvas,node_osg toneRose
class node_author toneIndigo
```

## Components

### Simulation workflow

- [Topology models](https://github.com/inet-framework/inet/tree/master/src): `src`
- [Simulation configuration](https://github.com/inet-framework/inet/blob/master/python/inet/simulation/config.py): `python/inet/simulation/config.py`
- [INET command line](https://github.com/inet-framework/inet/blob/master/python/inet/main.py): `python/inet/main.py`
- [Project management](https://github.com/inet-framework/inet/blob/master/python/inet/simulation/project.py): `python/inet/simulation/project.py`
- [Simulation build](https://github.com/inet-framework/inet/blob/master/python/inet/simulation/build.py): `python/inet/simulation/build.py`
- [Simulation tasks](https://github.com/inet-framework/inet/blob/master/python/inet/simulation/task.py): `python/inet/simulation/task.py`
- [Result plotting](https://github.com/inet-framework/inet/blob/master/python/inet/scave/plot.py): `python/inet/scave/plot.py`

### Network models

- [Protocol models](https://github.com/inet-framework/inet/tree/master/src/inet): `src/inet`
- [Application models](https://github.com/inet-framework/inet/tree/master/src/inet/applications): `src/inet/applications`
- [Physical layer](https://github.com/inet-framework/inet/tree/master/src/inet/physicallayer): `src/inet/physicallayer`

### Simulation runtime

- [OMNeT++ execution](https://github.com/inet-framework/inet/blob/master/python/inet/simulation/subprocess.py): `python/inet/simulation/subprocess.py`
- [Cluster execution](https://github.com/inet-framework/inet/blob/master/python/inet/common/cluster.py): `python/inet/common/cluster.py`

### Power and visualization

- [Energy storage](https://github.com/inet-framework/inet/blob/master/src/inet/power/storage/SimpleEpEnergyStorage.cc): `src/inet/power/storage/SimpleEpEnergyStorage.cc`
- [Storage contracts](https://github.com/inet-framework/inet/blob/master/src/inet/power/contract/IEpEnergyStorage.h): `src/inet/power/contract/IEpEnergyStorage.h`
- [Storage visualization](https://github.com/inet-framework/inet/blob/master/src/inet/visualizer/base/EnergyStorageVisualizerBase.cc): `src/inet/visualizer/base/EnergyStorageVisualizerBase.cc`
- [Canvas display](https://github.com/inet-framework/inet/blob/master/src/inet/visualizer/canvas/power/EnergyStorageCanvasVisualizer.cc): `src/inet/visualizer/canvas/power/EnergyStorageCanvasVisualizer.cc`
- [3D display](https://github.com/inet-framework/inet/blob/master/src/inet/visualizer/osg/power/EnergyStorageOsgVisualizer.cc): `src/inet/visualizer/osg/power/EnergyStorageOsgVisualizer.cc`

### Other components

- **Simulation author**

## Connections

- Simulation author → Topology models: defines topology
- Simulation author → Simulation configuration: sets parameters
- Simulation configuration → INET command line: selects runs
- INET command line → Project management: selects project (evidence: `python/inet/main.py`)
- INET command line → Simulation tasks: starts tasks (evidence: `python/inet/main.py`)
- Simulation tasks → Project management: uses project config (evidence: `python/inet/simulation/task.py`)
- Simulation tasks → Simulation build: builds before run (evidence: `python/inet/simulation/task.py`)
- Simulation tasks → OMNeT++ execution: runs simulation (evidence: `python/inet/simulation/task.py`)
- INET command line → Cluster execution: starts cluster (evidence: `python/inet/main.py`)
- Project management → Cluster execution: copies distribution (evidence: `python/inet/simulation/project.py`)
- Simulation author → INET command line: runs simulation
- OMNeT++ execution → Result plotting: produces results
- Simulation author → Result plotting: inspects results
- Topology models → Protocol models: uses models (evidence: `src/inet/power/storage/SimpleEpEnergyStorage.cc`)
- Topology models → Application models: uses models
- Topology models → Physical layer: uses models
- Energy storage → Storage contracts: implements contract
- Storage visualization → Storage contracts: reads capacity (evidence: `src/inet/visualizer/base/EnergyStorageVisualizerBase.cc`)
- Canvas display → Storage visualization: extends base
- 3D display → Storage visualization: extends base
