Skip to main content

Build Neat

This guide covers source builds of Neat. For prebuilt package installation, see Neat Framework.

build.sh is the supported build entry point. It handles dependency checks, optional deps sync, CMake configure/build, optional docs generation, install sanity checks, and packaging.

Build Environments​

build.sh automatically detects the active environment:

  • Modalix DevKit native environment
  • Neat SDK environment (cross-compilation)

You can run the same build.sh commands in either environment.

Cross Compilation Prerequisites​

Cross-compilation is typically faster than building directly on the DevKit, but you must transfer build artifacts to the DevKit afterward. You will need the Neat SDK for cross compilation.

Install sima-cli first on the host machine, then install the SDK.

curl https://docs.sima.ai/_static/tools/sima-cli-installer.sh | bash
sima-cli install sdk

When prompted by sima-cli, select the SDK option.

Then start the SDK:

sima-cli sdk elxr

Then install sima-cli inside the SDK, then install the SDK patch.

curl https://docs.sima.ai/_static/tools/sima-cli-installer.sh | bash
source ~/.bash_profile
sima-cli install tools/sdk-patch
  • SDK installation is supported on Windows and Ubuntu.
  • If you are building natively on a Modalix DevKit, the SDK install/patch steps are not required.

Build Options​

Supported build.sh options:

  • --dev-only: Build only the core library and headers (default).
  • --all: Build library + tests + tutorials + Python wheel; enables docs and deps.
  • --python: Build Python bindings (pyneat) in addition to selected targets.
  • --install-neat-internals, --install-deps: Download and install deps artifacts before build.
  • --doc: Build docs only.
  • --install: After build/package, install generated artifacts into the current environment. In paired Neat SDK mode, this also deploys and installs matching artifacts on the paired DevKit.
  • --no-dist: Skip distribution packaging.
  • --clean: Remove build/ before configuring.
  • --no-doc: Skip docs build (even with --all).
  • --no-node: Skip Node.js install (docs build may fail if Node is missing).
  • --install-deps-only: Install system dependencies and dependency headers, then exit.

Typical Builds​

Core library only (default):

./build.sh

Full build (library, tests, tutorials, docs, wheel, packaging):

./build.sh --all

Core library + Python bindings:

./build.sh --dev-only --python

Docs only:

This command also works on macOS.

./build.sh --doc

Clean full build:

./build.sh --all --clean

Install dependencies without building core:

./build.sh --install-deps-only

Outputs​

  • Build tree: build/
  • Docusaurus site output (when docs build runs): website/build/
  • Install sanity-check prefix: /tmp/sima-neat-install-test
  • Core package (*.deb) is generated on Linux full builds unless --no-dist is used.
  • Extras package (*extras.tar.gz) is generated on Linux full builds unless --no-dist is used.
  • Python wheel (dist/*.whl) is generated when Python build is enabled.