# fred-framework/dart architecture

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

- Interactive diagram: https://gitdiagram.com/fred-framework/dart
- Repository: https://github.com/fred-framework/dart

## Overview

DART automates FPGA DPR design: a user supplies a YAML design description, then DART prepares resource and task inputs, optimizes placement/allocation for a supported device, and generates implementation artifacts. The README identifies partitioning, floorplanning, routing, and bitstream generation as product capabilities; the source tree also exposes wrapper and FRED integration generation. The main entry point and optimizer handoff are partly visible, but implementation-generation calls and some subsystem wiring are not, so uncertain links are omitted or marked unverified.

Main entry points: [`include/milp_solver_interface.h`](https://github.com/fred-framework/dart/blob/master/include/milp_solver_interface.h) (Solver interface), [`include/gurobi_c++.h`](https://github.com/fred-framework/dart/blob/master/include/gurobi_c%2B%2B.h) (Gurobi API), [`without_gui/src/flora.cpp`](https://github.com/fred-framework/dart/blob/master/without_gui/src/flora.cpp) (Input preparation and planning), [`without_gui/src/main.cpp`](https://github.com/fred-framework/dart/blob/master/without_gui/src/main.cpp) (CLI and YAML validation)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry and orchestration"]
  node_cli["CLI and YAML validation<br/>[main.cpp]"]
  node_prtool["PR flow orchestration<br/>[pr_tool.cpp]"]
end

subgraph group_planning["Planning and optimization"]
  node_flora["Input preparation and planning<br/>[flora.cpp]"]
  node_csv["CSV data handling"]
  node_solver_interface["Solver interface"]
  node_partition["Partition model<br/>[partition.cpp]"]
end

subgraph group_devices["FPGA device models"]
  node_pynq_solver["PYNQ optimizer"]
  node_pynq_partition_solver["PYNQ partition optimizer"]
  node_us_solver["ZCU-102 optimizer<br/>[milp_model_us.cpp]"]
  node_us96_solver["US-96 optimizer"]
  node_zynq_solver["Zynq partition optimizer"]
  node_gurobi["Gurobi API<br/>[gurobi_c++.h]"]
end

subgraph group_implementation["Implementation generation"]
  node_xdc["Floorplan constraints<br/>[generate_xdc.h]"]
  node_wrapper["Accelerator wrapper generation<br/>[gen_wrapper.h]"]
  node_artifacts["Implementation and FRED artifacts<br/>[pr_tool.cpp]"]
end

node_user(("Design author"))

node_user -->|"supplies YAML"| node_cli
node_cli -->|"starts planning"| node_flora
node_cli -->|"starts PR flow"| node_prtool
node_flora -.->|"uses data handling"| node_csv
node_flora -.->|"uses solver contract"| node_solver_interface
node_solver_interface -->|"shares partition types"| node_partition
node_solver_interface -->|"declares entry point"| node_pynq_solver
node_solver_interface -->|"declares entry point"| node_pynq_partition_solver
node_solver_interface -->|"declares entry point"| node_us_solver
node_solver_interface -->|"declares entry point"| node_us96_solver
node_solver_interface -->|"declares entry point"| node_zynq_solver
node_pynq_solver -->|"uses optimization API"| node_gurobi
node_pynq_partition_solver -->|"uses optimization API"| node_gurobi
node_us_solver -->|"uses optimization API"| node_gurobi
node_us96_solver -->|"uses optimization API"| node_gurobi
node_zynq_solver -->|"uses optimization API"| node_gurobi
node_flora -.->|"generates constraints"| node_xdc
node_prtool -.->|"generates wrapper"| node_wrapper
node_prtool -.->|"generates implementation files"| node_artifacts

click node_cli "https://github.com/fred-framework/dart/blob/master/without_gui/src/main.cpp"
click node_prtool "https://github.com/fred-framework/dart/blob/master/without_gui/src/pr_tool.cpp"
click node_flora "https://github.com/fred-framework/dart/blob/master/without_gui/src/flora.cpp"
click node_csv "https://github.com/fred-framework/dart/blob/master/include/csv_data_manipulator.hpp"
click node_solver_interface "https://github.com/fred-framework/dart/blob/master/include/milp_solver_interface.h"
click node_partition "https://github.com/fred-framework/dart/blob/master/src/partition.cpp"
click node_pynq_solver "https://github.com/fred-framework/dart/blob/master/src/devices/pynq/milp_model_pynq.cpp"
click node_pynq_partition_solver "https://github.com/fred-framework/dart/blob/master/src/devices/pynq/milp_model_pynq_with_partition.cpp"
click node_us_solver "https://github.com/fred-framework/dart/blob/master/src/devices/zcu_102/milp_model_us.cpp"
click node_us96_solver "https://github.com/fred-framework/dart/blob/master/src/devices/us_96/milp_model_us_96.cpp"
click node_zynq_solver "https://github.com/fred-framework/dart/blob/master/src/not_used/zynq/milp_model_zynq_with_partition.cpp"
click node_gurobi "https://github.com/fred-framework/dart/blob/master/include/gurobi_c%2B%2B.h"
click node_xdc "https://github.com/fred-framework/dart/blob/master/include/generate_xdc.h"
click node_wrapper "https://github.com/fred-framework/dart/blob/master/without_gui/include/gen_wrapper.h"
click node_artifacts "https://github.com/fred-framework/dart/blob/master/without_gui/src/pr_tool.cpp"

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_cli,node_prtool toneBlue
class node_flora,node_csv,node_solver_interface,node_partition toneAmber
class node_pynq_solver,node_pynq_partition_solver,node_us_solver,node_us96_solver,node_zynq_solver,node_gurobi toneMint
class node_xdc,node_wrapper,node_artifacts toneRose
class node_user toneIndigo
```

## Components

### Entry and orchestration

- [CLI and YAML validation](https://github.com/fred-framework/dart/blob/master/without_gui/src/main.cpp): `without_gui/src/main.cpp`
- [PR flow orchestration](https://github.com/fred-framework/dart/blob/master/without_gui/src/pr_tool.cpp): `without_gui/src/pr_tool.cpp`

### Planning and optimization

- [Input preparation and planning](https://github.com/fred-framework/dart/blob/master/without_gui/src/flora.cpp): `without_gui/src/flora.cpp`
- [CSV data handling](https://github.com/fred-framework/dart/blob/master/include/csv_data_manipulator.hpp): `include/csv_data_manipulator.hpp`
- [Solver interface](https://github.com/fred-framework/dart/blob/master/include/milp_solver_interface.h): `include/milp_solver_interface.h`
- [Partition model](https://github.com/fred-framework/dart/blob/master/src/partition.cpp): `src/partition.cpp`

### FPGA device models

- [PYNQ optimizer](https://github.com/fred-framework/dart/blob/master/src/devices/pynq/milp_model_pynq.cpp): `src/devices/pynq/milp_model_pynq.cpp`
- [PYNQ partition optimizer](https://github.com/fred-framework/dart/blob/master/src/devices/pynq/milp_model_pynq_with_partition.cpp): `src/devices/pynq/milp_model_pynq_with_partition.cpp`
- [ZCU-102 optimizer](https://github.com/fred-framework/dart/blob/master/src/devices/zcu_102/milp_model_us.cpp): `src/devices/zcu_102/milp_model_us.cpp`
- [US-96 optimizer](https://github.com/fred-framework/dart/blob/master/src/devices/us_96/milp_model_us_96.cpp): `src/devices/us_96/milp_model_us_96.cpp`
- [Zynq partition optimizer](https://github.com/fred-framework/dart/blob/master/src/not_used/zynq/milp_model_zynq_with_partition.cpp): `src/not_used/zynq/milp_model_zynq_with_partition.cpp`
- [Gurobi API](https://github.com/fred-framework/dart/blob/master/include/gurobi_c%2B%2B.h): `include/gurobi_c++.h`

### Implementation generation

- [Floorplan constraints](https://github.com/fred-framework/dart/blob/master/include/generate_xdc.h): `include/generate_xdc.h`
- [Accelerator wrapper generation](https://github.com/fred-framework/dart/blob/master/without_gui/include/gen_wrapper.h): `without_gui/include/gen_wrapper.h`
- [Implementation and FRED artifacts](https://github.com/fred-framework/dart/blob/master/without_gui/src/pr_tool.cpp): `without_gui/src/pr_tool.cpp`

### Other components

- **Design author**

## Connections

- Design author → CLI and YAML validation: supplies YAML (evidence: `without_gui/src/main.cpp`)
- CLI and YAML validation → Input preparation and planning: starts planning (evidence: `without_gui/src/main.cpp`)
- CLI and YAML validation → PR flow orchestration: starts PR flow (evidence: `without_gui/src/main.cpp`)
- Input preparation and planning → CSV data handling: uses data handling
- Input preparation and planning → Solver interface: uses solver contract
- Solver interface → Partition model: shares partition types (evidence: `include/milp_solver_interface.h`)
- Solver interface → PYNQ optimizer: declares entry point (evidence: `include/milp_solver_interface.h`)
- Solver interface → PYNQ partition optimizer: declares entry point (evidence: `include/milp_solver_interface.h`)
- Solver interface → ZCU-102 optimizer: declares entry point (evidence: `include/milp_solver_interface.h`)
- Solver interface → US-96 optimizer: declares entry point (evidence: `include/milp_solver_interface.h`)
- Solver interface → Zynq partition optimizer: declares entry point (evidence: `include/milp_solver_interface.h`)
- PYNQ optimizer → Gurobi API: uses optimization API (evidence: `src/devices/pynq/milp_model_pynq.cpp`)
- PYNQ partition optimizer → Gurobi API: uses optimization API (evidence: `src/devices/pynq/milp_model_pynq_with_partition.cpp`)
- ZCU-102 optimizer → Gurobi API: uses optimization API (evidence: `src/devices/zcu_102/milp_model_us.cpp`)
- US-96 optimizer → Gurobi API: uses optimization API (evidence: `src/devices/us_96/milp_model_us_96.cpp`)
- Zynq partition optimizer → Gurobi API: uses optimization API (evidence: `src/not_used/zynq/milp_model_zynq_with_partition.cpp`)
- Input preparation and planning → Floorplan constraints: generates constraints (evidence: `without_gui/src/flora.cpp`)
- PR flow orchestration → Accelerator wrapper generation: generates wrapper
- PR flow orchestration → Implementation and FRED artifacts: generates implementation files (evidence: `without_gui/src/pr_tool.cpp`)
