shapelets / khiva-java

Java binding for Khiva library.

Khiva-Java

Build Linux and Mac OS	Build Windows	Code Coverage

README

This is the Khiva binding for Java, it allows the usage of Khiva library from Java.

License

This project is licensed under MPL-v2.

Quick Summary

This Java package called 'khiva' provides all the functionalities of the Khiva library for time series analytics.

Requirements

• Arrayfire
• Khiva library
• JAVA SDK 1.8
• Maven

Set up

Just execute the next command in the root directory of the project:

mvn install

Executing the tests:

Execute the next command in the root directory of the project:

 mvn test

Note: The tests are executed automatically when the package is installed.

Documentation

This Java package follows the standard way of writing documentation of Java code using Javadoc.

In order to generate the documentation, execute the next command in the root directory of the project:

mvn javadoc:javadoc

Contributing

The rules to contribute to this project are described here

khiva-java's Issues

Change load khiva library

Currently, we are loading khiva from a given folder, thus our users are not free to install our library in the folder they want/can. This limitation is given by the following snippet of code in Library.java file.

    static {
        OS = System.getProperty("os.name").toLowerCase();
        if (OS.indexOf("mac") >= 0) {
            System.load("/usr/local/lib/libkhiva_jni.dylib");
        } else if (OS.indexOf("win") >= 0) {
            System.load("C:\\Program Files\\Khiva\\v0\\lib\\khiva_jni.dll");
        } else if (OS.indexOf("nix") >= 0 || OS.indexOf("nux") >= 0 || OS.indexOf("aix") > 0) {
            System.load("/usr/local/lib/libkhiva_jni.so");
        }
    }

To overcome this limitation, we should remove the full path, and let Java look for the library in System.getProperty("java.library.path"). By default, it points to LD_LIBRARY_PATH.