# myname-is-jeff/radiodifusion architecture

> Architecture diagram of the GitHub repository myname-is-jeff/radiodifusion, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/myname-is-jeff/radiodifusion
- Repository: https://github.com/myname-is-jeff/radiodifusion

## Overview

##### Project type and purpose
- This is an educational “course‐ware” repository for the UCA Electronics Engineering class on radio broadcasting.
- It contains GNU Radio Companion flow graphs (.grc), auto‐generated Python wrappers (.py), Jupyter notebooks (.ipynb), raw RF data files, PDFs, and instructions for hands-on labs in AM, FM, NTSC analog TV, and an SDR radar case study.

##### File structure
- Top level:
- G1 – AM simulation in Python (Jupyter notebook)
- G2 – AM/FM practicals in Python and GNU Radio
◦ “Cosas Clase” – in‐class demo flow graphs (.grc + .py)
◦ “Guia Resuelta” – step‐by‐step solutions (flow graphs, scripts, data)
- G3 – NTSC analog TV practicals (flow graphs, notebooks, data)
- RADAR – SDR-based FMCW radar case study (flow graphs, PDFs)
- README.md, LICENSE
- Each .grc file defines a flow graph; each .py file is the generated executable.
- Data files (.dat, .bin) feed into or record from the flow graphs.

##### Extract insights from the README
- Confirms the repo is a collection of practical lab solutions.
- Notes use of Google Colab for notebooks.
- Describes the five parts of G2, two parts of G3, and the radar case study.

a. Main components
- Development Environments
– GNU Radio Companion (visual flow graph editor)
– Python interpreter / Jupyter / Google Colab
- Signal Processing Blocks
– Modulators/demodulators, FIR filters, PLL, etc. (instantiated in flow graphs)
- Data Sources & Sinks
– Static data files (.dat, .bin)
– Live SDR hardware (USRP devices)
– File sinks for recording spectra or audio
- Visualization & Analysis
– FFT sinks, GUI sinks, Jupyter plots
- Documentation & Guides
– PDF lecture notes, README, license
b. Relationships & interactions
- The .grc files compile down to .py scripts run by Python.
- Jupyter notebooks call Python modules directly or embed GNU Radio blocks via Python.
- Lab guides (PDFs/parallel directories) reference specific flow graphs and data.
c. Architectural patterns & design principles
- Modular signal‐processing pipelines (GRC blocks chained together)
- Clear separation of concerns:
– Visualization/UI blocks vs. processing blocks vs. data I/O blocks
- Reproducible labs: each guide directory contains all needed .grc, .py, and data files.
d. Key technologies & frameworks
- GNU Radio Companion & GNU Radio core libraries
- Python (2.x or 3.x depending on .py header)
- Jupyter notebooks / Google Colab
- USRP SDR hardware (for G2 Part 5 and RADAR)

##### Essential architectural elements
- Every major component: GRC editor, code generation, runtime environment, hardware interface, data stores, visualization tools.
- How each lab guide folder encapsulates a self-contained pipeline.
- Avoid over-splitting: group similar pipelines under their “Gx” prefix.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Development Environments
    subgraph "Development Environments"
        GRC["GNU Radio Companion"]:::tool
        PY["Python Interpreter / Jupyter / Colab"]:::tool
    end

    %% Data Sources & Hardware
    subgraph "Data Sources & Hardware"
        DATASRC["Static Data Files (.dat, .bin)"]:::data
        USRP["USRP SDR Hardware"]:::data
    end

    %% Lab Guides & Pipelines
    subgraph "Lab Guides & Pipelines"
        G1["G1: AM Simulation Notebook"]:::project
        G2IC["G2: In-class Demos"]:::project
        G2SOL["G2: G2 Guia Resuelta"]:::project
        G3["G3: NTSC Analog TV Practicals"]:::project
        RAD["RADAR: FMCW Radar Case Study"]:::project
    end

    %% Visualization & Outputs
    subgraph "Visualization & Outputs"
        FFT["FFT & GUI Sinks"]:::viz
        REC["Recorded Files & Audio Sinks"]:::viz
        HD["Hardware TX"]:::viz
        DOC["PDF Guides & Documentation"]:::doc
    end

    %% Connections: Environments to Projects
    GRC -->|generates flow graphs| G1
    GRC -->|generates flow graphs| G2IC
    GRC -->|generates flow graphs| G2SOL
    GRC -->|generates flow graphs| G3
    GRC -->|generates flow graphs| RAD

    PY -->|executes .py & notebooks| G1
    PY -->|executes .py & notebooks| G2IC
    PY -->|executes .py & notebooks| G2SOL
    PY -->|executes .py & notebooks| G3
    PY -->|executes .py & notebooks| RAD

    %% Data to Projects
    DATASRC -->|feeds into| G1
    DATASRC -->|feeds into| G2SOL
    DATASRC -->|feeds into| G3
    USRP -->|live stream| G2IC
    USRP -->|live stream| G2SOL
    USRP -->|live stream| RAD

    %% Projects to Outputs
    G1 -->|visualizes| FFT
    G1 -->|records| REC
    G2IC -->|visualizes| FFT
    G2IC -->|hardware TX| HD
    G2SOL -->|visualizes| FFT
    G2SOL -->|hardware TX| HD
    G3 -->|visualizes| FFT
    G3 -->|records| REC
    RAD -->|visualizes| FFT
    RAD -->|hardware TX| HD

    G1 -->|documents| DOC
    G2IC -->|documents| DOC
    G2SOL -->|documents| DOC
    G3 -->|documents| DOC
    RAD -->|documents| DOC

    %% Click Events
    click G1 "https://github.com/myname-is-jeff/radiodifusion/blob/main/G1/G1.ipynb"
    click G2IC "https://github.com/myname-is-jeff/radiodifusion/tree/main/G2/Cosas Clase/"
    click G2SOL "https://github.com/myname-is-jeff/radiodifusion/tree/main/G2/Guia Resuelta/"
    click G3 "https://github.com/myname-is-jeff/radiodifusion/tree/main/G3/"
    click RAD "https://github.com/myname-is-jeff/radiodifusion/tree/main/RADAR/"

    %% Styles
    classDef tool fill:#AED6F1,stroke:#333,stroke-width:1px
    classDef data fill:#FFA07A,stroke:#333,stroke-width:1px
    classDef project fill:#A9DFBF,stroke:#333,stroke-width:1px
    classDef viz fill:#ABEBC6,stroke:#333,stroke-width:1px
    classDef doc fill:#D5D8DC,stroke:#333,stroke-width:1px
```
