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

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>@).

# 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

If the computer is not connected to the Internet, manual installation of Icarus Verilog and VeriTool is required. Installation packages can be downloaded using the following addresses: http://sourceforge.net/projects/iverilog/files/iverilog/0.9.4/verilog-0.9.4.tar.gz and http://forge.ispras.ru/projects/veritool/files.

For manual installation of Icarus Verilog the following steps should be passed:

# If the system variable $ICARUS_HOME is not set, it should be assigned. E.g., the following command sequence can help:

<pre>

export ICARUS_HOME=<path_for_Icarus_Verilog_installation>

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

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

</pre>

# It the folder $ICARUS_HOME does not exist, it should be created:

<pre>

mkdir -p "$ICARUS_HOME"

</pre>

# Having changed the directory to the one with installation package of Icarus Verilog, it is necessary to apply the following command sequence:

<pre>

tar xf verilog-0.9.4.tar.gz

cd verilog-0.9.4

./configure --prefix="$ICARUS_HOME"

make && make install

</pre>

For manual installation of VeriTool the following steps should be passed:

# If the system variable $VERITOOL_HOME is not set, it should be assigned. E.g., the following command sequence can help:

<pre>

export VERITOOL_HOME=< _path_for_VeriTool_installation_ >

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

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

</pre>

# It the folder $VERITOOL_HOME does not exist, it should be created:

<pre>

mkdir -p "$VERITOOL_HOME"

</pre>

# Having changed the directory to the one with installation package of VeriTool, it is necessary to apply the following command sequence:

<pre>

tar xf veritool-0.2.1-beta-20110702.tar.gz

cd veritool-0.2.1-beta-20110702

./configure --prefix="$VERITOOL_HOME"

make all && make install

</pre>