Installation Guide » History » Revision 61
Revision 60 (Sergey Smolov, 02/18/2020 06:04 PM) → Revision 61/63 (Sergey Smolov, 02/18/2020 06:10 PM)
h1. Installation Guide
{{toc}}
h2. Before we start: 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 11 (use " *AdoptOpenJDK* ":https://adoptopenjdk.net/ for Windows and *openjdk-11-jdk* for Ubuntu Linux based OS).
# Download and install SMT-LIBv2 solver " *Z3 version 4.3 or higher* ":https://github.com/Z3Prover/z3.
# Set @SMT_SOLVER_PATH@ environment variable to a +full path to SMT-solver executable+ (like "/home/user/z3/bin/z3" or "C:\tools\z3\bin\z3.exe").
# Retrascope uses "*nuXmv*":https://nuxmv.fbk.eu/ or "*NuSMV*":http://nusmv.fbk.eu/ to perform model checking.
Due to license limitations, we recommend to use NuSMV for commercial projects and nuXmv for non-commercial ones.
Choose the most suitable model checker and do the following:
## To use *nuXmv*:
### Download and install "nuXmv":https://es-static.fbk.eu/tools/nuxmv/index.php?n=Download.Download model checker.
### Set @NUXMV_PATH@ environment variable to a +full path to nuXmv executable+ (like "/home/user/nuxmv/nuXmv" or "C:\tools\nuxmv\nuXmv.exe").
## To use *NuSMV*:
### Download and install "NuSMV":http://nusmv.fbk.eu/NuSMV/download/getting-v2.html model checker.
### Set @NUSMV_PATH@ environment variable to a +full path to NuSMV executable+ (like "/home/user/nusmv/bin/NuSMV" or "C:\tools\nusmv\bin\NuSMV.exe").
# For *VHDL* designs elaboration:
## Set @ZAMIA_LOCKING@ environment variable to @true@.
## Download and install " *Python interpreter* ":https://www.python.org.
# Download and unpack the " *Retrascope* ":https://forge.ispras.ru/projects/retrascope/files.
To make sure the tool is successfully installed use '--check' command line option.
Enter installed, enter the @retrascope@ installation directory and run the following command for Windows OS:
<pre>
>bin\retrascope.bat --check
Retrascope version: 1.1.3-beta-SNAPSHOT
2020.02.17 17:11:30.258. INFO: SMT solver is installed here: C:\Program Files\z3\bin\z3.exe
2020.02.17 17:11:30.298. INFO: Z3 version 4.3.2
2020.02.17 17:11:30.308. WARNING: 'NUSMV_PATH' env variable is not set.
2020.02.17 17:11:30.308. INFO: nuXmv is installed here: C:\Program Files\nuxmv\nuXmv.exe
2020.02.17 17:11:31.288. INFO: *** This is nuXmv 1.0.1 (compiled on Mon Nov 17 16:54:49 2014)
2020.02.17 17:11:31.288. WARNING: Set 'ZAMIA_LOCKING' environment variable to 'true' for VHDL designs processing
2020.02.17 17:11:31.318. INFO: Python 3.8.1
</pre>
For Linux-based OS:
<pre>
$ ./bin/retrascope --check
Retrascope version: 1.1.3-beta-SNAPSHOT
2020.02.14 17:20:23.717. INFO: SMT solver is installed here: /home/tools/z3-4.7.1-x64-ubuntu-16.04/bin/z3
2020.02.14 17:20:23.759. INFO: Z3 version 4.7.1 - 64 bit
2020.02.14 17:20:23.759. WARNING: 'NUSMV_PATH' env variable is not set.
2020.02.14 17:20:23.760. INFO: nuXmv is installed here: /home/tools/nuxmv-1.0.1-linux-x86_64/nuXmv
2020.02.14 17:20:23.774. INFO: *** This is nuXmv 1.0.1 (compiled on Mon Nov 17 16:49:54 2014)
2020.02.14 17:20:23.774. INFO: 'ZAMIA_LOCKING' environment variable is set to 'true'
2020.02.14 17:20:23.776. INFO: Python 2.7.17
</pre>
h2. What's next?
# To understand the main concept of the Retrascope architecture see "Overview":http://forge.ispras.ru/projects/retrascope/wiki/Overview
# For quick overview of common use cases see "Getting Started":http://forge.ispras.ru/projects/retrascope/wiki/Getting_Started
# For full guide of the tool options see "Command Line Options":http://forge.ispras.ru/projects/retrascope/wiki/Command_Line_Options
# To understand the scientific foundations of the tool see "Retrascope-Related Publications":https://forge.ispras.ru/projects/retrascope/wiki/Retrascope-Related_Publications