Compilation steps for cpp API

Compilation of ArmoniK.Api.cpp Client and Server on Linux using Docker

In order to compile the client and server on Linux, we use a Docker image to set up the necessary environment and dependencies. This ensures a consistent and clean environment for compilation.

Prerequisites Linux

Install Docker on your Linux system. Follow the instructions on the official Docker documentation.
Clone the repository containing the source code and the necessary scripts.

Compilation Steps for Linux

Open a terminal in the root directory of the cloned repository.
Run the compile.sh script: This script compile the cpp project on linux systems.

bash

cd packages/cpp/tools
./compile.sh

The compile.sh script does the following:

Sets the image tag for the Docker image.
Determines the absolute paths of the necessary directories (working, proto, build, and install directories).
Checks if the Docker image exists. If not, it builds the Docker image using the Dockerfile.ubuntu file.
Compiles the project source using the Docker image. Once the compilation is complete, the compiled binaries will be located in the install directory.

Now you have successfully compiled the client and server on Linux using Docker.

Compiling the Client and Server on Windows

This guide explains how to compile the ArmoniK API client and server on Windows

Prerequisites Windows

Before getting started, make sure you have the following tools and packages installed on your machine:

PowerShell
Visual Studio 2022
Git

Before getting started, you will need PowerShell and be inform that the script will install localy in the folder tools/win64 all prerequisites excepting Visual Studio 2022 and CMake plugins :

Chocolatey package manager
Grpc 1.54.0 built from source
CMake
NASM

Compilation Steps for windows

Follow these steps to compile the ArmoniK API client and server:

From a PowerShell, go to the folder package/cpp/tools

PowerShell

cd packages\cpp\tools

This will install the required dependencies and compile the ArmoniK API client and server.

Wait for the script to complete. This may take some time, depending on the speed of your machine and the size of the project.

Once the script has completed, you should see the compiled output in the install directory. From the root folder of repository ArmoniK.API

PowerShell

cd packages\cpp\tools\win64

Troubleshooting

If you encounter any issues during the compilation process, try the following troubleshooting steps:

Make sure you have all the prerequisites installed correctly.
Check that you are running PowerShell as an administrator.

Install Docker on your Linux system. Follow the instructions on the official Docker documentation.
Clone the repository containing the source code and the necessary scripts.

Compilation Steps

Open a terminal in the root directory of the cloned repository.
Run the build-worker.sh script:
```
cd packages/cpp/tools
./build-worker.sh
```
The build-worker.sh script does the following:
- Sets the image tag for the Docker image.
- Determines the absolute paths of the necessary directories (script, working, and root directories).
- Changes to the root directory where the Protos are located.
- Builds the worker Docker image using the Dockerfile.worker file.
Now you should have the final image
Once the worker image has been built, you can use the following command to list all the Docker images available on your system:
```
docker images | grep armonik-api-cpp
```