C++TESK Testing ToolKit

h1. Installation Guide

h2. Introduction

This document describes the steps should be followed to install "С++TESK Testing ToolKit":http://forge.ispras.ru/projects/cpptesk-toolkit (hereinafter C++TESK). In addition to C++TESK, "Icarus Verilog":http://iverilog.icarus.com and "VeriTool":http://forge.ispras.ru/projects/veritool (hereinafter Verilog tools) are recommended to be installed (they are used for generating C/C++ API for Verilog modules).

Before installing the toolkit make sure that [[System Requirements]] are met.

h2. Installation

h3. Basic Installation (Recommended)

To install C++TESK, pass the following steps:

# Download the latest version of the C++TESK package (@cpptesk-toolkit-src-*.tar.gz@) from the "Files":http://forge.ispras.ru/projects/cpptesk-toolkit/files page.

# Unzip the downloaded archive:

<pre>

% tar xf cpptesk-toolkit-src-*.tar.gz

</pre>

# Run the @install.sh@ script as follows.

* To install C++TESK without installing the Verilog tools, run:

<pre>

% install.sh

</pre>

* To install C++TESK together with the Verilog tools not reinstalling the Verilog tools if they have been already installed, run:

<pre>

% install.sh --install-veritool

</pre>

* To install C++TESK and (re)install the Verilog tools, run:

<pre>

% install.sh --force-install-veritool

</pre>

Home directories for the tools are chosen according to the following rules:

# If the environment variable @$ISPRAS_HOME@ is not set, it will be assigned to the user’s home directory (usually, @/home/<user-name>@).

# If the environment variable @$CPPTESK_HOME@ is not set, it will be assigned to the value @$ISPRAS_HOME/tools/cpptesk-toolkit@.

# If the environment variable @$ICARUS_HOME@ is not set, it will be assigned to the value @$ISPRAS_HOME/tools/verilog@.

# It the environment variable @$VERITOOL_HOME@ is not set, it will be assigned to the value @$ISPRAS_HOME/tools/veritool@.

C++TESK is installed into the directory @$CPPTESK_HOME@.

Icarus Verilog (if it is required) is installed into the directory @$ICARUS_HOME@.

VeriTool (if it is required) is installed into the directory @$VERITOOL_HOME@.

h3. Manual Installation of the Verilog Tools

The Verilog tools can be installed manually.

To install Icarus Verilog, pass the following steps:

# Download the Icarus Verilog package from "here":http://sourceforge.net/projects/iverilog/files/iverilog.

# If the environment variable @$ICARUS_HOME@ is not set, it should be assigned:

<pre>

% export ICARUS_HOME=<path-to-icarus-verilog-installation-directory>

% echo "export ICARUS_HOME=$ICARUS_HOME" >> "$HOME/.profile"

% echo "export ICARUS_HOME=$ICARUS_HOME" >> "$HOME/.bashrc"

</pre>

# Create the @$ICARUS_HOME@ directory if it does not exist:

<pre>

% mkdir -p "$ICARUS_HOME"

</pre>

# Unzip the downloaded archive and compile the sources:

<pre>

% tar xf verilog-<version-number>.tar.gz

% cd verilog-<version-number>

% ./configure --prefix="$ICARUS_HOME"

% make && make install

</pre>

To install VeriTool, pass the following steps:

# Download the VeriTool package from "here":http://forge.ispras.ru/projects/veritool/files.

# If the environment variable @$VERITOOL_HOME@ is not set, it should be assigned:

<pre>

% export VERITOOL_HOME=<path-to-veritool-installation-directory>

% echo "export VERITOOL_HOME=$VERITOOL_HOME" >> "$HOME/.profile"

% echo "export VERITOOL_HOME=$VERITOOL_HOME" >> "$HOME/.bashrc"

</pre>

# Create the @$VERITOOL_HOME@ directory if it does not exist:

<pre>

% mkdir -p "$VERITOOL_HOME"

</pre>

# Unzip the downloaded archive and compile the sources:

<pre>

% tar xf veritool-<version-number>.tar.gz

% cd veritool-<version-number>

% ./configure --prefix="$VERITOOL_HOME"

% make all && make install

</pre>