Vivado GUI Container

Run Vivado in a reproducible and isolated environment. Supports both Linux and macOS, x86 and ARM systems.

About the project

It's important to state the features as well as the limitations of the project.

Features

• Customizable Vivado installation, packed inside your own container image
• Non-persistent container
• GUI support through X11 forwarding
• Easy setup and usage, thanks to wrapper scripts

Limitations

• No access to physical devices
• That's pretty much it

Getting Started

Important notes

The installation may take a really long time and appear stuck depending on your hardware and internet connection. Please be patient.

When saving your projects, always save them to `/home/vivado/projects'. Every other location is non-persistent. This will be binded to the project directory in this repo's root. You can freely move around the repo's directory in your PC without breaking the bind.

Prerequisites

• Git
• Docker installed on your system
• X11 server (for GUI support)
  • On Linux you're probably already set
  • On macOS you need to install XQuartz and enable network connections in the XQuartz settings

Enable x86 to ARM translation

If you're running an ARM system, like an Apple silicon Mac, you'll need to enable x86 to ARM translation in the Docker settings.

Clone this repository

Choose a suitable location to clone this repository, as it will be used as a working directory to save your projects.

git clone https://github.com/giacof0/vivado-gui-container.git

Obtain a Vivado installer

You'll have to download the installer yourself from the AMD website, then move it to the repository's directory. Don't rename the installer.

Build the Container

./build.sh

Run the Container

./run.sh

Usage

Just run the container with

./run.sh

Once inside the container, make sure to save your projects to /home/vivado/projects, as it's set as a persistent directory that will be shared with the host system.

Contributing

If you think you can improve the project, feel free to open a pull request.

FAQ

Q: On macOS, there are some black artifacts when resizing the window.
A: This is due to a regression in macOS 26. Unfortunately this needs to be fixed by Apple, or to be worked around in XQuartz, which has been unmantained for the past two years. For now, just resize the window until it works.

License

This project has been released under the GPLv3 license.
See LICENSE for details.

Acknowledgements

• Xilinx/AMD Vivado
• Docker