# nasa-sw-vnv/fret architecture

> Architecture diagram of the GitHub repository nasa-sw-vnv/fret, 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/nasa-sw-vnv/fret
- Repository: https://github.com/nasa-sw-vnv/fret

## Overview

FRET is a desktop tool for authoring restricted-English requirements, formalizing their meaning, organizing them in projects, and analyzing them. The principal workflow runs from the Electron application through requirement parsing and semantic generation into the project model and local databases; model operations also support import, export, realizability analysis, and test generation. The repository includes an LTL trace simulator as a distinct product capability. Edges reflect README statements or relationships listed in the SOURCE INDEX; unsampled UI wiring is not inferred.

Main entry points: [`fret-electron/model/FretModel.js`](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/FretModel.js) (Project model), [`fret-electron/model/realizabilitySupport/realizabilityUtils.js`](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/realizabilitySupport/realizabilityUtils.js) (Realizability workflow), [`tools/LTLSIM/ltlsim-core/classes/LTLSimController.js`](https://github.com/nasa-sw-vnv/fret/blob/master/tools/LTLSIM/ltlsim-core/classes/LTLSimController.js) (Trace controller), [`fret-electron/app/parser/FretSemantics.js`](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/parser/FretSemantics.js) (Formalization service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Desktop application"]
  node_electron["Electron main<br/>[main.dev.js]"]
  node_routes["Application routes<br/>[routes.js]"]
  node_home["Home workspace<br/>[Home.js]"]
  node_ui["Requirement interface<br/>[MainView.js]"]
end

subgraph group_formalize["Requirement formalization"]
  node_grammar["Requirement grammar"]
  node_semantics["Semantic formalizer"]
  node_fretsem["Formalization service<br/>[FretSemantics.js]"]
end

subgraph group_project["Project and persistence"]
  node_model["Project model<br/>[FretModel.js]"]
  node_db[("Project databases<br/>[fretDB.js]")]
  node_getters["Requirement queries"]
  node_mapping["Variable mapping"]
  node_import["Requirement import"]
end

subgraph group_analysis["Analysis and generation"]
  node_realizability["Realizability workflow"]
  node_diagnosis["Conflict diagnosis<br/>[DiagnosisEngine.js]"]
  node_check["Realizability checker"]
  node_testgen["Test generation<br/>[testGenUtils.js]"]
  node_export["R2U2 export<br/>[r2u2Export.js]"]
end

subgraph group_simulator["Trace simulation"]
  node_simui["Simulator interface<br/>[MainView.js]"]
  node_simcontroller["Trace controller"]
  node_simparser["Trace formula parser<br/>[LTLParser.js]"]
  node_simmodel["Trace model<br/>[LTLSimModel.js]"]
end

node_user(("Requirement author"))

node_user -->|"authors requirements"| node_ui
node_electron -->|"dispatches requests"| node_model
node_routes -->|"renders"| node_home
node_fretsem -->|"parses"| node_grammar
node_fretsem -->|"analyzes semantics"| node_semantics
node_model -->|"formalizes requirements"| node_fretsem
node_model -->|"uses databases"| node_db
node_getters -->|"queries"| node_db
node_model -->|"synchronizes variables"| node_mapping
node_mapping -->|"reads and maps"| node_db
node_model -->|"imports requirements"| node_import
node_model -->|"checks realizability"| node_realizability
node_realizability -->|"checks contracts"| node_check
node_realizability -->|"diagnoses conflicts"| node_diagnosis
node_diagnosis -->|"runs checks"| node_check
node_model -->|"generates tests"| node_testgen
node_model -->|"renders exports"| node_export
node_user -->|"explores traces"| node_simui
node_simui -.->|"controls simulation"| node_simcontroller
node_simcontroller -->|"parses formulas"| node_simparser
node_simcontroller -->|"updates trace model"| node_simmodel

click node_electron "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/main.dev.js"
click node_routes "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/routes.js"
click node_home "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/components/Home.js"
click node_ui "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/components/MainView.js"
click node_grammar "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/parser/RequirementParser.js"
click node_semantics "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/parser/SemanticsAnalyzer.js"
click node_fretsem "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/parser/FretSemantics.js"
click node_model "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/FretModel.js"
click node_db "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/fretDB.js"
click node_getters "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/fretDbSupport/fretDbGetters_main.js"
click node_mapping "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/modelDbSupport/variableMappingSupports.js"
click node_import "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/requirementsImport/convertAndImportRequirements_main.js"
click node_realizability "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/realizabilitySupport/realizabilityUtils.js"
click node_diagnosis "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/analysis/DiagnosisEngine.js"
click node_check "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/analysis/realizabilityCheck.js"
click node_testgen "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/testGenSupport/testGenUtils.js"
click node_export "https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/support/r2u2Export.js"
click node_simui "https://github.com/nasa-sw-vnv/fret/blob/master/tools/LTLSIM/ltlsim-electron/app/components/MainView.js"
click node_simcontroller "https://github.com/nasa-sw-vnv/fret/blob/master/tools/LTLSIM/ltlsim-core/classes/LTLSimController.js"
click node_simparser "https://github.com/nasa-sw-vnv/fret/blob/master/tools/LTLSIM/ltlsim-core/parser/LTLParser.js"
click node_simmodel "https://github.com/nasa-sw-vnv/fret/blob/master/tools/LTLSIM/ltlsim-core/classes/LTLSimModel.js"

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_electron,node_routes,node_home,node_ui toneBlue
class node_grammar,node_semantics,node_fretsem toneAmber
class node_model,node_db,node_getters,node_mapping,node_import toneMint
class node_realizability,node_diagnosis,node_check,node_testgen,node_export toneRose
class node_simui,node_simcontroller,node_simparser,node_simmodel,node_user toneIndigo
```

## Components

### Desktop application

- [Electron main](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/main.dev.js): `fret-electron/app/main.dev.js`
- [Application routes](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/routes.js): `fret-electron/app/routes.js`
- [Home workspace](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/components/Home.js): `fret-electron/app/components/Home.js`
- [Requirement interface](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/components/MainView.js): `fret-electron/app/components/MainView.js`

### Requirement formalization

- [Requirement grammar](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/parser/RequirementParser.js): `fret-electron/app/parser/RequirementParser.js`
- [Semantic formalizer](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/parser/SemanticsAnalyzer.js): `fret-electron/app/parser/SemanticsAnalyzer.js`
- [Formalization service](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/app/parser/FretSemantics.js): `fret-electron/app/parser/FretSemantics.js`

### Project and persistence

- [Project model](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/FretModel.js): `fret-electron/model/FretModel.js`
- [Project databases](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/fretDB.js): `fret-electron/model/fretDB.js`
- [Requirement queries](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/fretDbSupport/fretDbGetters_main.js): `fret-electron/model/fretDbSupport/fretDbGetters_main.js`
- [Variable mapping](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/modelDbSupport/variableMappingSupports.js): `fret-electron/model/modelDbSupport/variableMappingSupports.js`
- [Requirement import](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/requirementsImport/convertAndImportRequirements_main.js): `fret-electron/model/requirementsImport/convertAndImportRequirements_main.js`

### Analysis and generation

- [Realizability workflow](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/realizabilitySupport/realizabilityUtils.js): `fret-electron/model/realizabilitySupport/realizabilityUtils.js`
- [Conflict diagnosis](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/analysis/DiagnosisEngine.js): `fret-electron/analysis/DiagnosisEngine.js`
- [Realizability checker](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/analysis/realizabilityCheck.js): `fret-electron/analysis/realizabilityCheck.js`
- [Test generation](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/model/testGenSupport/testGenUtils.js): `fret-electron/model/testGenSupport/testGenUtils.js`
- [R2U2 export](https://github.com/nasa-sw-vnv/fret/blob/master/fret-electron/support/r2u2Export.js): `fret-electron/support/r2u2Export.js`

### Trace simulation

- [Simulator interface](https://github.com/nasa-sw-vnv/fret/blob/master/tools/LTLSIM/ltlsim-electron/app/components/MainView.js): `tools/LTLSIM/ltlsim-electron/app/components/MainView.js`
- [Trace controller](https://github.com/nasa-sw-vnv/fret/blob/master/tools/LTLSIM/ltlsim-core/classes/LTLSimController.js): `tools/LTLSIM/ltlsim-core/classes/LTLSimController.js`
- [Trace formula parser](https://github.com/nasa-sw-vnv/fret/blob/master/tools/LTLSIM/ltlsim-core/parser/LTLParser.js): `tools/LTLSIM/ltlsim-core/parser/LTLParser.js`
- [Trace model](https://github.com/nasa-sw-vnv/fret/blob/master/tools/LTLSIM/ltlsim-core/classes/LTLSimModel.js): `tools/LTLSIM/ltlsim-core/classes/LTLSimModel.js`

### Other components

- **Requirement author**

## Connections

- Requirement author → Requirement interface: authors requirements (evidence: `README.md`)
- Electron main → Project model: dispatches requests (evidence: `fret-electron/app/main.dev.js`)
- Application routes → Home workspace: renders (evidence: `fret-electron/app/routes.js`)
- Formalization service → Requirement grammar: parses (evidence: `fret-electron/app/parser/FretSemantics.js`)
- Formalization service → Semantic formalizer: analyzes semantics (evidence: `fret-electron/app/parser/FretSemantics.js`)
- Project model → Formalization service: formalizes requirements (evidence: `fret-electron/model/FretModel.js`)
- Project model → Project databases: uses databases (evidence: `fret-electron/model/FretModel.js`)
- Requirement queries → Project databases: queries (evidence: `fret-electron/model/fretDbSupport/fretDbGetters_main.js`)
- Project model → Variable mapping: synchronizes variables (evidence: `fret-electron/model/FretModel.js`)
- Variable mapping → Project databases: reads and maps (evidence: `fret-electron/model/modelDbSupport/variableMappingSupports.js`)
- Project model → Requirement import: imports requirements (evidence: `fret-electron/model/requirementsImport/convertAndImportRequirements_main.js`)
- Project model → Realizability workflow: checks realizability (evidence: `fret-electron/model/FretModel.js`)
- Realizability workflow → Realizability checker: checks contracts (evidence: `fret-electron/model/realizabilitySupport/realizabilityUtils.js`)
- Realizability workflow → Conflict diagnosis: diagnoses conflicts (evidence: `fret-electron/model/realizabilitySupport/realizabilityUtils.js`)
- Conflict diagnosis → Realizability checker: runs checks (evidence: `fret-electron/analysis/DiagnosisEngine.js`)
- Project model → Test generation: generates tests (evidence: `fret-electron/model/FretModel.js`)
- Project model → R2U2 export: renders exports (evidence: `fret-electron/model/FretModel.js`)
- Requirement author → Simulator interface: explores traces (evidence: `README.md`)
- Simulator interface → Trace controller: controls simulation
- Trace controller → Trace formula parser: parses formulas (evidence: `tools/LTLSIM/ltlsim-core/classes/LTLSimController.js`)
- Trace controller → Trace model: updates trace model (evidence: `tools/LTLSIM/ltlsim-core/classes/LTLSimController.js`)
