Skip to content

Commit fb4cf0c

Browse files
committed
docs: add TOPOLOGY.md
1 parent 6d0a6c0 commit fb4cf0c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

TOPOLOGY.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!-- SPDX-License-Identifier: PMPL-1.0-or-later -->
2+
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
3+
4+
# TOPOLOGY.md — HyperpolymathRegistry
5+
6+
## Purpose
7+
8+
Custom Julia package registry aggregating all hyperpolymath Julia packages. Provides unified package index, dependency resolution, and installation for post-disciplinary research, formal verification, and verified computing libraries.
9+
10+
## Module Map
11+
12+
```
13+
HyperpolymathRegistry/
14+
├── Registries.toml # Registry configuration
15+
├── A/
16+
│ └── ... (packages starting with A)
17+
├── B/
18+
│ └── ... (packages starting with B)
19+
├── ... (alphabetical package directories)
20+
├── README.adoc # Registry documentation
21+
└── LICENSE # PMPL-1.0-or-later
22+
```
23+
24+
## Data Flow
25+
26+
```
27+
[Hyperpolymath Julia Packages] ──► [Registry Index] ──► [Pkg.Registry.add()] ──► [Local Environment]
28+
```
29+
30+
## Key Invariants
31+
32+
- Julia package registry format with standard Registries.toml
33+
- All registered packages use PMPL-1.0-or-later or compatible licenses
34+
- Compatible with standard Julia package manager (Pkg)
35+
- Version resolution follows semantic versioning

0 commit comments

Comments
 (0)