esoubiran-aneo / armonik.core-api

ArmoniK.Core

What is ArmoniK.Core?

This project is part of the ArmoniK project. ArmoniK.Core is responsible for the implementation of the services needed for ArmoniK which are defined in ArmoniK.Api.

ArmoniK.Core provides services for submitting computational tasks, keeping track of the status of the tasks and retrieving the results of the computations. The tasks are processed by external workers whose interfaces are also defined in ArmoniK.Api. ArmoniK.Core sends tasks to the workers, manages eventual errors during the execution of the tasks and manages also the storage of the task's results.

More detailed information on the inner working of ArmoniK.Core is available here.

Installation

ArmoniK.Core can be installed only on Linux machines. For Windows users, it is possible to do it on WSL2.

Prerequisites

• Terraform version >= 1.4.2
• Just >= 1.8.0
• Dotnet >= 6.0
• Docker >= 20.10.16
• GitHub CLI >= 2.23.0 (optional)

Local deployment

To deploy ArmoniK.Core locally, you need first to clone the repository ArmoniK.Core. Then, to see all the available recipes for deployment, place yourself at the root of the repository ArmoniK.Core where the justfile is located, and type on your command line:

just

More about local deployment, see Local Deployment of ArmoniK.Core.

Tests

There are a number of tests that help to verify the successful installation of ArmoniK.Core. Some of them require a full deployment of ArmoniK.Core, for others a partial deployment is enough.

More about tests, see Tests of ArmoniK.Core.

Contribution

Contributions are always welcome!

See ArmoniK.Community for ways to get started.