Instructor guide¶
This page explains how to use the repository as a structured SDR/FPGA teaching workspace.
1. Choose the teaching mode¶
| Mode | Suitable when | Main pages |
|---|---|---|
| Theory + simulation only | no hardware is available yet | DSP foundation track, Lab index, Reproducibility guide |
| Fixed-point + HDL | students already know DSP basics | DSP → FPGA Bridge, CIC fixed-point FPGA bridge |
| Hardware-assisted SDR | a controlled board + receiver setup is available | Hardware checklist, RF safety guide, SDR measurement report template |
2. Recommended classroom flow¶
- Start with the system view: Model → FPGA → RF → Measurement.
- Assign one or two DSP labs with generated plots.
- Move to fixed-point and HDL only after the floating-point path is clear.
- Introduce hardware only when RF safety, metadata and reporting discipline are already explained.
- Finish with one end-to-end mini-project or measurement report.
3. Pre-class checklist¶
- the relevant docs pages build locally;
- required lab scripts run at least once;
- hardware assumptions are written down;
- students know what artifact they must produce;
- the acceptance criterion is visible before the lab starts.
4. What good student output looks like¶
A strong lab submission should contain:
- one reproducible command path;
- one figure or report;
- one short engineering conclusion;
- configuration notes for any hardware-facing step.
The repository already provides templates and guides for that discipline:
- Lab report template
- SDR measurement report template
- IQ recording metadata guide
- Measurement uncertainty guide
5. Safety and evidence discipline¶
Before any RF lab, require students to read:
This prevents labs from turning into undocumented "it worked on the bench" demos.
6. Useful pages for course maintenance¶
These pages are the maintenance backbone for keeping the course coherent as it grows.