# raymondautomatisation/spyder-rydel-c architecture

> Architecture diagram of the GitHub repository raymondautomatisation/spyder-rydel-c, 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/raymondautomatisation/spyder-rydel-c
- Repository: https://github.com/raymondautomatisation/spyder-rydel-c

## Overview

RYDEL_C is a Spyder plugin for building and running C/C++ projects. The main workflow starts with the active editor file: toolbar actions either compile and run it with GCC/Clang, dispatch a Makefile or Ninja build, or generate a CPU or Vulkan CMake/Ninja build recipe. The plugin and build-process hub provide build diagnostics; generation is separate from compilation. The README also documents Linux/WSL CUDA as a separate workflow, not a toolbar feature. Some generator internals were only partially sampled, so unsampled implementation links are omitted.

Main entry points: [`spyder_rydel_c/generate_build_vulkan.py`](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/generate_build_vulkan.py) (Vulkan generator), [`spyder_rydel_c/plugin.py`](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/plugin.py) (Toolbar actions), [`spyder_rydel_c/generate_build.py`](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/generate_build.py) (CPU generator), [`spyder_rydel_c/build_process.py`](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/build_process.py) (Build-file hub)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interface["Spyder interface"]
  node_editor["Active editor file"]
  node_plugin["Toolbar actions<br/>[plugin.py]"]
end

subgraph group_execution["Build execution"]
  node_buildrun["Compile and run<br/>[plugin.py]"]
  node_buildhub["Build-file hub<br/>[build_process.py]"]
  node_make["Make runner<br/>[build_process.py]"]
  node_ninja["Ninja runner<br/>[build_process.py]"]
  node_diagnostics["Build diagnostics<br/>[build_process.py]"]
end

subgraph group_generation["Build generation"]
  node_cpu["CPU generator<br/>[generate_build.py]"]
  node_vulkan["Vulkan generator"]
end

subgraph group_external["Toolchains and workflows"]
  node_buildfile["Makefile / Ninja file"]
  node_compilers["GCC / Clang"]
  node_cmake["CMake"]
  node_ninjatool["Ninja tool"]
  node_vulkantools["Vulkan toolchain"]
  node_wsl["Linux/WSL CUDA"]
  node_buildoutput["Executable / build result"]
end

node_developer(("Developer"))

node_developer -->|"edits project"| node_editor
node_editor -->|"selects active file"| node_plugin
node_plugin -->|"compiles and runs"| node_buildrun
node_plugin -->|"dispatches build"| node_buildhub
node_plugin -->|"requests generation"| node_cpu
node_plugin -->|"requests generation"| node_vulkan
node_buildrun -->|"invokes compiler"| node_compilers
node_buildrun -->|"runs executable"| node_buildoutput
node_buildrun -->|"shows failures"| node_diagnostics
node_buildhub -->|"routes Makefile"| node_make
node_buildhub -->|"routes Ninja file"| node_ninja
node_make -->|"reads Makefile"| node_buildfile
node_ninja -->|"runs Ninja file"| node_buildfile
node_make -->|"reports result"| node_diagnostics
node_ninja -->|"reports result"| node_diagnostics
node_cpu -->|"runs generation"| node_cmake
node_cpu -->|"configures generator"| node_ninjatool
node_cpu -->|"configures toolchain"| node_compilers
node_cpu -->|"creates build recipe"| node_buildfile
node_vulkan -->|"runs generation"| node_cmake
node_vulkan -->|"configures generator"| node_ninjatool
node_vulkan -->|"configures toolchain"| node_compilers
node_vulkan -->|"checks dependencies"| node_vulkantools
node_vulkan -->|"creates build recipe"| node_buildfile
node_developer -.->|"follows separate workflow"| node_wsl

click node_plugin "https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/plugin.py"
click node_buildrun "https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/plugin.py"
click node_buildhub "https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/build_process.py"
click node_make "https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/build_process.py"
click node_ninja "https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/build_process.py"
click node_diagnostics "https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/build_process.py"
click node_cpu "https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/generate_build.py"
click node_vulkan "https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/generate_build_vulkan.py"
click node_wsl "https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/docs/RYDEL_C_QUICK_MANUAL.md"

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_editor,node_plugin toneBlue
class node_buildrun,node_buildhub,node_make,node_ninja,node_diagnostics toneAmber
class node_cpu,node_vulkan toneMint
class node_buildfile,node_compilers,node_cmake,node_ninjatool,node_vulkantools,node_wsl,node_buildoutput toneRose
class node_developer toneIndigo
```

## Components

### Spyder interface

- **Active editor file**
- [Toolbar actions](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/plugin.py): `spyder_rydel_c/plugin.py`

### Build execution

- [Compile and run](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/plugin.py): `spyder_rydel_c/plugin.py`
- [Build-file hub](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/build_process.py): `spyder_rydel_c/build_process.py`
- [Make runner](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/build_process.py): `spyder_rydel_c/build_process.py`
- [Ninja runner](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/build_process.py): `spyder_rydel_c/build_process.py`
- [Build diagnostics](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/build_process.py): `spyder_rydel_c/build_process.py`

### Build generation

- [CPU generator](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/generate_build.py): `spyder_rydel_c/generate_build.py`
- [Vulkan generator](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/spyder_rydel_c/generate_build_vulkan.py): `spyder_rydel_c/generate_build_vulkan.py`

### Toolchains and workflows

- **Makefile / Ninja file**
- **GCC / Clang**
- **CMake**
- **Ninja tool**
- **Vulkan toolchain**
- [Linux/WSL CUDA](https://github.com/raymondautomatisation/spyder-rydel-c/blob/main/docs/RYDEL_C_QUICK_MANUAL.md): `docs/RYDEL_C_QUICK_MANUAL.md`
- **Executable / build result**

### Other components

- **Developer**

## Connections

- Developer → Active editor file: edits project (evidence: `README.md`)
- Active editor file → Toolbar actions: selects active file (evidence: `spyder_rydel_c/plugin.py`)
- Toolbar actions → Compile and run: compiles and runs (evidence: `spyder_rydel_c/plugin.py`)
- Toolbar actions → Build-file hub: dispatches build (evidence: `spyder_rydel_c/plugin.py`)
- Toolbar actions → CPU generator: requests generation (evidence: `spyder_rydel_c/plugin.py`)
- Toolbar actions → Vulkan generator: requests generation (evidence: `spyder_rydel_c/plugin.py`)
- Compile and run → GCC / Clang: invokes compiler (evidence: `spyder_rydel_c/plugin.py`)
- Compile and run → Executable / build result: runs executable (evidence: `spyder_rydel_c/plugin.py`)
- Compile and run → Build diagnostics: shows failures (evidence: `spyder_rydel_c/plugin.py`)
- Build-file hub → Make runner: routes Makefile (evidence: `spyder_rydel_c/build_process.py`)
- Build-file hub → Ninja runner: routes Ninja file (evidence: `spyder_rydel_c/build_process.py`)
- Make runner → Makefile / Ninja file: reads Makefile (evidence: `spyder_rydel_c/build_process.py`)
- Ninja runner → Makefile / Ninja file: runs Ninja file (evidence: `spyder_rydel_c/build_process.py`)
- Make runner → Build diagnostics: reports result (evidence: `spyder_rydel_c/build_process.py`)
- Ninja runner → Build diagnostics: reports result (evidence: `spyder_rydel_c/build_process.py`)
- CPU generator → CMake: runs generation (evidence: `spyder_rydel_c/generate_build.py`)
- CPU generator → Ninja tool: configures generator (evidence: `spyder_rydel_c/generate_build.py`)
- CPU generator → GCC / Clang: configures toolchain (evidence: `spyder_rydel_c/generate_build.py`)
- CPU generator → Makefile / Ninja file: creates build recipe (evidence: `README.md`)
- Vulkan generator → CMake: runs generation (evidence: `spyder_rydel_c/generate_build_vulkan.py`)
- Vulkan generator → Ninja tool: configures generator (evidence: `spyder_rydel_c/generate_build_vulkan.py`)
- Vulkan generator → GCC / Clang: configures toolchain (evidence: `spyder_rydel_c/generate_build_vulkan.py`)
- Vulkan generator → Vulkan toolchain: checks dependencies (evidence: `spyder_rydel_c/generate_build_vulkan.py`)
- Vulkan generator → Makefile / Ninja file: creates build recipe (evidence: `README.md`)
- Developer → Linux/WSL CUDA: follows separate workflow (evidence: `README.md`)
