AVL-RAL- Apheleia Verification Library Register Abstraction Layer

AVL-RAL has been developed by experienced, industry professional verification engineers to provide a simple,
extensible verification component integrating a Register Abstraction Layer (RAL) based on systemdrl.
developed in Python and the AVL library.

AVL is built on the CocoTB framework.

CocoTB 2.0

AVL-RAL supports CocoTB2.0 https://docs.cocotb.org/en/development/upgrade-2.0.html. This was introduced in v0.2.0.

Component Features

📦 Installation

Unfortunately avl-ral isn't available on PyPi. As such to pip install you need to use the longer avl-register-abstraction-layer name. Once install avl_ral is the short-cut.

Using pip

# Standard build
pip install avl-register-abstraction-layer

# Development build
pip install avl-register-abstraction-layer[dev]

Install from Source

git clone https://github.com/projectapheleia/avl-ral.git
cd avl-ral

# Standard build
pip install .

# Development build
pip install .[dev]

Alternatively if you want to create a virtual environment rather than install globally a script is provided. This will install, with edit privileges to local virtual environment.

This script assumes you have Graphviz and appropriate simulator installed, so all examples and documentation will build out of the box.

git clone https://github.com/projectapheleia/avl-ral.git
cd avl-ral
source avl-ral.sh

📖 Documentation

In order to build the documentation you must have installed the development build.

Build from Source

cd docs
make html
<browser> build/html/index.html

🏃 Examples

In order to run all the examples you must have installed the development build.

To run all examples:

cd examples

# To run
make -j 8 sim

# To clean
make -j 8 clean

To run an individual example:

cd examples/THE EXAMPLE YOU WANT

# To run
make sim

# To clean
make clean

The examples use the CocoTB Makefile and default to Verilator with all waveforms generated. This can be modified using the standard CocoTB build system.

🧹 Code Style & Linting

This project uses Ruff for linting and formatting.

Check code for issues:

ruff check .

Automatically fix common issues:

ruff check . --fix

📧 Contact

• Email: avl@projectapheleia.net
• GitHub: projectapheleia