Installation

Let’s unzip the SDK:

cd ~/
unzip Heex_SDK_<version>_<platform>.zip
cd Heex_SDK_<version>

💡 Tip: On Python

If you are working with Python, the installation is done. You can directly develop your python agents.

​

Building HeexSDK

📝 Note:

Please make sure you have all pre-required dependencies listed here. Please make sure your system is up-to-date. On Debian based systems, you may want to run: sudo apt update -y

ℹ️ Note:

If you are working with a ros melodic environment, add the flag --with-legacy-ubuntu18 to the command below.
It is assumed that you have boost 1.65.1 already installed. Note that the build process will not install it for you.

Build the SDK using the CLI in the Heex_SDK directory:

./heex sdk build --build-examples

ℹ️ Note: CONGRATULATIONS!

You have completed the SDK building and configuration phase!

ℹ️ Info:

If you are working with Windows, you may encounter an error during either the unzip due to the length of your path or during the build step. If so, we recommend the following options :

1. Unzip Heex SDK in a folder with a lower path length

2. Enable LongPath in windows registry as follows

   • Win + R and type regedit
   • Look for LongPathsEnabled at HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem and set the value to 1

Let’s unzip the SDK:

cd ~/
unzip Heex_SDK_<version>_<platform>.zip
cd Heex_SDK_<version>

💡 Tip: On Python

If you are working with Python, the installation is done. You can directly develop your python agents.

​

Building C++ files on Windows 10

1. Make sure the following dependencies are installed. They are not installed automatically:

   • Microsoft Visual C++(MVSC) compiler toolset from Visual Studio Community 2019 or Build Tools for Visual Studio 2019
   • The version of the compiler toolset is restricted to MSVC v142 - VS 2019 C++ - x86/x64 Build due to the boost 1.84.0 library being only compatible with this version.
   • Verify that cl is present (i.e, type cl in Powershell windows)

2. Open a Developer PowerShell terminal inside Heex_SDK_<version> directory You should be inside Heex_SDK_<version> directory after this step.

3. Set the correct policy for powershell scripts. It is required to use the runHeexKernel script and for HRE (Heex Runtime Environment) deployment.

   • Open a Powershell terminal window with Administrative rights and enter the following

     Set-ExecutionPolicy RemoteSigned
     

   • To revert this policy(if it conflicts with your configuration later down the line), do as below

     Set-ExecutionPolicy Default
     

4. Start the build of the SDK in the Heex_SDK directory:

./heex sdk build --build-examples

ℹ️ Info:

Did the compilation failed when build the boost library? It may be due to Windows limitation on long paths

Go back at Getting Heex SDK