Retrascope » Retrascope IDE

h1. Installation Guide

{{toc}}

h2. Setting Environment Variables

Several steps below require environment variable to be set in your OS. When you encounter such step in the guide, do the following (substitute NAME and VALUE by the name and value of your environment variable respectively):

h3. Windows

# Open the @System Properties@ window.

# Switch to the @Advanced@ tab.

# Click on Environment Variables.

# Click @New...@ under @System Variables@.

# In the @New System Variable@ dialog specify variable name as @NAME@ and variable value as @VALUE@.

# Click @OK@ on all open windows.

# Reopen the command prompt window.

h3. Linux

Add the command below to the @~/.bash_profile@ or @~/.bashrc@ file (Linux):

<pre>export NAME=VALUE</pre> 

Changes will be applied after restarting the command-line terminal or reboot. You can also execute the command in your command-line terminal to make temporary changes.

h2. Eclipse IDE Installation

Retrascope IDE is implemented as an Eclipse IDE plugin. Thus, Eclipse IDE and JDK 1.8 are the first things you need to install:

# Download "JDK 1.8":https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html and install it.

# Download the "Eclipse IDE":https://www.eclipse.org/photon package (Photon) and install it.

h2. Solver Installation

Retrascope core uses Z3 constraint solver to perform analysis of HDL descriptions.

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

# Set the @SMT_SOLVER_PATH@ environment variable to the Z3 executable file (for example, "/home/user/tools/z3/z3" or "C:\tools\z3\bin\z3.exe").

h2. Model checker Installation

Retrascope core uses nuXmv model checker to generate functional tests for HDL descriptions.

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

# Set the @NUXMV_PATH@ environment variable to the nuXmv executable file (for example, "/home/user/tools/nuxmv/nuXmv" or "C:\tools\nuxmv\nuXmv.exe").

h2. Zest Installation

Some of the Retrascope IDE engines depend on Zest visualization framework (e.g., it is used to visualize CFG and EFSM models).

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

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

# 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. SVeditor Installation

SVeditor is an Eclipse IDE plugin that provides Verilog and VHDL code viewers and editors.

# Run Eclipse

# Go to Help -> Eclipse Marketplace -> Search -> SVeditor -> Install("I agree...") -> Finish.

# Restart Eclipse.

h2. Configure your OS (for VHDL designs only!)

Retrascope uses "ZamiaCAD" framework for VHDL designs elaboration.

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

# Set @ZAMIA_LOCKING@ environment variable to @true@ value.

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 "here":http://forge.ispras.ru/projects/retrascope-ide/files.

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

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