# powergridmodel/power-grid-model-ds architecture

> Architecture diagram of the GitHub repository powergridmodel/power-grid-model-ds, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/powergridmodel/power-grid-model-ds
- Repository: https://github.com/powergridmodel/power-grid-model-ds

## Overview

Power Grid Model DS is a Python modeling and simulation layer for power networks, extending the Power Grid Model calculation core. Users build or generate a Grid of typed NumPy-backed arrays, then inspect or mutate its topology, analyze it through graph algorithms, and explore it in the visualizer. The graph preserves the modeling, graph, mutation, generation, and visualization branches documented by the README. Some subsystems were not sampled; their links are shown only where the README or source index supports them.

Main entry points: [`src/power_grid_model_ds/_core/model/grids/base.py`](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/grids/base.py) (Grid), [`src/power_grid_model_ds/_core/visualizer/app.py`](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/visualizer/app.py) (Dash Application), [`src/power_grid_model_ds/arrays.py`](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/arrays.py) (Typed Arrays), [`src/power_grid_model_ds/_core/model/containers/base.py`](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/containers/base.py) (Array Container)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_model["Grid Model"]
  node_grid["Grid<br/>[base.py]"]
  node_arrays["Typed Arrays<br/>[arrays.py]"]
  node_fancyarray["FancyArray<br/>[array.py]"]
  node_container["Array Container<br/>[base.py]"]
  node_dtypes["Network Dtypes"]
end

subgraph group_analysis["Topology &amp; Analysis"]
  node_graphcontainer["Graph Container<br/>[container.py]"]
  node_graphmodel["Graph Models<br/>[base.py]"]
  node_rustworkx["Rustworkx Backend<br/>[rustworkx.py]"]
  node_gridsearch["Grid Search<br/>[_search.py]"]
end

subgraph group_simulation["Simulation &amp; I/O"]
  node_generator["Grid Generators<br/>[grid_generators.py]"]
  node_gridmutation["Grid Mutations<br/>[_modify.py]"]
  node_serialization["Grid Serialization<br/>[json.py]"]
  node_pgminterface["Calculation Interface"]
end

subgraph group_visualization["Grid Visualization"]
  node_vizentry["Visualizer API<br/>[visualizer.py]"]
  node_vizapp["Dash Application<br/>[app.py]"]
  node_vizparser["Element Parsing<br/>[parsers.py]"]
  node_vizlayout["Graph Layout<br/>[layout_config.py]"]
  node_vizstyle["Graph Styling"]
end

node_user(("Python User"))

node_user -->|"builds network"| node_grid
node_user -->|"generates grid"| node_generator
node_grid -->|"extends"| node_container
node_container -->|"stores arrays"| node_fancyarray
node_arrays -->|"extends"| node_fancyarray
node_arrays -->|"uses records"| node_dtypes
node_generator -->|"creates grid"| node_grid
node_grid -->|"owns graphs"| node_graphcontainer
node_graphcontainer -->|"selects model"| node_graphmodel
node_graphmodel -->|"implements backend"| node_rustworkx
node_grid -->|"delegates search"| node_gridsearch
node_grid -->|"delegates mutation"| node_gridmutation
node_grid -->|"serializes"| node_serialization
node_user -.->|"requests calculation"| node_pgminterface
node_grid -->|"provides model data"| node_pgminterface
node_user -->|"opens visualization"| node_vizentry
node_vizentry -->|"launches"| node_vizapp
node_vizapp -->|"reads network"| node_grid
node_vizapp -->|"parses elements"| node_vizparser
node_vizapp -->|"gets layout"| node_vizlayout
node_vizapp -->|"loads stylesheet"| node_vizstyle

click node_grid "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/grids/base.py"
click node_arrays "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/arrays.py"
click node_fancyarray "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/arrays/base/array.py"
click node_container "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/containers/base.py"
click node_dtypes "https://github.com/powergridmodel/power-grid-model-ds/tree/main/src/power_grid_model_ds/_core/model/dtypes"
click node_generator "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/data_source/generator/grid_generators.py"
click node_graphcontainer "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/graphs/container.py"
click node_graphmodel "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/graphs/models/base.py"
click node_rustworkx "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/graphs/models/rustworkx.py"
click node_gridsearch "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/grids/_search.py"
click node_gridmutation "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/grids/_modify.py"
click node_serialization "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/grids/serialization/json.py"
click node_pgminterface "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/power_grid_model_interface.py"
click node_vizentry "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/visualizer.py"
click node_vizapp "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/visualizer/app.py"
click node_vizparser "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/visualizer/parsers.py"
click node_vizlayout "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/visualizer/layout/layout_config.py"
click node_vizstyle "https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/visualizer/layout/cytoscape_styling.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_grid,node_arrays,node_fancyarray,node_container,node_dtypes,node_user toneBlue
class node_graphcontainer,node_graphmodel,node_rustworkx,node_gridsearch toneAmber
class node_generator,node_gridmutation,node_serialization,node_pgminterface toneMint
class node_vizentry,node_vizapp,node_vizparser,node_vizlayout,node_vizstyle toneRose
```

## Components

### Grid Model

- [Grid](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/grids/base.py): `src/power_grid_model_ds/_core/model/grids/base.py`
- [Typed Arrays](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/arrays.py): `src/power_grid_model_ds/arrays.py`
- [FancyArray](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/arrays/base/array.py): `src/power_grid_model_ds/_core/model/arrays/base/array.py`
- [Array Container](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/containers/base.py): `src/power_grid_model_ds/_core/model/containers/base.py`
- [Network Dtypes](https://github.com/powergridmodel/power-grid-model-ds/tree/main/src/power_grid_model_ds/_core/model/dtypes): `src/power_grid_model_ds/_core/model/dtypes`

### Topology & Analysis

- [Graph Container](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/graphs/container.py): `src/power_grid_model_ds/_core/model/graphs/container.py`
- [Graph Models](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/graphs/models/base.py): `src/power_grid_model_ds/_core/model/graphs/models/base.py`
- [Rustworkx Backend](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/graphs/models/rustworkx.py): `src/power_grid_model_ds/_core/model/graphs/models/rustworkx.py`
- [Grid Search](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/grids/_search.py): `src/power_grid_model_ds/_core/model/grids/_search.py`

### Simulation & I/O

- [Grid Generators](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/data_source/generator/grid_generators.py): `src/power_grid_model_ds/_core/data_source/generator/grid_generators.py`
- [Grid Mutations](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/grids/_modify.py): `src/power_grid_model_ds/_core/model/grids/_modify.py`
- [Grid Serialization](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/model/grids/serialization/json.py): `src/power_grid_model_ds/_core/model/grids/serialization/json.py`
- [Calculation Interface](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/power_grid_model_interface.py): `src/power_grid_model_ds/_core/power_grid_model_interface.py`

### Grid Visualization

- [Visualizer API](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/visualizer.py): `src/power_grid_model_ds/visualizer.py`
- [Dash Application](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/visualizer/app.py): `src/power_grid_model_ds/_core/visualizer/app.py`
- [Element Parsing](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/visualizer/parsers.py): `src/power_grid_model_ds/_core/visualizer/parsers.py`
- [Graph Layout](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/visualizer/layout/layout_config.py): `src/power_grid_model_ds/_core/visualizer/layout/layout_config.py`
- [Graph Styling](https://github.com/powergridmodel/power-grid-model-ds/blob/main/src/power_grid_model_ds/_core/visualizer/layout/cytoscape_styling.py): `src/power_grid_model_ds/_core/visualizer/layout/cytoscape_styling.py`

### Other components

- **Python User**

## Connections

- Python User → Grid: builds network (evidence: `README.md`)
- Python User → Grid Generators: generates grid (evidence: `README.md`)
- Grid → Array Container: extends (evidence: `src/power_grid_model_ds/_core/model/grids/base.py`)
- Array Container → FancyArray: stores arrays (evidence: `src/power_grid_model_ds/_core/model/containers/base.py`)
- Typed Arrays → FancyArray: extends (evidence: `src/power_grid_model_ds/arrays.py`)
- Typed Arrays → Network Dtypes: uses records (evidence: `src/power_grid_model_ds/arrays.py`)
- Grid Generators → Grid: creates grid (evidence: `src/power_grid_model_ds/_core/data_source/generator/grid_generators.py`)
- Grid → Graph Container: owns graphs (evidence: `src/power_grid_model_ds/_core/model/grids/base.py`)
- Graph Container → Graph Models: selects model (evidence: `src/power_grid_model_ds/_core/model/graphs/container.py`)
- Graph Models → Rustworkx Backend: implements backend (evidence: `src/power_grid_model_ds/_core/model/graphs/models/rustworkx.py`)
- Grid → Grid Search: delegates search (evidence: `src/power_grid_model_ds/_core/model/grids/base.py`)
- Grid → Grid Mutations: delegates mutation (evidence: `src/power_grid_model_ds/_core/model/grids/base.py`)
- Grid → Grid Serialization: serializes (evidence: `src/power_grid_model_ds/_core/model/grids/base.py`)
- Python User → Calculation Interface: requests calculation
- Grid → Calculation Interface: provides model data (evidence: `src/power_grid_model_ds/_core/power_grid_model_interface.py`)
- Python User → Visualizer API: opens visualization (evidence: `README.md`)
- Visualizer API → Dash Application: launches (evidence: `src/power_grid_model_ds/visualizer.py`)
- Dash Application → Grid: reads network (evidence: `src/power_grid_model_ds/_core/visualizer/app.py`)
- Dash Application → Element Parsing: parses elements (evidence: `src/power_grid_model_ds/_core/visualizer/app.py`)
- Dash Application → Graph Layout: gets layout (evidence: `src/power_grid_model_ds/_core/visualizer/app.py`)
- Dash Application → Graph Styling: loads stylesheet (evidence: `src/power_grid_model_ds/_core/visualizer/app.py`)
