# root676/qneat3 architecture

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

- Interactive diagram: https://gitdiagram.com/root676/qneat3
- Repository: https://github.com/root676/qneat3

## Overview

QNEAT3 is a QGIS Processing provider for network-analysis algorithms. A user selects a registered algorithm and supplies network and point inputs; the algorithm computes routes, origin-destination costs, or reachable-area products and writes them to requested outputs. The graph preserves the documented shortest-path, OD-matrix, and isochrone capabilities, including distinct output formats and point/layer variants. Provider registration is directly evidenced; sampled algorithm excerpts show processing inputs and outputs but do not establish calls into the framework or utilities, so those internal relationships are omitted.

Main entry points: [`Qneat3Provider.py`](https://github.com/root676/qneat3/blob/master/Qneat3Provider.py) (Algorithm Provider), [`Qneat3Plugin.py`](https://github.com/root676/qneat3/blob/master/Qneat3Plugin.py) (Plugin Lifecycle), [`algs/ShortestPathBetweenPoints.py`](https://github.com/root676/qneat3/blob/master/algs/ShortestPathBetweenPoints.py) (Point-to-Point Route), [`algs/OdMatrixFromPointsAsCsv.py`](https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromPointsAsCsv.py) (Point OD CSV)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_integration["QGIS Integration"]
  node_plugin["Plugin Lifecycle<br/>[Qneat3Plugin.py]"]
  node_provider["Algorithm Provider<br/>[Qneat3Provider.py]"]
  node_dummy["Dummy Algorithm<br/>[DummyAlgorithm.py]"]
end

subgraph group_routing["Shortest Path"]
  node_shortest["Point-to-Point Route"]
end

subgraph group_od["OD Matrices"]
  node_od_points_csv["Point OD CSV"]
  node_od_points_lines["Point OD Lines"]
  node_od_points_table["Point OD Table"]
  node_od_layers_lines["Layer OD Lines"]
  node_od_layers_table["Layer OD Table"]
end

subgraph group_iso["Iso-Areas"]
  node_iso_pointcloud_point["Point Pointcloud"]
  node_iso_pointcloud_layer["Layer Pointcloud"]
  node_iso_interp_point["Point Interpolation"]
  node_iso_interp_layer["Layer Interpolation"]
  node_iso_contours_point["Point Contours"]
  node_iso_contours_layer["Layer Contours"]
  node_iso_polygons_point["Point Polygons"]
  node_iso_polygons_layer["Layer Polygons"]
  node_iso_qneat["QNEAT Interpolation"]
end

subgraph group_core["Network Core"]
  node_framework["Network Framework<br/>[Qneat3Framework.py]"]
  node_utilities["Utilities<br/>[Qneat3Utilities.py]"]
end

node_qgis(("QGIS Processing"))

node_qgis -->|"initializes"| node_plugin
node_plugin -->|"registers"| node_provider
node_provider -->|"registers"| node_shortest
node_provider -->|"registers"| node_od_points_csv
node_provider -->|"registers"| node_od_points_lines
node_provider -->|"registers"| node_od_points_table
node_provider -->|"registers"| node_od_layers_lines
node_provider -->|"registers"| node_od_layers_table
node_provider -->|"registers"| node_iso_pointcloud_point
node_provider -->|"registers"| node_iso_pointcloud_layer
node_provider -->|"registers"| node_iso_interp_point
node_provider -->|"registers"| node_iso_interp_layer
node_provider -->|"registers"| node_iso_contours_point
node_provider -->|"registers"| node_iso_contours_layer
node_provider -->|"registers"| node_iso_polygons_point
node_provider -->|"registers"| node_iso_polygons_layer

click node_plugin "https://github.com/root676/qneat3/blob/master/Qneat3Plugin.py"
click node_provider "https://github.com/root676/qneat3/blob/master/Qneat3Provider.py"
click node_shortest "https://github.com/root676/qneat3/blob/master/algs/ShortestPathBetweenPoints.py"
click node_od_points_csv "https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromPointsAsCsv.py"
click node_od_points_lines "https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromPointsAsLines.py"
click node_od_points_table "https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromPointsAsTable.py"
click node_od_layers_lines "https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromLayersAsLines.py"
click node_od_layers_table "https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromLayersAsTable.py"
click node_iso_pointcloud_point "https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsPointcloudFromPoint.py"
click node_iso_pointcloud_layer "https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsPointcloudFromLayer.py"
click node_iso_interp_point "https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsInterpolationFromPoint.py"
click node_iso_interp_layer "https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsInterpolationFromLayer.py"
click node_iso_contours_point "https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsContoursFromPoint.py"
click node_iso_contours_layer "https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsContoursFromLayer.py"
click node_iso_polygons_point "https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsPolygonsFromPoint.py"
click node_iso_polygons_layer "https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsPolygonsFromLayer.py"
click node_iso_qneat "https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsQneatInterpolationFromPoint.py"
click node_dummy "https://github.com/root676/qneat3/blob/master/algs/DummyAlgorithm.py"
click node_framework "https://github.com/root676/qneat3/blob/master/Qneat3Framework.py"
click node_utilities "https://github.com/root676/qneat3/blob/master/Qneat3Utilities.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_plugin,node_provider,node_dummy toneBlue
class node_shortest toneAmber
class node_od_points_csv,node_od_points_lines,node_od_points_table,node_od_layers_lines,node_od_layers_table toneMint
class node_iso_pointcloud_point,node_iso_pointcloud_layer,node_iso_interp_point,node_iso_interp_layer,node_iso_contours_point,node_iso_contours_layer,node_iso_polygons_point,node_iso_polygons_layer,node_iso_qneat toneRose
class node_framework,node_utilities,node_qgis toneIndigo
```

## Components

### QGIS Integration

- [Plugin Lifecycle](https://github.com/root676/qneat3/blob/master/Qneat3Plugin.py): `Qneat3Plugin.py`
- [Algorithm Provider](https://github.com/root676/qneat3/blob/master/Qneat3Provider.py): `Qneat3Provider.py`
- [Dummy Algorithm](https://github.com/root676/qneat3/blob/master/algs/DummyAlgorithm.py): `algs/DummyAlgorithm.py`

### Shortest Path

- [Point-to-Point Route](https://github.com/root676/qneat3/blob/master/algs/ShortestPathBetweenPoints.py): `algs/ShortestPathBetweenPoints.py`

### OD Matrices

- [Point OD CSV](https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromPointsAsCsv.py): `algs/OdMatrixFromPointsAsCsv.py`
- [Point OD Lines](https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromPointsAsLines.py): `algs/OdMatrixFromPointsAsLines.py`
- [Point OD Table](https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromPointsAsTable.py): `algs/OdMatrixFromPointsAsTable.py`
- [Layer OD Lines](https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromLayersAsLines.py): `algs/OdMatrixFromLayersAsLines.py`
- [Layer OD Table](https://github.com/root676/qneat3/blob/master/algs/OdMatrixFromLayersAsTable.py): `algs/OdMatrixFromLayersAsTable.py`

### Iso-Areas

- [Point Pointcloud](https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsPointcloudFromPoint.py): `algs/IsoAreaAsPointcloudFromPoint.py`
- [Layer Pointcloud](https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsPointcloudFromLayer.py): `algs/IsoAreaAsPointcloudFromLayer.py`
- [Point Interpolation](https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsInterpolationFromPoint.py): `algs/IsoAreaAsInterpolationFromPoint.py`
- [Layer Interpolation](https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsInterpolationFromLayer.py): `algs/IsoAreaAsInterpolationFromLayer.py`
- [Point Contours](https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsContoursFromPoint.py): `algs/IsoAreaAsContoursFromPoint.py`
- [Layer Contours](https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsContoursFromLayer.py): `algs/IsoAreaAsContoursFromLayer.py`
- [Point Polygons](https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsPolygonsFromPoint.py): `algs/IsoAreaAsPolygonsFromPoint.py`
- [Layer Polygons](https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsPolygonsFromLayer.py): `algs/IsoAreaAsPolygonsFromLayer.py`
- [QNEAT Interpolation](https://github.com/root676/qneat3/blob/master/algs/IsoAreaAsQneatInterpolationFromPoint.py): `algs/IsoAreaAsQneatInterpolationFromPoint.py`

### Network Core

- [Network Framework](https://github.com/root676/qneat3/blob/master/Qneat3Framework.py): `Qneat3Framework.py`
- [Utilities](https://github.com/root676/qneat3/blob/master/Qneat3Utilities.py): `Qneat3Utilities.py`

### Other components

- **QGIS Processing**

## Connections

- QGIS Processing → Plugin Lifecycle: initializes (evidence: `Qneat3Plugin.py`)
- Plugin Lifecycle → Algorithm Provider: registers (evidence: `Qneat3Plugin.py`)
- Algorithm Provider → Point-to-Point Route: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Point OD CSV: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Point OD Lines: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Point OD Table: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Layer OD Lines: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Layer OD Table: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Point Pointcloud: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Layer Pointcloud: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Point Interpolation: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Layer Interpolation: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Point Contours: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Layer Contours: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Point Polygons: registers (evidence: `Qneat3Provider.py`)
- Algorithm Provider → Layer Polygons: registers (evidence: `Qneat3Provider.py`)
