Retrascope » Retrascope IDE

h1. Installation Guide

{{toc}}

h2. Eclipse IDE Installation

The "Retrascope IDE":http://forge.ispras.ru/projects/retrascope-ide is implemented as an "Eclipse IDE":http://www.eclipse.org plugin. Thus, "Eclipse IDE":http://www.eclipse.org is the first thing you need to install (except "JDK 1.7":http://www.oracle.com/technetwork/java/javase/downloads/index.html):

# Download the "Eclipse IDE":http://www.eclipse.org package (Luna) from http://www.eclipse.org and unpack it.

h2. Solver Installation

The "Retrascope":http://forge.ispras.ru/projects/retrascope core uses Z3 solver to perform analysis of HDL descriptions (e.g., to extract EFSM models). To install Z3 and make Retrascope able to work with it, perform the following steps:

# Download the "Z3":https://github.com/Z3Prover/z3/releases package and unpack it.

# Specify the @SMT_SOLVER_PATH@ environment variable (it should point to the Z3 executable file).

h2. Model checker Installation

The "Retrascope":http://forge.ispras.ru/projects/retrascope core uses the "NuXMV":https://nuxmv.fbk.eu model checker to generate functional tests for HDL descriptions. To install "NuXMV":https://nuxmv.fbk.eu and make "Retrascope":http://forge.ispras.ru/projects/retrascope able to work with it, perform the following steps:

# Download the "NuXMV":https://nuxmv.fbk.eu package from https://nuxmv.fbk.eu and unpack it.

# Specify the @NUXMV_PATH@ environment variable (it should point to the NuXMV executable file).

h2. Zest Installation

Some of the "Retrascope IDE":http://forge.ispras.ru/projects/retrascope-ide engines depends on the "Zest":http://eclipse.org/gef/zest/ framework (e.g., it is used to visualize CFG and EFSM models). It is recommended to install it before working with the environment:

# Click the @Help/Install New Software...@ menu item.

# Choose a repository from the @Work with...@ list (e.g., @http://download.eclipse.org/releases/luna/201409261001@).

# Select the @Modeling/Graphical Editing Framework Zest Visualization Toolkit SDK@ tree item.

# Push the @Next@ button a number of times.

# Push the @Finish@ button.

h2. Veditor Installation

"Veditor":http://sourceforge.net/projects/veditor is an "Eclipse IDE":http://www.eclipse.org plugin implementing Verilog and VHDL code viewers and editors. To install "Veditor":http://sourceforge.net/projects/veditor, do the following:

# Download the @net.sourceforge.veditor_*.jar@ file from http://sourceforge.net/projects/veditor.

# Copy the file to the @<ECLIPSE_HOME>/plugins@ directory.

h2. Retrascope IDE Installation

Finally, install the "Retrascope IDE":http://forge.ispras.ru/projects/retrascope-ide plugin:

# Download the @ru.ispras.retrascope.ide*.jar@ file from http://forge.ispras.ru/projects/retrascope-ide/files.

# Copy the file to the @<ECLIPSE_HOME>/plugins@ directory.

# Set @ZAMIA_LOCKING@ system variable to @true@ value (it is needed for VHDL designs elaboration).

# Download and install "Python interpreter":http://https://www.python.org (it is needed for VHDL designs elaboration).

# Restart the "Eclipse IDE":http://www.eclipse.org.