Neat Framework
Use this page to install or update the SiMa Neat Framework/runtime in either the Neat SDK or directly on a DevKit.
The Neat Framework is installed independently from the Neat SDK. This lets you update the framework/runtime without updating the SDK container.
Choose Where to Install
Install from the environment where you plan to build or run Neat applications:
| Environment | Use this when |
|---|---|
| Neat SDK with DevKit Sync | You want the SDK build environment and paired DevKit runtime kept in sync automatically. |
| Neat SDK without DevKit Sync | You only need to build in the SDK container and will transfer binaries to a DevKit manually. |
| DevKit | You want to install or update the runtime directly on the device. |
When you install from inside a Neat SDK container that has been paired with a DevKit through DevKit Sync, the installer also installs the Neat Framework on the paired DevKit. This keeps the SDK build environment and the DevKit runtime on the same Neat core library version.
Prerequisites
Install sima-cli in the environment where you plan to install Neat. Use the official guide.
Before you begin:
- Make sure your Modalix DevKit is connected to the Internet.
- We recommend creating an account at developer.sima.ai to access assets such as precompiled models for testing.
Prepare an Install Directory
On the DevKit, install under /media/nvme to avoid filling the root file system. In the Neat SDK container, use a container-local path such as $HOME/neat.
cd $HOME && mkdir -p neat && cd neat
Install the Latest Stable Build
Use this option for the latest stable build from the main branch:
wget -O /tmp/install-neat.sh https://tools.sima-neat.com/install-neat.sh && \
bash /tmp/install-neat.sh main
You can optionally install extras, including prebuilt tutorials, source-code tutorials, and tests.
Install a Selected Branch or Release
Use this option to try the latest automated build from any branch or release. This method prompts you to select artifacts from any available branch or release.
wget -O /tmp/install-neat.sh https://tools.sima-neat.com/install-neat.sh && \
bash /tmp/install-neat.sh
After Installation
On the DevKit, installation also provisions a PyNeat virtual environment at ~/pyneat:
source ~/pyneat/bin/activate
If you run the installer from inside a Neat SDK container paired with DevKit Sync, the PyNeat runtime installation targets the paired DevKit environment. Neat is installed into a virtual environment under ~/pyneat on the DevKit.
If you prefer building from source, follow the Build guide.
For SDK environment setup and DevKit Sync onboarding, see Neat SDK.
Neat CLI
The installed framework provides the neat environment command. Run it from either the Neat SDK or DevKit to see installed component versions, installed sima-cli playbooks, and whether newer artifacts are available.
In the Neat SDK, the status output also includes the Insight exposed host ports from $HOME/.insight-config/neat-port-map.json.
neat
Example output:
Neat Environment
Mode Neat SDK
Sysroot /opt/toolchain/aarch64/modalix
Update check online
Components
Neat core 0.0.0+main-6735c35 channel=main latest=6735c35
PyNeat 0.0.0
neat-runtime 0.0.1-main-e4b19553e07d
neat-gst-plugins 0.0.1-main-e4b19553e07d
neat-insight 0.0.0+main.74ae0b5 channel=main latest=74ae0b5 status=Running venv=/opt/neat-insight/venv
Model SDK Extension 2.0.0.neat+main-1ebbc39 run activate-model-sdk to activate
Exposed Ports
Insight Web UI https://10.0.0.22:9900
Name Protocol Host Port (Start) Host Port (End)
------------------ -------- ----------------- ---------------
mainUI tcp 9900 -
metadataUDP udp 9100 9179
rtsp.tcp tcp 8554 -
videoUDP udp 9000 9079
videoUI tcp 8081 -
webRTC udp 40000 40199
webSSH tcp 8022 -
For automation and tool integrations, use JSON output:
neat --json
To update the Neat core runtime, neat-insight, and installed sima-cli playbooks from the detected channel, run:
neat update
Next step
Continue with Hello Neat! to validate your setup with a minimal app.