Full VUnit functionality requires Python (3.6 or higher) and a simulator supported by the VUnit Python test runner (see list below). However, VUnit can run with limited functionality entirely within VHDL using the VHDL test runner.
VUnit supports VHDL (93, 2002, 2008 and 2019), Verilog and (experimentally) SystemVerilog.
VUnit is known to work on GNU/Linux, Windows and Mac OS; on x86, x64, armv7 and aarch64.
Aldec Riviera-PRO: Tested with Riviera-PRO 2015.06, 2015.10, 2016.02, 2016.10 (x64/x86).
Aldec Active-HDL: Tested with Active-HDL 9.3, 10.1, 10.2, 10.3 (x64/x86).
Tested with LLVM and mcode backends; GCC backend might work aswell.
Works with versions >= 0.33.
GHDL is a rolling project, it is therefore recommended to use the latest nightly release tarball.
NVC: Works with versions >= 1.9.
GHDL and NVC support using GTKWave to view waveforms.
VHDL or SystemVerilog#
Mentor Graphics ModelSim/Questa: Tested with 10.1 - 10.5
Cadence Incisive (Experimental)
Community contribution by Colin Marquardt. VUnit maintainers do not have access to this simulator to verify the functionality.
incisive_vhdl_fixup.pyto remove VHDL constructs that are not compatible with Incisive.
Using the Python Package Manager#
The recommended way to get VUnit is to install the latest stable release via pip:
> pip install vunit_hdl
Once installed, VUnit may be updated to new versions via a similar method:
> pip install -U vunit_hdl
Using the Development Version#
Start by cloning our GIT repository on GitHub:
git clone --recurse-submodules https://github.com/VUnit/vunit.git
--recurse-submodules option initializes OSVVM which is included as a submodule in the VUnit repository.
To be able to import
VUnit in your
you need to make it visible to Python or else the following error
Traceback (most recent call last): File "run.py", line 2, in <module> from vunit import VUnit ImportError: No module named vunit
There are three methods to make VUnit importable in your
Install it in your Python environment using:
> python setup.py install
PYTHONPATHenvironment variable to include the path to the VUnit repository root directory. Note that you shouldn’t point to the vunit directory within the root directory.
Add the following to your
run.pyfile before the
import sys sys.path.append("/path/to/vunit_repo_root/") import vunit
For VUnit Developers#
For those interested in development of VUnit, it is best to install
VUnit so that the sources from git are installed in-place instead of
to the Python site-packages directory. This can be achieved by using
-e flag with
pip, or the
develop option with
setup.py, or setting the
PYTHONPATH environment variable.
> git clone https://github.com/VUnit/vunit.git > cd vunit > python setup.py develop or > pip install -e .
By installing VUnit in this manner, the git sources can be edited directly in
your workspace while the
VUnit package is still globally available in your