khiva-csharp

Build Documentation	Build Linux and Mac OS	Build Windows	Code Coverage

README

This is the Khiva C# binding, it allows the usage of Khiva library from C#.

License

This project is licensed under MPL-v2.

Quick Summary

This C# binding called 'khiva' provides all the functionalities of the KHIVA library for time series analytics.

Set up

In order to use this binding, you need to install Khiva library.

Prerequisites

• C# 7.3 or later
• Mono 5.20.1 or later

Install latest version

Install latest stable version of Khiva library. Follow the steps in the "Installation" section of the Khiva repository

To install the Khiva C# binding, we just need to include the dll in our project or use the Nuget package Khiva.

Install any release

Install the prerequisites listed in the "Installation" section of the Khiva library repository. Download and install your selected Khiva release from Khiva repository.

Install the Khiva C# binding compatible with the Khiva library installed previously.

Compiling code

Run the following command from the project root folder:

msbuild /p:Configuration=Release /p:platform=x64 Khiva.sln

Executing the tests

All tests can be executed separately, please find them in /test.

Running tests on MacOS

Run the following command from the project root folder:

mono ./packages/NUnit.ConsoleRunner.3.9.0/tools/nunit3-console.exe test/bin/x64/Release/Khiva.Tests.dll

Documentation

This Khiva C# binding uses Sphinx to generate the documentation.

In order to generate the documentation (in html format), run the following command under the folder:

sphinx-build.exe -b html doc/sphinx/source/ build/doc/html/

Contributing

The rules to contribute to this project are described here