mirror of
https://github.com/openhwgroup/cvw
synced 2025-02-02 17:55:19 +00:00
README/tool installation merge
This commit is contained in:
parent
ba4e0d2721
commit
120da12414
31
README.md
31
README.md
@ -11,15 +11,15 @@ Wally is described in an upcoming textbook, *RISC-V System-on-Chip Design*, by H
|
|||||||
|
|
||||||
New users may wish to do the following setup to access the server via a GUI and use a text editor.
|
New users may wish to do the following setup to access the server via a GUI and use a text editor.
|
||||||
|
|
||||||
|
Git started with Git configuration and authentication: B.1 (replace with your name and email)
|
||||||
|
$ git config --global user.name "Ben Bitdiddle"
|
||||||
|
$ git config --global user.email "ben_bitdiddle@wally.edu"
|
||||||
|
$ git config --global pull.rebase false
|
||||||
Optional: Download and install x2go - A.1.1
|
Optional: Download and install x2go - A.1.1
|
||||||
Optional: Download and install VSCode - A.4.2
|
Optional: Download and install VSCode - A.4.2
|
||||||
Optional: Make sure you can log into your server via x2go and via a terminal
|
Optional: Make sure you can log into your server via x2go and via a terminal
|
||||||
Terminal on Mac, cmd on Windows, xterm on Linux
|
Terminal on Mac, cmd on Windows, xterm on Linux
|
||||||
See A.1 about ssh -Y login from a terminal
|
See A.1 about ssh -Y login from a terminal
|
||||||
Git started with Git configuration and authentication: B.1
|
|
||||||
$ git config --global user.name ″Ben Bitdiddle″
|
|
||||||
$ git config --global user.email ″ben_bitdiddle@wally.edu″
|
|
||||||
$ git config --global pull.rebase false
|
|
||||||
|
|
||||||
Then clone the repo, source setup, make the tests and run regression
|
Then clone the repo, source setup, make the tests and run regression
|
||||||
|
|
||||||
@ -30,20 +30,19 @@ Then clone the repo, source setup, make the tests and run regression
|
|||||||
|
|
||||||
On the Linux computer where you will be working, log in
|
On the Linux computer where you will be working, log in
|
||||||
|
|
||||||
Add the following lines to your .bashrc or .bash_profile to run the setup script each time you log in.
|
Clone your fork of the repo and run the setup script.
|
||||||
|
|
||||||
if [ -f ~/cvw/setup.sh ]; then
|
|
||||||
source ~/cvw/setup.sh
|
|
||||||
fi
|
|
||||||
|
|
||||||
Clone your fork of the repo, run the setup script, and build the tests:
|
|
||||||
|
|
||||||
$ cd
|
$ cd
|
||||||
$ git clone --recurse-submodules https://github.com/<yourgithubid>/cvw
|
$ git clone --recurse-submodules https://github.com/<yourgithubid>/cvw
|
||||||
$ git remote add upstream https://github.com/openhwgroup/cvw
|
$ git remote add upstream https://github.com/openhwgroup/cvw
|
||||||
$ cd cvw
|
$ cd cvw
|
||||||
$ source ./setup.sh
|
$ source ./setup.sh
|
||||||
$ make
|
|
||||||
|
Add the following lines to your .bashrc or .bash_profile to run the setup script each time you log in.
|
||||||
|
|
||||||
|
if [ -f ~/cvw/setup.sh ]; then
|
||||||
|
source ~/cvw/setup.sh
|
||||||
|
fi
|
||||||
|
|
||||||
Edit setup.sh and change the following lines to point to the path and license server for your Siemens Questa and Synopsys Design Compiler installation and license server. If you only have Questa, you can still simulate but cannot run logic synthesis.
|
Edit setup.sh and change the following lines to point to the path and license server for your Siemens Questa and Synopsys Design Compiler installation and license server. If you only have Questa, you can still simulate but cannot run logic synthesis.
|
||||||
|
|
||||||
@ -52,8 +51,11 @@ Edit setup.sh and change the following lines to point to the path and license se
|
|||||||
export QUESTAPATH=/cad/mentor/questa_sim-2021.2_1/questasim/bin # Change this for your path to Questa
|
export QUESTAPATH=/cad/mentor/questa_sim-2021.2_1/questasim/bin # Change this for your path to Questa
|
||||||
export SNPSPATH=/cad/synopsys/SYN/bin # Change this for your path to Design Compiler
|
export SNPSPATH=/cad/synopsys/SYN/bin # Change this for your path to Design Compiler
|
||||||
|
|
||||||
Run a regression simulation with Questa to prove everything is installed.
|
If the tools are not yet installed on your server, follow the Toolchain Installation instructions in the section below.
|
||||||
|
|
||||||
|
Build the tests and run a regression simulation with Questa to prove everything is installed. Building tests will take a while.
|
||||||
|
|
||||||
|
$ make
|
||||||
$ cd sim
|
$ cd sim
|
||||||
$ ./regression-wally (depends on having Questa installed)
|
$ ./regression-wally (depends on having Questa installed)
|
||||||
|
|
||||||
@ -66,6 +68,9 @@ This section describes the open source toolchain installation. These steps shou
|
|||||||
The full installation details are involved can be be skipped using the following script, wally-tool-chain-install.sh.
|
The full installation details are involved can be be skipped using the following script, wally-tool-chain-install.sh.
|
||||||
The script installs the open source tools to /opt/riscv by default. This can be changed by supply the path as the first argument. This script does not install buildroot (see the Detailed Tool-chain Install Guide in the following section) and does not install commercial EDA tools; Siemens Questa, Synopsys Design Compiler, or Cadence Innovus (see section Installing IDA Tools). It must be run as root or with sudo. This script is tested for Ubuntu, 20.04 and 22.04. Fedora and Red Hat can be installed in the Detailed Tool-chain Install Guide.
|
The script installs the open source tools to /opt/riscv by default. This can be changed by supply the path as the first argument. This script does not install buildroot (see the Detailed Tool-chain Install Guide in the following section) and does not install commercial EDA tools; Siemens Questa, Synopsys Design Compiler, or Cadence Innovus (see section Installing IDA Tools). It must be run as root or with sudo. This script is tested for Ubuntu, 20.04 and 22.04. Fedora and Red Hat can be installed in the Detailed Tool-chain Install Guide.
|
||||||
|
|
||||||
|
modify lines 34-36 of bin/wally-tool-chain-install to increase the number of threads to 8 or 16 to speed up installation
|
||||||
|
if you are on a machine with plenty of memory.
|
||||||
|
|
||||||
$ sudo bin/wally-tool-chain-install.sh <optional, install directory, defaults to /opt/riscv>
|
$ sudo bin/wally-tool-chain-install.sh <optional, install directory, defaults to /opt/riscv>
|
||||||
|
|
||||||
## Detailed Toolchain Install Guide
|
## Detailed Toolchain Install Guide
|
||||||
|
@ -140,5 +140,4 @@ curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo
|
|||||||
&& sudo apt install gh -y
|
&& sudo apt install gh -y
|
||||||
|
|
||||||
# Other python libraries used through the book.
|
# Other python libraries used through the book.
|
||||||
sudo pip3 install matplotlib scipy sklearn adjustText leif
|
pip3 install matplotlib scipy scikit-learn adjustText lief
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user