Skip to content

Latest commit

 

History

History
executable file
·
154 lines (104 loc) · 3.72 KB

README.md

File metadata and controls

executable file
·
154 lines (104 loc) · 3.72 KB

ktools

This is the POSIX-compliant Oasis 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 and libtool on debian distros or 'Development Tools' on red hat needs to be installed in Linux.

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

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.

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.

Windows Installation

Pre-requisites

Cygwin 64-bit is required for the Windows native build. Cygwin is a Linux environment running in Windows. http://www.cygwin.com/

Download and run the set-up program for Cygwin. The following Cygwin add-in packages are required;

  • gcc-g++
  • gcc-core
  • make
  • diffutils
  • automake
  • libtools

To build native Windows 64-bit executables;

  • mingw64-x86_64-gcc-g++
  • mingw64-x86_64-gcc-core

Search for 'mingw', gcc', 'make' and 'diffutils' to find all of the relevant packages (Only 'gcc' illustrated below). alt text

Instructions

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

Open a Cygwin terminal.

alt text

Change directory to the location of the tar.gz.

Extract the files using the following command

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

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

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

Configure using the following command;

$ ./winconfigure

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 executables are located in C:/Oasis/bin. You should add this bin folder to your path in System Environment Variables.

alt text

The installation is complete. Restart the Cygwin session to refresh the path before usage.

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 v2.X installed):

$ cd examples
$ python eltcalc_example.py 

Questions/problems?

Email [email protected]