# travelmapping/edutools architecture

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

- Interactive diagram: https://gitdiagram.com/travelmapping/edutools
- Repository: https://github.com/travelmapping/edutools

## Overview

EduTools is the public portion of METAL: educational tools that use TravelMapping data to create highway-system graphs. Its principal user workflow is to load graph data in the Highway Data Examiner (HDX), inspect it on a map, and step through graph-algorithm visualizations. The tree also contains Java utilities for preparing waypoint data and Python graph generators. The graph groups related algorithm implementations to keep the map readable; unsampled wiring and runtime relationships are omitted rather than inferred.

Main entry points: [`HighwayDataExaminer/index.php`](https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/index.php) (Highway Data Examiner), [`archives/CreateGraphs/LatLng.java`](https://github.com/travelmapping/edutools/blob/master/archives/CreateGraphs/LatLng.java) (Coordinate parsing), [`archives/CreateGraphs/MakeData.java`](https://github.com/travelmapping/edutools/blob/master/archives/CreateGraphs/MakeData.java) (Graph data conversion), [`archives/CreateGraphs/MergeNearMissPoints.java`](https://github.com/travelmapping/edutools/blob/master/archives/CreateGraphs/MergeNearMissPoints.java) (Near-miss point merging)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_examiner["Graph Examiner"]
  node_hdx["Highway Data Examiner<br/>[index.php]"]
  node_loader["Graph data loading<br/>[hdxjsfunc.js]"]
  node_shared["HDX shared logic<br/>[hdxjsfuncs.js]"]
  node_part["Graph partitioning<br/>[hdxpart.js]"]
  node_search["Graph search"]
end

subgraph group_algorithms["Algorithm Learning"]
  node_avcore["Visualization framework<br/>[hdxav.js]"]
  node_vertexav["Vertex searches<br/>[hdxav-vsearch.js]"]
  node_edgeav["Edge searches<br/>[hdxav-esearch.js]"]
  node_spanav["Spanning algorithms"]
  node_traversalav["Traversal algorithms"]
  node_otherav["Other algorithm visualizations"]
end

subgraph group_preparation["Waypoint Preparation"]
  node_makedata["Graph data conversion<br/>[MakeData.java]"]
  node_coordinates["Coordinate parsing<br/>[LatLng.java]"]
  node_merging["Near-miss point merging"]
end

subgraph group_generators["Graph Generation"]
  node_logo["Logo graph generator<br/>[logo.py]"]
  node_rectangle["Rectangular graph generator"]
end

node_user(("Learner or instructor"))
node_tmdata[("TravelMapping data")]

node_user -->|"uses"| node_hdx
node_tmdata -->|"provides data"| node_hdx
node_hdx -->|"loads"| node_loader
node_hdx -->|"loads"| node_shared
node_hdx -->|"loads"| node_part
node_hdx -->|"loads"| node_search
node_hdx -->|"loads"| node_avcore
node_hdx -->|"loads"| node_vertexav
node_hdx -->|"loads"| node_edgeav
node_makedata -->|"uses"| node_coordinates
node_merging -->|"uses"| node_coordinates

click node_hdx "https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/index.php"
click node_loader "https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/1.0/hdxjsfunc.js"
click node_shared "https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxjsfuncs.js"
click node_part "https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxpart.js"
click node_search "https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxgraphsearchbox.js"
click node_avcore "https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxav.js"
click node_vertexav "https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxav-vsearch.js"
click node_edgeav "https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxav-esearch.js"
click node_spanav "https://github.com/travelmapping/edutools/tree/master/HighwayDataExaminer"
click node_traversalav "https://github.com/travelmapping/edutools/tree/master/HighwayDataExaminer"
click node_otherav "https://github.com/travelmapping/edutools/tree/master/HighwayDataExaminer"
click node_makedata "https://github.com/travelmapping/edutools/blob/master/archives/CreateGraphs/MakeData.java"
click node_coordinates "https://github.com/travelmapping/edutools/blob/master/archives/CreateGraphs/LatLng.java"
click node_merging "https://github.com/travelmapping/edutools/blob/master/archives/CreateGraphs/MergeNearMissPoints.java"
click node_logo "https://github.com/travelmapping/edutools/blob/master/LogoGraphGenerator/logo.py"
click node_rectangle "https://github.com/travelmapping/edutools/blob/master/TestGraphGenerator/rectangleofpoints.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_hdx,node_loader,node_shared,node_part,node_search toneBlue
class node_avcore,node_vertexav,node_edgeav,node_spanav,node_traversalav,node_otherav,node_tmdata toneAmber
class node_makedata,node_coordinates,node_merging toneMint
class node_logo,node_rectangle toneRose
class node_user toneIndigo
```

## Components

### Graph Examiner

- [Highway Data Examiner](https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/index.php): `HighwayDataExaminer/index.php`
- [Graph data loading](https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/1.0/hdxjsfunc.js): `HighwayDataExaminer/1.0/hdxjsfunc.js`
- [HDX shared logic](https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxjsfuncs.js): `HighwayDataExaminer/hdxjsfuncs.js`
- [Graph partitioning](https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxpart.js): `HighwayDataExaminer/hdxpart.js`
- [Graph search](https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxgraphsearchbox.js): `HighwayDataExaminer/hdxgraphsearchbox.js`

### Algorithm Learning

- [Visualization framework](https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxav.js): `HighwayDataExaminer/hdxav.js`
- [Vertex searches](https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxav-vsearch.js): `HighwayDataExaminer/hdxav-vsearch.js`
- [Edge searches](https://github.com/travelmapping/edutools/blob/master/HighwayDataExaminer/hdxav-esearch.js): `HighwayDataExaminer/hdxav-esearch.js`
- [Spanning algorithms](https://github.com/travelmapping/edutools/tree/master/HighwayDataExaminer): `HighwayDataExaminer`
- [Traversal algorithms](https://github.com/travelmapping/edutools/tree/master/HighwayDataExaminer): `HighwayDataExaminer`
- [Other algorithm visualizations](https://github.com/travelmapping/edutools/tree/master/HighwayDataExaminer): `HighwayDataExaminer`

### Waypoint Preparation

- [Graph data conversion](https://github.com/travelmapping/edutools/blob/master/archives/CreateGraphs/MakeData.java): `archives/CreateGraphs/MakeData.java`
- [Coordinate parsing](https://github.com/travelmapping/edutools/blob/master/archives/CreateGraphs/LatLng.java): `archives/CreateGraphs/LatLng.java`
- [Near-miss point merging](https://github.com/travelmapping/edutools/blob/master/archives/CreateGraphs/MergeNearMissPoints.java): `archives/CreateGraphs/MergeNearMissPoints.java`

### Graph Generation

- [Logo graph generator](https://github.com/travelmapping/edutools/blob/master/LogoGraphGenerator/logo.py): `LogoGraphGenerator/logo.py`
- [Rectangular graph generator](https://github.com/travelmapping/edutools/blob/master/TestGraphGenerator/rectangleofpoints.py): `TestGraphGenerator/rectangleofpoints.py`

### Other components

- **Learner or instructor**
- **TravelMapping data**

## Connections

- Learner or instructor → Highway Data Examiner: uses
- TravelMapping data → Highway Data Examiner: provides data
- Highway Data Examiner → Graph data loading: loads (evidence: `HighwayDataExaminer/index.php`)
- Highway Data Examiner → HDX shared logic: loads (evidence: `HighwayDataExaminer/index.php`)
- Highway Data Examiner → Graph partitioning: loads (evidence: `HighwayDataExaminer/index.php`)
- Highway Data Examiner → Graph search: loads (evidence: `HighwayDataExaminer/index.php`)
- Highway Data Examiner → Visualization framework: loads (evidence: `HighwayDataExaminer/index.php`)
- Highway Data Examiner → Vertex searches: loads (evidence: `HighwayDataExaminer/index.php`)
- Highway Data Examiner → Edge searches: loads (evidence: `HighwayDataExaminer/index.php`)
- Graph data conversion → Coordinate parsing: uses (evidence: `archives/CreateGraphs/MakeData.java`)
- Near-miss point merging → Coordinate parsing: uses (evidence: `archives/CreateGraphs/MergeNearMissPoints.java`)
