# gridsuite/network-modification architecture

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

- Interactive diagram: https://gitdiagram.com/gridsuite/network-modification
- Repository: https://github.com/gridsuite/network-modification

## Overview

GridSuite Network Modification is a Java library for applying structural, operational, and topological changes to PowSyBl electrical networks. A caller supplies a typed modification request; the library represents it as a DTO, builds an executable modification, applies it to the network, and can report changes or validation errors. The README documents these responsibilities and the broader capabilities; the excerpts show DTO-to-modification conversion, assignment execution, and network mutation details for transformers and operational limits. Other implementation branches are represented at subsystem level because their source was not sampled.

Main entry points: [`src/main/java/org/gridsuite/modification/dto/ModificationInfos.java`](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/dto/ModificationInfos.java) (Modification DTOs), [`src/main/java/org/gridsuite/modification/modifications/AbstractModification.java`](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/modifications/AbstractModification.java) (Modification base), [`src/main/java/org/gridsuite/modification/modifications`](https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/modifications) (Equipment changes), [`src/main/java/org/gridsuite/modification/modifications/byfilter`](https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/modifications/byfilter) (Filter and formula)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_requests["Requests and context"]
  node_request_dtos["Modification DTOs"]
  node_context["Modification context"]
  node_assignment_data["Assignment data"]
end

subgraph group_execution["Modification execution"]
  node_base_modification["Modification base"]
  node_equipment_ops["Equipment changes"]
  node_topology_ops["Topology changes"]
  node_limits_ops["Operational limits"]
  node_filter_ops["Filter and formula"]
  node_tabular_ops["Tabular changes"]
end

subgraph group_support["Shared support"]
  node_modification_utils["Modification utilities"]
  node_exceptions["Modification errors"]
  node_filter_service["Filter service"]
  node_load_flow_service["Load-flow service"]
end

subgraph group_results["Network and reporting"]
  node_network["PowSyBl network"]
  node_reporting["Change reports"]
end

node_caller(("Library caller"))

node_caller -->|"provides request"| node_request_dtos
node_request_dtos -->|"builds executable"| node_base_modification
node_base_modification -->|"specializes into"| node_equipment_ops
node_request_dtos -->|"resolves dependencies"| node_context
node_base_modification -->|"applies changes"| node_network
node_equipment_ops -->|"mutates network"| node_network
node_topology_ops -->|"mutates topology"| node_network
node_limits_ops -->|"updates limits"| node_network
node_filter_ops -->|"applies assignments"| node_network
node_assignment_data -->|"supplies values"| node_filter_ops
node_tabular_ops -->|"mutates network"| node_network
node_equipment_ops -->|"uses helpers"| node_modification_utils
node_equipment_ops -->|"raises errors"| node_exceptions
node_equipment_ops -->|"creates reports"| node_reporting
node_base_modification -.->|"uses integration"| node_filter_service
node_base_modification -.->|"uses integration"| node_load_flow_service
node_request_dtos -->|"supports filter requests"| node_filter_ops
node_request_dtos -->|"supports tabular requests"| node_tabular_ops
node_network -.->|"emits change reports"| node_reporting

click node_request_dtos "https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/dto/ModificationInfos.java"
click node_context "https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/context"
click node_base_modification "https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/modifications/AbstractModification.java"
click node_equipment_ops "https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/modifications"
click node_topology_ops "https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/modifications"
click node_limits_ops "https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/modifications/olg/OperationalLimitsGroupModification.java"
click node_filter_ops "https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/modifications/byfilter"
click node_tabular_ops "https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/modifications/tabular"
click node_assignment_data "https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/modifications/data/assignment/AbstractAssignmentData.java"
click node_modification_utils "https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/utils/ModificationUtils.java"
click node_exceptions "https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/error/NetworkModificationException.java"
click node_reporting "https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/report/NetworkModificationReportResourceBundle.java"
click node_filter_service "https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/IFilterService.java"
click node_load_flow_service "https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/ILoadFlowService.java"

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_request_dtos,node_context,node_assignment_data toneBlue
class node_base_modification,node_equipment_ops,node_topology_ops,node_limits_ops,node_filter_ops,node_tabular_ops toneAmber
class node_modification_utils,node_exceptions,node_filter_service,node_load_flow_service toneMint
class node_network,node_reporting toneRose
class node_caller toneIndigo
```

## Components

### Requests and context

- [Modification DTOs](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/dto/ModificationInfos.java): `src/main/java/org/gridsuite/modification/dto/ModificationInfos.java`
- [Modification context](https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/context): `src/main/java/org/gridsuite/modification/context`
- [Assignment data](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/modifications/data/assignment/AbstractAssignmentData.java): `src/main/java/org/gridsuite/modification/modifications/data/assignment/AbstractAssignmentData.java`

### Modification execution

- [Modification base](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/modifications/AbstractModification.java): `src/main/java/org/gridsuite/modification/modifications/AbstractModification.java`
- [Equipment changes](https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/modifications): `src/main/java/org/gridsuite/modification/modifications`
- [Topology changes](https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/modifications): `src/main/java/org/gridsuite/modification/modifications`
- [Operational limits](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/modifications/olg/OperationalLimitsGroupModification.java): `src/main/java/org/gridsuite/modification/modifications/olg/OperationalLimitsGroupModification.java`
- [Filter and formula](https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/modifications/byfilter): `src/main/java/org/gridsuite/modification/modifications/byfilter`
- [Tabular changes](https://github.com/gridsuite/network-modification/tree/main/src/main/java/org/gridsuite/modification/modifications/tabular): `src/main/java/org/gridsuite/modification/modifications/tabular`

### Shared support

- [Modification utilities](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/utils/ModificationUtils.java): `src/main/java/org/gridsuite/modification/utils/ModificationUtils.java`
- [Modification errors](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/error/NetworkModificationException.java): `src/main/java/org/gridsuite/modification/error/NetworkModificationException.java`
- [Filter service](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/IFilterService.java): `src/main/java/org/gridsuite/modification/IFilterService.java`
- [Load-flow service](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/ILoadFlowService.java): `src/main/java/org/gridsuite/modification/ILoadFlowService.java`

### Network and reporting

- **PowSyBl network**
- [Change reports](https://github.com/gridsuite/network-modification/blob/main/src/main/java/org/gridsuite/modification/report/NetworkModificationReportResourceBundle.java): `src/main/java/org/gridsuite/modification/report/NetworkModificationReportResourceBundle.java`

### Other components

- **Library caller**

## Connections

- Library caller → Modification DTOs: provides request (evidence: `README.md`)
- Modification DTOs → Modification base: builds executable (evidence: `src/main/java/org/gridsuite/modification/dto/ModificationInfos.java`)
- Modification base → Equipment changes: specializes into (evidence: `src/main/java/org/gridsuite/modification/modifications/AbstractModification.java`)
- Modification DTOs → Modification context: resolves dependencies (evidence: `src/main/java/org/gridsuite/modification/dto/ModificationInfos.java`)
- Modification base → PowSyBl network: applies changes (evidence: `README.md`)
- Equipment changes → PowSyBl network: mutates network (evidence: `README.md`)
- Topology changes → PowSyBl network: mutates topology (evidence: `README.md`)
- Operational limits → PowSyBl network: updates limits (evidence: `src/main/java/org/gridsuite/modification/modifications/olg/OperationalLimitsGroupModification.java`)
- Filter and formula → PowSyBl network: applies assignments (evidence: `src/main/java/org/gridsuite/modification/modifications/byfilter/AbstractModificationByAssignment.java`)
- Assignment data → Filter and formula: supplies values (evidence: `src/main/java/org/gridsuite/modification/modifications/byfilter/AbstractModificationByAssignment.java`)
- Tabular changes → PowSyBl network: mutates network (evidence: `README.md`)
- Equipment changes → Modification utilities: uses helpers (evidence: `src/main/java/org/gridsuite/modification/modifications/TwoWindingsTransformerModification.java`)
- Equipment changes → Modification errors: raises errors (evidence: `src/main/java/org/gridsuite/modification/modifications/TwoWindingsTransformerModification.java`)
- Equipment changes → Change reports: creates reports (evidence: `src/main/java/org/gridsuite/modification/modifications/TwoWindingsTransformerModification.java`)
- Modification base → Filter service: uses integration (evidence: `src/main/java/org/gridsuite/modification/modifications/AbstractModification.java`)
- Modification base → Load-flow service: uses integration (evidence: `src/main/java/org/gridsuite/modification/modifications/AbstractModification.java`)
- Modification DTOs → Filter and formula: supports filter requests (evidence: `README.md`)
- Modification DTOs → Tabular changes: supports tabular requests (evidence: `README.md`)
- PowSyBl network → Change reports: emits change reports
