neuralspotx is the NSX tooling repo.
NSX is a lightweight bare-metal workflow for Ambiq targets. It provides:
- the
nsxCLI - packaged app templates
- packaged CMake helpers
- built-in board definitions
- curated metadata for module and SDK selection
The primary audience is app developers creating small, focused NSX applications for bring-up, profiling, validation, and simple demos.
NSX is also the build-and-deploy vehicle for Ambiq's Helia AI stack:
- heliaRT — optimized LiteRT (TFLite Micro) runtime, shipped as an NSX module
- heliaAOT — ahead-of-time compiler that
generates NSX modules from
.tflitemodels - heliaPROFILER — on-device model profiler built on NSX
For contributor workflows such as releases, CI, and the Python API surface, use
the docs site under docs/.
The main documentation lives in the docs site built from docs/.
Install the docs toolchain:
cd <nsx-repo>
uv sync --group docsRun the docs site locally:
cd <nsx-repo>
uv run --group docs zensical serveBuild the static site:
cd <nsx-repo>
uv run --group docs zensical buildNSX uses an app-first flow. Each app is a self-contained project directory with vendored modules, board definitions, and build helpers.
For app users, the cleanest install path is pipx:
pipx install neuralspotx
nsx doctor
nsx create-app hello_ap510 --board apollo510_evbFor contributors working from a source checkout:
cd <nsx-repo>
uv sync
source .venv/bin/activate
nsx doctor
nsx create-app hello_ap510 --board apollo510_evbBuild the app:
nsx configure --app-dir hello_ap510
nsx build --app-dir hello_ap510This repo owns:
src/neuralspotx- packaged documentation and templates
- packaged board definitions
- CMake helper assets used by generated apps
Built-in firmware modules are described by the packaged registry and fetched from their default upstream repos as needed. Normal app users create standalone app directories and let NSX manage module resolution, vendoring, configuration, build, flash, and view flows.