Project

General

Profile

Installation Guide » History » Version 29

Sergey Smolov, 07/26/2019 01:15 PM

1 1 Alexander Kamkin
h1. Installation Guide
2
3 4 Alexander Kamkin
{{toc}}
4
5 28 Sergey Smolov
h2. Setting Environment Variables
6 23 Sergey Smolov
7
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):
8
9 28 Sergey Smolov
h3. Windows
10 23 Sergey Smolov
11
# Open the @System Properties@ window.
12
# Switch to the @Advanced@ tab.
13
# Click on Environment Variables.
14
# Click @New...@ under @System Variables@.
15
# In the @New System Variable@ dialog specify variable name as @NAME@ and variable value as @VALUE@.
16
# Click @OK@ on all open windows.
17
# Reopen the command prompt window.
18
19 28 Sergey Smolov
h3. Linux
20 23 Sergey Smolov
21
Add the command below to the @~.bash_profile@ file (Linux):
22
<pre>export NAME=VALUE</pre> 
23
To start editing the file, type @vi ~/.bash_profile@. 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.
24
25 1 Alexander Kamkin
h2. Eclipse IDE Installation
26
27 28 Sergey Smolov
Retrascope IDE is implemented as an Eclipse IDE plugin. Thus, Eclipse IDE and JDK 1.8 are the first things you need to install:
28 1 Alexander Kamkin
29 23 Sergey Smolov
# Download "JDK 1.8":https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html and install it.
30 24 Sergey Smolov
# Download the "Eclipse IDE":http://www.eclipse.org package (Luna) and install it.
31 19 Sergey Smolov
32 1 Alexander Kamkin
h2. Solver Installation
33 2 Alexander Kamkin
34 23 Sergey Smolov
Retrascope core uses Z3 constraint solver to perform analysis of HDL descriptions.
35 18 Sergey Smolov
36
# Download the "Z3":https://github.com/Z3Prover/z3/releases package and unpack it.
37 23 Sergey Smolov
# Set the @SMT_SOLVER_PATH@ environment variable to the Z3 executable file.
38 18 Sergey Smolov
39 1 Alexander Kamkin
h2. Model checker Installation
40 18 Sergey Smolov
41 23 Sergey Smolov
Retrascope core uses NuXMV model checker to generate functional tests for HDL descriptions.
42 18 Sergey Smolov
43 26 Sergey Smolov
# Download the "NuXMV":https://nuxmv.fbk.eu package and unpack it.
44 23 Sergey Smolov
# Set the @NUXMV_PATH@ environment variable to the NuXMV executable file.
45 8 Alexander Kamkin
46 2 Alexander Kamkin
h2. Zest Installation
47 7 Alexander Kamkin
48 29 Sergey Smolov
Some of the Retrascope IDE engines depend on Zest visualization framework (e.g., it is used to visualize CFG and EFSM models).
49 7 Alexander Kamkin
50
# Click the @Help/Install New Software...@ menu item.
51 1 Alexander Kamkin
# Choose a repository from the @Work with...@ list (e.g., @http://download.eclipse.org/releases/luna/201409261001@).
52 7 Alexander Kamkin
# Select the @Modeling/Graphical Editing Framework Zest Visualization Toolkit SDK@ tree item.
53 1 Alexander Kamkin
# Push the @Next@ button a number of times.
54 2 Alexander Kamkin
# Push the @Finish@ button.
55
56 1 Alexander Kamkin
h2. Veditor Installation
57
58 29 Sergey Smolov
Veditor is an Eclipse IDE plugin that provides Verilog and VHDL code viewers and editors.
59 1 Alexander Kamkin
60 25 Sergey Smolov
# Download the @net.sourceforge.veditor_*.jar@ file from "here":http://sourceforge.net/projects/veditor.
61 1 Alexander Kamkin
# Copy the file to the @<ECLIPSE_HOME>/plugins@ directory.
62
63 23 Sergey Smolov
h2. Configure your OS (for VHDL designs only!)
64
65
Retrascope uses "ZamiaCAD" framework for VHDL designs elaboration.
66
67
# Download and install "Python interpreter":http://https://www.python.org (it is needed for VHDL designs elaboration).
68
# Set @ZAMIA_LOCKING@ environment variable to @true@ value.
69
70 11 Alexander Kamkin
h2. Retrascope IDE Installation
71
72 12 Alexander Kamkin
Finally, install the "Retrascope IDE":http://forge.ispras.ru/projects/retrascope-ide plugin:
73 11 Alexander Kamkin
74 25 Sergey Smolov
# Download the @ru.ispras.retrascope.ide*.jar@ file from "here":http://forge.ispras.ru/projects/retrascope-ide/files.
75 14 Sergey Smolov
# Copy the file to the @<ECLIPSE_HOME>/plugins@ directory.
76 13 Sergey Smolov
# Restart the "Eclipse IDE":http://www.eclipse.org.