Data

Tools

Indexes

Applications

Experiments

Open Source Science

caveat

Framework for Context-Aware Verification, Emulation, and Training

https://github.com/eras-research/caveat

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.0%) to scientific vocabulary

Keywords

cocotb education fpga verification
Last synced: 6 months ago · JSON representation ·

Repository

Framework for Context-Aware Verification, Emulation, and Training

Basic Info
  • Host: GitHub
  • Owner: ERAS-Research
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 674 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 13
  • Releases: 0
Topics
cocotb education fpga verification
Created about 1 year ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

CAVEAT

Context-Aware Verification, Emulation, and Training

Scope

Verification using vendor-specific as well as independent simulators and frameworks is a fundamental and well established step to successful digital design. Similarly, software-defined configuration and operation of hardware has significantly improved accessibility of technology. In fact, modern software-defined experiment design allows scientists and cross-disciplinary users to propose novel modes of operation within hours or even minutes.

This vendor-agnostic framework decouples application development, design verification, and training from the immediate availability of sensitive, unwieldy, and costly hardware installations. Moreover, it facilitates feasibility studies prior to investments as well as reproducibility of research results.

The framework is designed with three distinct needs of academic and development laboratories in mind: 1. streamlining context-aware verification for supervised operation, 2. hardware emulation for ease of application software development, and 3. an environment for experiential training of prospective users.

It distinguishes two distinct aspects of verification: 1. static (topologic), and 2. dynamic (algorithmic).

For basic examples on how to do this, please see slides presented at FPGA Conference Europe 2025.

Dependencies

(see requirements.txt)

Installation (inside virtual environment)

Bash sudo apt install python-venv activate virtual env Bash python3 -m venv caveatenv source caveatenv/bin/activate

Then ensure build is installed

Bash python3 -m pip install build

Install locally

In the caveat top level directory where pyproject.toml lives, run: Bash pip install -e .

To test the installed code, run: Bash cd example ./run_tests.py The test testloopbackthroughput will execute, and the results are placed in the subdirectory build/results/.

Recommended Tools (optional)

  • python 3.11+
  • pip
  • venv
  • pytest-reporter-html-dots for advanced html reporting
  • pytest-xdist for test parallelization (or pytest-parallel)

Owner

  • Name: ERAS-Research
  • Login: ERAS-Research
  • Kind: organization
  • Location: Canada

researching and implementing electronics in remote and adverse surroundings at the University of New Brunswick

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Reuschel"
  given-names: "Torsten"
  orcid: "https://orcid.org/0000-0001-7536-2215"
- family-names: "Murray"
  given-names: "Ferris"
  orcid: 
- family-names: "Trottier"
  given-names: "Philippe"
  orcid: 
title: "CAVEAT - a Framework for Context-Aware Verification, Emulation, and Training"
version: 0.1
doi: 
date-released: 2025-07-17
url: "https://github.com/ERAS-Research/caveat"

GitHub Events

Total
  • Delete event: 3
  • Issue comment event: 2
  • Push event: 2
  • Public event: 1
  • Pull request event: 4
  • Fork event: 1
  • Create event: 1
Last Year
  • Delete event: 3
  • Issue comment event: 2
  • Push event: 2
  • Public event: 1
  • Pull request event: 4
  • Fork event: 1
  • Create event: 1

Dependencies

.github/workflows/package-build-test-cov.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
pyproject.toml pypi
requirements.txt pypi
  • GitPython *
  • cocotb ==1.9.2
  • cocotb_test ==0.2.6
  • cocotbext-axi ==0.1.24
  • forastero >=1.2.1
  • kaleido >=1.0.0
  • matplotlib *
  • numpy *
  • plotly *
  • pytest >=7.3.1