Skip to content

Latest commit

 

History

History
201 lines (142 loc) · 5.47 KB

README.md

File metadata and controls

201 lines (142 loc) · 5.47 KB
Raw

Oasis LMF logo

ktools version Ktools Build

ktools

This is the POSIX-compliant Oasis LMF In-Memory Kernel toolkit.

Release

Please click here to download the latest release.

The source code will change on a regular basis but only the releases are supported. Support enquiries should be sent to [email protected].

There are build instructions for Windows 64-bit executables.

Note that the dynamic random number option in the Windows build uses a deterministic seed due to a bug in the mingw compiler. We recommend the random number file option (gulcalc -r) should be used in Windows.

This issue will be handled in future releases by implementing the rdrand random number generator in all environments.

Linux Installation

Pre-requisites

The g++ compiler build-essential, libtool, zlib1g-dev, autoconf, pkg-config on debian distros or 'Development Tools' and zlib-devel on red hat needs to be installed in Linux.

To enable Parquet format outputs (optional), version 7.0.0 of the Arrow Apache library is required. The recommended method is to build the library from source as follows;

$ mkdir build
$ cd build
$ git clone https://github.com/apache/arrow.git -b release-7.0.0
$ mkdir -p arrow/cpp/build-release
$ cd build/arrow/cpp/build-release
$ cmake -DARROW_PARQUET=ON -DARROW_BUILD_STATIC=ON -DARROW_OPTIONAL_INSTALL=ON ..
$ make -j$(nproc)
$ make install

More information on Arrow Apache.

Instructions

Copy ktools-[version].tar.gz onto your machine and untar.

$ tar -xvf ktools-[version].tar.gz

Go into the ktools folder and autogen using the following command;

$ cd ktools-[version]
$ ./autogen.sh

Configure using the following command;

$ ./configure

The configure script will attempt to find and link the appropriate Apache libraries to enable Parquet format output. This search for these libraries can be disabled manually with an extra flag:

$ ./configure --disable-parquet

On OS X add an extra flag:

$ ./configure --enable-osx

Make using the following command;

$ make

Next run the automated test to check the build and numerical results;

$ make check

Finally, install the executables using the following command;

$ [sudo] make install

The installation is complete. The executables are located in /usr/local/bin.

If installing the latest code from the git repository, clone the ktools repository onto your machine.

Go into the ktools folder and autogen using the following command;

$ cd ktools
$ ./autogen.sh

Follow the rest of the process as described above.

Cmake build - Experimental

Install Cmake from either system packages or cmake.org.

# create the build directory within ktools directory
$ mkdir build && cd build
$ ktools_source_dir=~/ktools
# Generate files and specify destination (here is in ./local/bin)
$ cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~/.local $ktools_source_dir

# Build
$ make all test

# If all is OK, install to bin subdir of the specified install prefix
$ make install

Windows Installation

Pre-requisites

MSYS2 64-bit is required for the Windows native build. MSYS2 is a Unix/Linux like development environment for building and distributing windows applications. https://www.msys2.org/

Download and run the set-up program for MSYS2 64-bit.

Open a MSYS2 terminal and perform the updates before continuing.

The following add-in packages are required;

  • autoconf
  • automake
  • git
  • libtool
  • make
  • mingw-w64-x86_64-toolchain
  • python

These packages can be installed at the MSYS2 terminal command line.

$ pacman -S autoconf automake git libtool make mingw-w64-x86_64-toolchain python

alt text

Instructions

Clone the github repository at the MSYS2 terminal command line

$ git clone https://github.com/OasisLMF/ktools.git

Go into the ktools folder and run autogen using the following command;

$ cd ktools
$ ./autogen.sh

Configure using the following command;

$ ./configure

Make using the following command;

$ make

Next run the automated test to check the build and numerical results;

$ make check

Finally, install the executables using the following command;

$ make install

The installation is complete. The executables are located in /usr/local/bin.

Usage

There is sample data and six example scripts which demonstrate how to invoke ktools in the /examples folder. These are written in python v2.

For example, to run the eltcalc_example script, go into the examples folder and run the following command (you must have python installed):

$ cd examples
$ python eltcalc_example.py

To build linux docker image do following command

docker build --file Dockerfile.ktools.alpine -t alpine-ktools .

Questions/problems?

Email [email protected]

License

The code in this project is licensed under BSD 3-clause license.