Start Here¶
A one-line map from "what you're trying to do" to the doc family that answers it.
| You want to... | Go to |
|---|---|
| Call a specific function or class | API Reference — Python surface, one page per module |
| See it running, with a plot | Gallery — dozens of worked examples grouped by DSP domain |
| Accomplish a task end-to-end | Guides — task-oriented walkthroughs (lock detection, DSSS acquisition, PSD, real-time pacing) |
| Understand why it's built this way | Design — architecture decisions and algorithm rationale |
| Add a module or contribute | Contributing — repo layout, module conventions, release process |
| Build a C program against doppler | C Quick Start — get the library + the three CI-verified build faces (cc/CMake/pkg-config) |
| Look up a raw C signature | C API — machine-generated from the C headers |
| Compose and stream a waveform | Waveform Generator — wfmgen's own top-level nav section |
Not sure which page has the piece you need? Every family answers a
different question about the same underlying object — for example,
SymbolSync has a Python API page, a
gallery walkthrough, a
design doc for its lock detector, and a
guide for wiring it into a receiver. Start
wherever matches your question above; the pages already link out to each
other from there.