Installation Guide¶

• Table of contents
• Installation Guide
  • Setting Environment Variables
    • Windows
    • Linux
  • Eclipse IDE Installation
  • Solver Installation
  • Model checker Installation
  • Zest Installation
  • SVeditor Installation
  • Configure your OS (for VHDL designs only!)
  • Retrascope IDE Installation

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):

Windows¶

1. Open the System Properties window.
2. Switch to the Advanced tab.
3. Click on Environment Variables.
4. Click New... under System Variables.
5. In the New System Variable dialog specify variable name as NAME and variable value as VALUE.
6. Click OK on all open windows.
7. Reopen the command prompt window.

Linux¶

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

export NAME=VALUE

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.

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:

1. Download JDK 1.8 and install it.
2. Download the Eclipse IDE package (Photon) and install it.

Solver Installation¶

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

1. Download the Z3 package and unpack it.
2. 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").

Model checker Installation¶

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

1. Download the nuXmv package and unpack it.
2. Set the NUXMV_PATH environment variable to the nuXmv executable file (for example, "/home/user/tools/nuxmv/nuXmv" or "C:\tools\nuxmv\nuXmv.exe").

Zest Installation¶

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

1. Click the Help/Install New Software... menu item.
2. Choose a repository from the Work with... list (e.g., http://download.eclipse.org/releases/photon).
3. Select the Modeling/Graphical Editing Framework Zest Visualization Toolkit SDK tree item.
4. Push the Next button a number of times.
5. Push the Finish button.

SVeditor Installation¶

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

1. Run Eclipse
2. Go to Help -> Eclipse Marketplace -> Search -> SVeditor -> Install("I agree...") -> Finish.
3. Restart Eclipse.

Configure your OS (for VHDL designs only!)¶

Retrascope uses "ZamiaCAD" framework for VHDL designs elaboration.

1. Download and install Python interpreter (it is needed for VHDL designs elaboration).
2. Set ZAMIA_LOCKING environment variable to true value.

Retrascope IDE Installation¶

Finally, install the Retrascope IDE plugin:

1. Download the ru.ispras.retrascope.ide*.jar file from here.
2. Copy the file to the <ECLIPSE_HOME>/plugins directory.
3. Restart the Eclipse IDE.