MicroTESK

h1. Installation Guide

*UNDER CONSTRUCTION*

h3. System Requirements

MicroTESK is a set of Java-based utilities that are run from the command line. It can be used on *_Windows, Linux and OS X_* machines that have *_JDK 1.6 or later_* installed. To build MicroTESK from source code or to build generated Java models, *_Apache Ant version 1.8_ or later* is required. To generate test data based on constraints, MicroTESK needs *_Microsoft Research Z3_* that can work under the corresponding operating system. 

h3. Installation Steps

# Download and unpack the MicroTESK installation package (the .tar.gz file) to your computer.

# Download and install constraint solver tools to the <installation folder>/tools folder (see the "Installing Constraint Solver Tools" section).

# Open your console terminal and set the <installation folder>/bin as the working directory.

# Now you can run the compile.sh (or .bat) script to create a microprocessor model and the generate.sh (or .bat) script to generate test for this model.

h3. Installing Constraint Solver Tools

To generate test data based on constraint, MicroTESK requires external constraint solver engines. The current version uses the Z3 constraint solver by Microsoft Research (http://z3.codeplex.com/). The Z3 executable should be downloaded and placed to the <installation folder>/tools folder.

UNIX (Linux): "tools/z3/unix/z3"

Windows:      "tools/z3/windows/z3.exe"

OS X:         "tools/z3/osx/z3"

h3. Installation Folder Structure

The MicroTESK installation folder contains the following subfolders:

# _arch_   Examples of microprocessor specifications and test templates for the described designs.

# _bin_    Scripts to run features of MicroTESK (modelling and test generation).

# _doc_    Documentation on MicroTESK and nML/Sim-nML.

# _libs_   JAR files and Ruby scripts to perform modelling and test generation tasks.

# _output_ Generated Java models of the specified microprocessor designs.

h3. Running MicroTESK