Integration Guide¶
How to add Invariant to your system.
What you need to integrate¶
Invariant uses a ports and adapters architecture. You implement the ports; the kernel provides the logic.
Required (minimal integration)¶
| Port | Purpose |
|---|---|
CatalogStore |
Provide study/dataset/data product metadata |
Optional (progressive features)¶
| Port | Purpose |
|---|---|
IndicatorEngine |
Recompute indicators from measures |
CrosswalkService |
Map between reference system versions |
SuppressionEngine |
Apply small cell suppression |
AuditLog |
Record validation decisions |
What you can ignore initially¶
Start with CatalogStore only. Add other ports as you need the features they enable.
Recommended order¶
- Minimal Integration — Get validation working
- Query Lifecycle — Understand the full flow
- Catalog — Structure your metadata
- Progressive Features — Add capabilities incrementally
Integration topics¶
| Topic | What it covers |
|---|---|
| Minimal Integration | Smallest working setup |
| Progressive Features | Adding optional capabilities |
| Catalog | Organizing metadata |
| Query Lifecycle | Validate → Acknowledge → Execute → Disclose |
Next steps¶
Start with Minimal Integration to get a working setup, then expand.