# lukho37nqose-rgb/curriculumreasoningengine architecture

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

- Interactive diagram: https://gitdiagram.com/lukho37nqose-rgb/curriculumreasoningengine
- Repository: https://github.com/lukho37nqose-rgb/curriculumreasoningengine

## Overview

CRE is a governed curriculum-reasoning product: institution-scoped student evidence and represented curriculum rules enter through UCT or Northstar workflows, are assessed by the shared engine, then projected into the student workspace. Distinct reasoning stages include catalogue/scope selection, recognition, curriculum completion, progression, registration, and graduation/award boundaries. Institution releases supply grading, periods, routing, and provenance; catalogue governance checks package integrity and reproducibility. The README documents product capabilities beyond the sampled excerpts; edges for those broader flows are limited to explicit documentation, and unsampled implementation details are not asserted.

Main entry points: [`engine/rule_engine.py`](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/rule_engine.py) (Reasoning Orchestrator), [`northstar/web.py`](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/northstar/web.py) (Northstar Workflow), [`curriculum_reasoning_engine/institutions/models.py`](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/models.py) (Institution Release), [`app.py`](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/app.py) (UCT Entry API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry and Evidence"]
  node_uct_entry["UCT Entry API<br/>[app.py]"]
  node_northstar_web["Northstar Workflow<br/>[web.py]"]
  node_northstar_identity["Demo Identity<br/>[identity.py]"]
  node_northstar_records["Synthetic Records<br/>[records.py]"]
  node_northstar_adapter["Evidence Adapter<br/>[adapter.py]"]
end

subgraph group_institution["Institution Releases"]
  node_release["Institution Release<br/>[models.py]"]
  node_institution_rules["Institution Frameworks<br/>[achievement.py]"]
  node_periods["Academic Periods<br/>[periods.py]"]
  node_routing["Programme Routing<br/>[routing.py]"]
  node_provenance["Rule Provenance<br/>[provenance.py]"]
end

subgraph group_reasoning["Reasoning Engine"]
  node_catalogue["Catalogue and Scope<br/>[catalogue.py]"]
  node_models["Evidence Models<br/>[models.py]"]
  node_recognition["Recognition<br/>[recognition.py]"]
  node_completion["Completion<br/>[completion.py]"]
  node_curriculum["Curriculum Assessment<br/>[curriculum.py]"]
  node_progression["Progression<br/>[progression.py]"]
  node_registration["Registration<br/>[registration.py]"]
  node_award["Graduation and Award<br/>[graduation.py]"]
  node_rule_engine["Reasoning Orchestrator<br/>[rule_engine.py]"]
end

subgraph group_experience["Student Experience"]
  node_presentation["Advisor Projection<br/>[presentation.py]"]
  node_workspace["Student Workspace"]
end

subgraph group_governance["Catalogue Governance"]
  node_governance["Release Governance<br/>[release_gate.py]"]
  node_integrity["Package Integrity<br/>[integrity.py]"]
  node_reproducibility["Rebuild Checks<br/>[reproducibility.py]"]
end

node_student(("Student"))

node_student -->|"submits evidence"| node_uct_entry
node_uct_entry -->|"selects scope"| node_catalogue
node_uct_entry -->|"requests analysis"| node_rule_engine
node_student -->|"starts session"| node_northstar_web
node_northstar_web -->|"resolves identity"| node_northstar_identity
node_northstar_web -->|"fetches records"| node_northstar_records
node_northstar_web -->|"adapts evidence"| node_northstar_adapter
node_northstar_adapter -->|"creates evidence"| node_models
node_northstar_web -->|"invokes analysis"| node_rule_engine
node_release -->|"provides semantics"| node_institution_rules
node_release -->|"provides periods"| node_periods
node_release -->|"provides resolver"| node_routing
node_release -->|"carries provenance"| node_provenance
node_uct_entry -->|"selects release"| node_release
node_northstar_web -->|"selects release"| node_release
node_rule_engine -->|"evaluates inputs"| node_models
node_rule_engine -->|"assesses catalogue"| node_catalogue
node_rule_engine -->|"evaluates recognition"| node_recognition
node_rule_engine -->|"computes completion"| node_completion
node_rule_engine -->|"assesses curriculum"| node_curriculum
node_rule_engine -->|"assesses progression"| node_progression
node_rule_engine -->|"assesses registration"| node_registration
node_rule_engine -->|"assesses award"| node_award
node_rule_engine -->|"projects results"| node_presentation
node_presentation -->|"feeds workspace"| node_workspace
node_governance -->|"checks package"| node_integrity
node_governance -->|"checks rebuild"| node_reproducibility
node_presentation -->|"discloses sources"| node_provenance

click node_uct_entry "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/app.py"
click node_northstar_web "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/northstar/web.py"
click node_northstar_identity "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/northstar/identity.py"
click node_northstar_records "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/northstar/records.py"
click node_northstar_adapter "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/northstar/adapter.py"
click node_release "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/models.py"
click node_institution_rules "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/achievement.py"
click node_periods "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/periods.py"
click node_routing "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/routing.py"
click node_provenance "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/provenance.py"
click node_catalogue "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/catalogue.py"
click node_models "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/models.py"
click node_recognition "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/recognition.py"
click node_completion "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/completion.py"
click node_curriculum "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/curriculum.py"
click node_progression "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/progression.py"
click node_registration "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/registration.py"
click node_award "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/graduation.py"
click node_rule_engine "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/rule_engine.py"
click node_presentation "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_advisor/presentation.py"
click node_workspace "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/static/student-workspace.js"
click node_governance "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/catalogue_governance/release_gate.py"
click node_integrity "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/catalogue_governance/integrity.py"
click node_reproducibility "https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/catalogue_governance/reproducibility.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_uct_entry,node_northstar_web,node_northstar_identity,node_northstar_records,node_northstar_adapter toneBlue
class node_release,node_institution_rules,node_periods,node_routing,node_provenance toneAmber
class node_catalogue,node_models,node_recognition,node_completion,node_curriculum,node_progression,node_registration,node_award,node_rule_engine toneMint
class node_presentation,node_workspace toneRose
class node_governance,node_integrity,node_reproducibility,node_student toneIndigo
```

## Components

### Entry and Evidence

- [UCT Entry API](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/app.py): `app.py`
- [Northstar Workflow](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/northstar/web.py): `northstar/web.py`
- [Demo Identity](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/northstar/identity.py): `northstar/identity.py`
- [Synthetic Records](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/northstar/records.py): `northstar/records.py`
- [Evidence Adapter](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/northstar/adapter.py): `northstar/adapter.py`

### Institution Releases

- [Institution Release](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/models.py): `curriculum_reasoning_engine/institutions/models.py`
- [Institution Frameworks](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/achievement.py): `curriculum_reasoning_engine/institutions/achievement.py`
- [Academic Periods](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/periods.py): `curriculum_reasoning_engine/institutions/periods.py`
- [Programme Routing](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/routing.py): `curriculum_reasoning_engine/institutions/routing.py`
- [Rule Provenance](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_reasoning_engine/institutions/provenance.py): `curriculum_reasoning_engine/institutions/provenance.py`

### Reasoning Engine

- [Catalogue and Scope](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/catalogue.py): `engine/catalogue.py`
- [Evidence Models](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/models.py): `engine/models.py`
- [Recognition](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/recognition.py): `engine/recognition.py`
- [Completion](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/completion.py): `engine/completion.py`
- [Curriculum Assessment](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/curriculum.py): `engine/curriculum.py`
- [Progression](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/progression.py): `engine/progression.py`
- [Registration](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/registration.py): `engine/registration.py`
- [Graduation and Award](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/graduation.py): `engine/graduation.py`
- [Reasoning Orchestrator](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/engine/rule_engine.py): `engine/rule_engine.py`

### Student Experience

- [Advisor Projection](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/curriculum_advisor/presentation.py): `curriculum_advisor/presentation.py`
- [Student Workspace](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/static/student-workspace.js): `static/student-workspace.js`

### Catalogue Governance

- [Release Governance](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/catalogue_governance/release_gate.py): `catalogue_governance/release_gate.py`
- [Package Integrity](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/catalogue_governance/integrity.py): `catalogue_governance/integrity.py`
- [Rebuild Checks](https://github.com/lukho37nqose-rgb/curriculumreasoningengine/blob/main/catalogue_governance/reproducibility.py): `catalogue_governance/reproducibility.py`

### Other components

- **Student**

## Connections

- Student → UCT Entry API: submits evidence (evidence: `README.md`)
- UCT Entry API → Catalogue and Scope: selects scope (evidence: `app.py`)
- UCT Entry API → Reasoning Orchestrator: requests analysis (evidence: `app.py`)
- Student → Northstar Workflow: starts session (evidence: `README.md`)
- Northstar Workflow → Demo Identity: resolves identity (evidence: `northstar/web.py`)
- Northstar Workflow → Synthetic Records: fetches records (evidence: `northstar/web.py`)
- Northstar Workflow → Evidence Adapter: adapts evidence (evidence: `northstar/web.py`)
- Evidence Adapter → Evidence Models: creates evidence (evidence: `northstar/adapter.py`)
- Northstar Workflow → Reasoning Orchestrator: invokes analysis (evidence: `README.md`)
- Institution Release → Institution Frameworks: provides semantics (evidence: `curriculum_reasoning_engine/institutions/models.py`)
- Institution Release → Academic Periods: provides periods (evidence: `curriculum_reasoning_engine/institutions/models.py`)
- Institution Release → Programme Routing: provides resolver (evidence: `curriculum_reasoning_engine/institutions/models.py`)
- Institution Release → Rule Provenance: carries provenance (evidence: `curriculum_reasoning_engine/institutions/models.py`)
- UCT Entry API → Institution Release: selects release (evidence: `README.md`)
- Northstar Workflow → Institution Release: selects release
- Reasoning Orchestrator → Evidence Models: evaluates inputs (evidence: `engine/rule_engine.py`)
- Reasoning Orchestrator → Catalogue and Scope: assesses catalogue (evidence: `engine/rule_engine.py`)
- Reasoning Orchestrator → Recognition: evaluates recognition (evidence: `engine/rule_engine.py`)
- Reasoning Orchestrator → Completion: computes completion (evidence: `engine/rule_engine.py`)
- Reasoning Orchestrator → Curriculum Assessment: assesses curriculum (evidence: `engine/rule_engine.py`)
- Reasoning Orchestrator → Progression: assesses progression (evidence: `engine/rule_engine.py`)
- Reasoning Orchestrator → Registration: assesses registration (evidence: `engine/rule_engine.py`)
- Reasoning Orchestrator → Graduation and Award: assesses award (evidence: `app.py`)
- Reasoning Orchestrator → Advisor Projection: projects results (evidence: `app.py`)
- Advisor Projection → Student Workspace: feeds workspace (evidence: `README.md`)
- Release Governance → Package Integrity: checks package (evidence: `catalogue_governance/release_gate.py`)
- Release Governance → Rebuild Checks: checks rebuild (evidence: `catalogue_governance/release_gate.py`)
- Advisor Projection → Rule Provenance: discloses sources (evidence: `curriculum_advisor/presentation.py`)
