Retrascope

h1. Installation Guide

h2. Prerequisites

For VHDL code elaboration we use "ZamiaCAD":http://zamiacad.sourceforge.net/web/ toolkit.

For constraint solving we use "Z3":http://z3.codeplex.com/ SMT solver.

For model checking we use "nuXmv":https://es-static.fbk.eu/tools/nuxmv/ tool (see distribution below).

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. Retrascope Installation

# Download and install "JDK 1.11":https://openjdk.java.net/projects/jdk/11/

# Download and install SMT-LIBv2 solver. We recommend to use "Z3 4.3":https://github.com/Z3Prover/z3/releases/tag/z3-4.3.2.

# Set either the system property @smt.solver.path@ or the environment variable @SMT_SOLVER_PATH@ to a full path to a SMT-solver executable file (for example, "/home/user/tools/z3/z3" or "C:\tools\z3\bin\z3.exe") in order to run solver-dependent tasks. If the both are set, a value of @fortress.solver.path@ will be used.

# Download and install "nuXmv":https://es-static.fbk.eu/tools/nuxmv/index.php?n=Download.Download model checker.

# Set either the system property @nuxmv.path@ or the environment variable @NUXMV_PATH@ to a full path to a NuXMV executable file (for example, "/home/user/tools/nuxmv/nuXmv" or "C:\tools\nuxmv\nuXmv.exe") in order to run checker-dependent tasks.

# For VHDL designs elaboration:

  a) Set @ZAMIA_LOCKING@ environment variable to @true@.

  b) Download and install "Python interpreter":http://https://www.python.org. 

# Download, unpack and use the tool through it's "Command Line Options":http://forge.ispras.ru/projects/retrascope/wiki/Command_Line_Options/edit.