Install or Update Neat Library

Use this page to install or update the Palette Neat Library. You can install it directly on a DevKit, or inside the Neat Development Environment when you build from a host machine.

Choose Where to Install

Run the installer from the environment where you build or run Neat applications:

Environment	Use this when
Neat Development Environment with DevKit Sync	You want the host build environment and paired DevKit runtime kept in sync automatically.
Neat Development Environment without DevKit Sync	You only need to build in the container and will transfer binaries to a DevKit manually.
DevKit	You want to install or update the runtime directly on the device.

DevKit Sync keeps the runtime aligned

When you install from inside an SDK container paired with a DevKit through DevKit Sync, the installer also installs the Neat Library on the paired DevKit. This keeps the host build environment and the DevKit runtime on the same Neat Library version.

Prerequisites

Install sima-cli in the environment where you plan to install the Neat Library. Use the sima-cli installation guide.

Before you begin:

• Make sure the environment running the installer can download SiMa.ai artifacts.
• We recommend creating an account at community.sima.ai to access assets such as precompiled models for testing.

The package installer verifies the package manifest.json platform-version before it changes Python, apt, or SDK sysroot packages. In the Neat Development Environment, it compares that value with /etc/sdk-release SDK Version; on a DevKit, it compares with /etc/buildinfo DISTRO_VERSION. Development-only installs on nonstandard images can set NEAT_INSTALLER_SKIP_PLATFORM_CHECK=ON to bypass the guard explicitly.

Prepare an Install Directory

Choose a working directory before running the installer. On the DevKit, install under /media/nvme to avoid filling the root file system. In the SDK container, use a container-local path such as $HOME/neat.

sdk-container$cd $HOME && mkdir -p neat && cd neat

Install the Default Package

Use this option to install the default Neat Library package selected by sima-cli:

sdk-or-devkit$sima-cli neat install core

You can optionally install extras, including prebuilt tutorials, source-code tutorials, and tests.

Install a Selected Release

Use this option to install a specific Neat Library release. Append the version to the package name:

For Neat Library 0.1.0:

sdk-or-devkit$sima-cli neat install core@v0.1.0

For Neat Library 0.2.0:

sdk-or-devkit$sima-cli neat install core@v0.2.0

Default PyNeat Environment

On the DevKit, installation also provisions a PyNeat virtual environment at ~/pyneat:

devkit$source ~/pyneat/bin/activate

If you run the installer from inside an SDK container paired with DevKit Sync, the installer provisions PyNeat on the paired DevKit, not only inside the SDK container. PyNeat is installed into a virtual environment under ~/pyneat on the DevKit.

For custom Python virtual environments, see Install PyNeat.

Source Builds

If you prefer building from source, follow the Build guide.

For SDK setup and DevKit Sync onboarding, see Neat Development Environment.

Next Step

Continue to Install PyNeat for custom Python environments, or Neat CLI to inspect the installed environment.