Skip to main content

Install the Environment

Install the SDK version that matches your DevKit software and Neat Library version.

Prerequisites​

To use DevKit Sync later, you also need:

  • A Modalix DevKit running a compatible DevKit software version.
  • Your host machine and DevKit on the same network with NFS traffic allowed.
  • Your DevKit IP address.

Install​

For Neat Development Environment 2.1.2:

sima-cli install ghcr:sima-neat/sdk:v2.1.2

For Neat Development Environment 2.0.0:

sima-cli install ghcr:sima-neat/sdk:v2.0.0

To install the latest patch release for a supported release branch, use the branch's latest tag. For example, to install the latest 2.0 release:

sima-cli install ghcr:sima-neat/sdk:v2.0-latest

You can also install ghcr:sima-neat/sdk to use the latest SDK image from the main branch of the open source repository.

Set Up the SDK Workspace​

After the image is installed, run SDK setup before opening the SDK shell. Setup creates the workspace mapping used by the container and can also pair the SDK with your DevKit.

If your DevKit is reachable from the host, pair it during setup:

sima-cli sdk setup --devkit {devkit-ip}

Replace {devkit-ip} with your DevKit's IP address.

If your DevKit is not reachable yet, set up the SDK workspace without pairing:

sima-cli sdk setup

You can add or update DevKit pairing later from Pair with a DevKit.

Open the SDK Shell​

After SDK setup succeeds, open the SDK shell with:

sima-cli sdk neat

Install the Model Compiler​

During SDK setup, sima-cli can prompt you to install the matching Model Compiler.

The Model Compiler quantizes and compiles ONNX models so they can run on SiMa.ai's MLA. To install it, opt in when prompted during SDK setup.

Install the Model Compiler later with the command that matches your host architecture.

For amd64 hosts:

sima-cli install -v 2.1.2 tools/model-compiler/amd64

For arm64 hosts:

sima-cli install -v 2.1.2 tools/model-compiler/arm64

After installation, activate the compiler environment from inside the SDK shell:

activate-model-compiler

To return to the default SDK shell, run:

deactivate-model-compiler

Model Compiler support is available on Ubuntu and Windows through WSL. On macOS, use Model Compiler 2.1.2 or above.

Upgrade​

To upgrade the SDK to the latest version, rerun the following command from the host:

sima-cli install ghcr:sima-neat/sdk

To update the Neat Library inside an existing SDK container, run the Neat CLI from the container shell:

neat update

This updates the installed Neat Library components in the current SDK. It does not replace a full container image upgrade when you need SDK-level changes.

If you delete or recreate the SDK container later, run neat update again inside the new container.

Next Step​

Continue to Pair with a DevKit.