diff --git a/kmath-noa/README.md b/kmath-noa/README.md index f1c193f9b..b69d0ce93 100644 --- a/kmath-noa/README.md +++ b/kmath-noa/README.md @@ -12,14 +12,33 @@ differentiable program written on top of ## Installation +Currently, we support only +the [GNU](https://gcc.gnu.org/) toolchain for the native artifacts. +For `GPU` kernels, we require a compatible +[CUDA](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html) +installation. If you are on Windows, we recommend setting up +everything on [WSL](https://docs.nvidia.com/cuda/wsl-user-guide/index.html). + To install the library, you can simply publish to the local Maven repository: ``` ./gradlew -q :kmath-noa:publishToMavenLocal ``` -This will fetch and build native artifacts as well. -Currently, we support only -the [GNU](https://gcc.gnu.org/) toolchain. For `GPU` kernels, we require a compatible -[CUDA](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html) -installation. If you are on Windows, we recommend setting up -everything on [WSL](https://docs.nvidia.com/cuda/wsl-user-guide/index.html). +This will fetch and build the `JNI` wrapper `jnoa`. + +In your own application add the local dependency: +```kotlin +repositories { + mavenCentral() + mavenLocal() +} + +dependencies { + implementation("space.kscience:kmath-noa:0.3.0-dev-14") +} +``` +To load the native library you will need to add to the VM options: +``` +-Djava.library.path=${HOME}/.konan/third-party/noa-v0.0.1/cpp-build/kmath +``` +