Installation Guide¶

Introduction¶

This document describes the steps should be followed to install С++TESK Testing ToolKit (hereinafter C++TESK). In addition to C++TESK, Icarus Verilog and 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.

Installation¶

Basic Installation (Recommended)¶

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

1. Download the latest version of the C++TESK package (cpptesk-toolkit-src-<version-number>.tar.gz) from the Files page.
2. Unzip the downloaded archive:
   

   % tar xf cpptesk-toolkit-src-<version-number>.tar.gz
   

3. Run the install.sh script as follows.

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

  % install.sh
  

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

  % install.sh --install-veritool
  

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

  % install.sh --force-install-veritool
  

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

1. If the environment variable ISPRAS_HOME is not set, ISPRAS_HOME=<user-home-directory>.
2. If the environment variable CPPTESK_HOME is not set, CPPTESK_HOME=$ISPRAS_HOME/tools/cpptesk-toolkit.
3. If the environment variable ICARUS_HOME is not set, ICARUS_HOME=$ISPRAS_HOME/tools/verilog.
4. It the environment variable VERITOOL_HOME is not set, VERITOOL_HOME=$ISPRAS_HOME/tools/veritool.

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

Icarus Verilog and VeriTool (if they are required) are installed into $ICARUS_HOME and $VERITOOL_HOME, respectively.

Manual Installation of the Verilog Tools¶

The Verilog tools can be installed manually.

To install Icarus Verilog, pass the following steps:

1. Download the Icarus Verilog package from here.
2. If the environment variable ICARUS_HOME is not set, it should be assigned:
   

   % 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" 
   

3. Create the $ICARUS_HOME directory if it does not exist:
   

   % mkdir -p "$ICARUS_HOME" 
   

4. Unzip the downloaded archive and compile the sources:
   

   % tar xf verilog-<version-number>.tar.gz
   % cd verilog-<version-number>
   % ./configure --prefix="$ICARUS_HOME" 
   % make && make install
   

To install VeriTool, pass the following steps:

1. Download the VeriTool package from here.
2. If the environment variable VERITOOL_HOME is not set, it should be assigned:
   

   % export VERITOOL_HOME=<path-to-veritool-installation-directory>
   % echo "export VERITOOL_HOME=$VERITOOL_HOME" >> "$HOME/.profile" 
   % echo "export VERITOOL_HOME=$VERITOOL_HOME" >> "$HOME/.bashrc" 
   

3. Create the $VERITOOL_HOME directory if it does not exist:
   

   % mkdir -p "$VERITOOL_HOME" 
   

4. Unzip the downloaded archive and compile the sources:
   

   % tar xf veritool-<version-number>.tar.gz
   % cd veritool-<version-number>
   % ./configure --prefix="$VERITOOL_HOME" 
   % make all && make install