Metadata-Version: 2.4
Name: vunit-vivado
Version: 0.1.0
Summary: A VUnit package providing helper utilities for using Vivado-generated IPs and project sources with VUnit.
Author-email: Lars Asplund <lars.anders.asplund@gmail.com>
License-Expression: MPL-2.0
Project-URL: homepage, https://github.com/VUnit/vunit-vivado
Keywords: vunit,vunitpkg,verification,vhdl,fpga,vivado,amd,xilinx
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Description-Content-Type: text/markdown
License-File: LICENSE.md
Dynamic: license-file

# vunit-vivado

A VUnit package providing helper utilities for integrating Vivado projects and IPs with VUnit.

## Overview

`vunit-vivado` simplifies the use of Vivado-generated sources in VUnit-based simulations.

The package provides:

- `create_compile_order_file` — extracts source files, libraries, and compile-order dependencies from a Vivado project.
- `add_from_compile_order_file` — adds the extracted sources to a VUnit project with the required library mappings and
  dependencies.

## Installation

```bash
pip install vunit-vivado
```

## Example

An example project demonstrating the package utilities is available in the examples/ directory. See the included
`README` files for additional information.
