Manual setup

Since CI/CD services typically provide full-featured Ubuntu/Debian, Windows and/or macOS environments, regular installation procedures can be used (see Installing). That is, an HDL simulator and Python need to be installed by any means.

Important

When installing the development version of VUnit, remember to install the dependencies (see requirements.txt).

Due to the single supported open source simulator being GHDL, most users on GitHub are likely to install it along with VUnit. There are six possible procedures to setup GHDL:

• ghdl.rtfd.io: Releases and sources:

  • Use a package manager, such as apt or pacman.

  • Get and extract a tarball/zipfile from the latest stable release: github.com/ghdl/ghdl/releases/latest.

  • Get and extract a tarball/zipfile from the nightly pre-release: github.com/ghdl/ghdl/releases/nightly.

    • (On GitHub Actions only) Use Action ghdl/setup-ghdl-ci.

• Use one of the Docker/OCI images provided in ghdl/docker.

• Build it from sources: ghdl.rtfd.io: Building GHDL from Sources.

Hint

Since building GHDL each time is time-consuming, it is recommented to use pre-built tarballs/zipfiles or Docker/OCI images. Images/containers usually provide the fastest startup time, because all the dependencies can be pre-installed already.