avl-core 0.1.0__tar.gz

avl_core-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [avl@projectapheleia.net]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

avl_core-0.1.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.3
+Name: avl-core
+Version: 0.1.0
+Summary: Apheleia Verification Library. A set of Python base classes for efficient HDL verification.
+License: MIT License
+         
+         Copyright (c) [2025] [avl@projectapheleia.net]
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+Author: avl
+Author-email: avl@projectapheleia.net
+Maintainer: avl
+Maintainer-email: avl@projectapheleia.net
+Requires-Python: >=3.10
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Provides-Extra: dev
+Requires-Dist: anytree (>=2.13.0)
+Requires-Dist: black (>=22.3.0) ; extra == "dev"
+Requires-Dist: cocotb (>=1.9.1)
+Requires-Dist: graphviz (>=0.20.3)
+Requires-Dist: matplotlib (>=3.10.0) ; extra == "dev"
+Requires-Dist: mypy (>=0.910) ; extra == "dev"
+Requires-Dist: pandas (>=2.2.3)
+Requires-Dist: pytest (>=7.0) ; extra == "dev"
+Requires-Dist: pyyml (>=0.0.2)
+Requires-Dist: ruff (>=0.11.0) ; extra == "dev"
+Requires-Dist: sphinx (>=8.1.3) ; extra == "dev"
+Requires-Dist: sphinx_rtd_theme (>=3.0.2) ; extra == "dev"
+Requires-Dist: tabulate (>=0.9.0)
+Requires-Dist: z3-solver (>=4.15.0.0)
+Description-Content-Type: text/markdown
+
+# AVL - Apheleia Verification Library
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/Python-3.7%2B-blue)](https://www.python.org/)
+
+
+AVL has been developed by experienced, industry professional verification engineers to provide a methodology \
+and library of base classes for developing functional verification environments in [Python](https://www.python.org/).
+
+AVL is built on the [CocoTB](https://docs.cocotb.org/en/stable/) framework, but aims to combine the best elements of \
+[UVM](https://accellera.org/community/uvm) in a more engineer friendly and efficient way.
+
+
+---
+
+## 📦 Installation
+
+### Using `pip`
+```sh
+# Standard build
+pip install avl-core
+
+# Development build
+pip install avl-core[dev]
+```
+
+### Install from Source
+```sh
+git clone https://github.com/projectapheleia/avl.git
+cd avl
+
+# Standard build
+pip install .
+
+# Development build
+pip install .[dev]
+```
+
+Alternatively if you want to create a [virtual environment](https://docs.python.org/3/library/venv.html) rather than install globally a script is provided. This will install, with edit privileges to local virtual environment.
+
+This script assumes you have  [Verilator](https://www.veripool.org/verilator/), [GTKWave](https://gtkwave.sourceforge.net/) and [Graphviz](https://graphviz.org/download/) installed, so all examples and documentation will build out of the box.
+
+
+```sh
+git clone https://github.com/projectapheleia/avl.git
+cd avl
+source avl.sh
+```
+
+## 📖 Documentation
+
+In order to build the documentation you must have installed the development build.
+
+### Build from Source
+```sh
+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:
+
+```sh
+cd examples
+
+# To run
+make -j 8 sim
+
+# To clean
+make -j 8 clean
+```
+
+To run an individual example:
+
+```sh
+cd examples/THE EXAMPLE YOU WANT
+
+# To run
+make sim
+
+# To clean
+make clean
+```
+
+The examples use the [CocoTB Makefile](https://docs.cocotb.org/en/stable/building.html) and default to [Verilator](https://www.veripool.org/verilator/) with all waveforms generated. This can be modified using the standard CocoTB build system.
+
+---
+
+
+## 🧹 Code Style & Linting
+
+This project uses [**Ruff**](https://docs.astral.sh/ruff/) for linting and formatting.
+
+Check code for issues:
+
+```sh
+ruff check .
+```
+
+Automatically fix common issues:
+
+```sh
+ruff check . --fix
+```
+
+
+
+## 📧 Contact
+
+- Email: avl@projectapheleia.net
+- GitHub: [projectapheleia](https://github.com/projectapheleia)
+

avl_core-0.1.0/README.md

@@ -0,0 +1,114 @@
+# AVL - Apheleia Verification Library
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/Python-3.7%2B-blue)](https://www.python.org/)
+
+
+AVL has been developed by experienced, industry professional verification engineers to provide a methodology \
+and library of base classes for developing functional verification environments in [Python](https://www.python.org/).
+
+AVL is built on the [CocoTB](https://docs.cocotb.org/en/stable/) framework, but aims to combine the best elements of \
+[UVM](https://accellera.org/community/uvm) in a more engineer friendly and efficient way.
+
+
+---
+
+## 📦 Installation
+
+### Using `pip`
+```sh
+# Standard build
+pip install avl-core
+
+# Development build
+pip install avl-core[dev]
+```
+
+### Install from Source
+```sh
+git clone https://github.com/projectapheleia/avl.git
+cd avl
+
+# Standard build
+pip install .
+
+# Development build
+pip install .[dev]
+```
+
+Alternatively if you want to create a [virtual environment](https://docs.python.org/3/library/venv.html) rather than install globally a script is provided. This will install, with edit privileges to local virtual environment.
+
+This script assumes you have  [Verilator](https://www.veripool.org/verilator/), [GTKWave](https://gtkwave.sourceforge.net/) and [Graphviz](https://graphviz.org/download/) installed, so all examples and documentation will build out of the box.
+
+
+```sh
+git clone https://github.com/projectapheleia/avl.git
+cd avl
+source avl.sh
+```
+
+## 📖 Documentation
+
+In order to build the documentation you must have installed the development build.
+
+### Build from Source
+```sh
+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:
+
+```sh
+cd examples
+
+# To run
+make -j 8 sim
+
+# To clean
+make -j 8 clean
+```
+
+To run an individual example:
+
+```sh
+cd examples/THE EXAMPLE YOU WANT
+
+# To run
+make sim
+
+# To clean
+make clean
+```
+
+The examples use the [CocoTB Makefile](https://docs.cocotb.org/en/stable/building.html) and default to [Verilator](https://www.veripool.org/verilator/) with all waveforms generated. This can be modified using the standard CocoTB build system.
+
+---
+
+
+## 🧹 Code Style & Linting
+
+This project uses [**Ruff**](https://docs.astral.sh/ruff/) for linting and formatting.
+
+Check code for issues:
+
+```sh
+ruff check .
+```
+
+Automatically fix common issues:
+
+```sh
+ruff check . --fix
+```
+
+
+
+## 📧 Contact
+
+- Email: avl@projectapheleia.net
+- GitHub: [projectapheleia](https://github.com/projectapheleia)

avl_core-0.1.0/avl/__init__.py

@@ -0,0 +1,141 @@
+from ._core import (
+    Agent as Agent,
+)
+from ._core import (
+    Bool as Bool,
+)
+from ._core import (
+    Byte as Byte,
+)
+from ._core import (
+    Component as Component,
+)
+from ._core import (
+    Coverage as Coverage,
+)
+from ._core import (
+    Coverbin as Coverbin,
+)
+from ._core import (
+    Covercross as Covercross,
+)
+from ._core import (
+    Covergroup as Covergroup,
+)
+from ._core import (
+    Coverpoint as Coverpoint,
+)
+from ._core import (
+    Double as Double,
+)
+from ._core import (
+    Driver as Driver,
+)
+from ._core import (
+    Enum as Enum,
+)
+from ._core import (
+    Env as Env,
+)
+from ._core import (
+    Factory as Factory,
+)
+from ._core import (
+    Fifo as Fifo,
+)
+from ._core import (
+    Float as Float,
+)
+from ._core import (
+    Fp16 as Fp16,
+)
+from ._core import (
+    Fp32 as Fp32,
+)
+from ._core import (
+    Fp64 as Fp64,
+)
+from ._core import (
+    Half as Half,
+)
+from ._core import (
+    IndexedScoreboard as IndexedScoreboard,
+)
+from ._core import (
+    Int as Int,
+)
+from ._core import (
+    Int8 as Int8,
+)
+from ._core import (
+    Int16 as Int16,
+)
+from ._core import (
+    Int32 as Int32,
+)
+from ._core import (
+    Int64 as Int64,
+)
+from ._core import (
+    List as List,
+)
+from ._core import (
+    Log as Log,
+)
+from ._core import (
+    Logic as Logic,
+)
+from ._core import (
+    Model as Model,
+)
+from ._core import (
+    Monitor as Monitor,
+)
+from ._core import (
+    Object as Object,
+)
+from ._core import (
+    Phase as Phase,
+)
+from ._core import (
+    PhaseManager as PhaseManager,
+)
+from ._core import (
+    Port as Port,
+)
+from ._core import (
+    Queue as Queue,
+)
+from ._core import (
+    Scoreboard as Scoreboard,
+)
+from ._core import (
+    Sequence as Sequence,
+)
+from ._core import (
+    SequenceItem as SequenceItem,
+)
+from ._core import (
+    Sequencer as Sequencer,
+)
+from ._core import (
+    Transaction as Transaction,
+)
+from ._core import (
+    Uint as Uint,
+)
+from ._core import (
+    Uint8 as Uint8,
+)
+from ._core import (
+    Uint16 as Uint16,
+)
+from ._core import (
+    Uint32 as Uint32,
+)
+from ._core import (
+    Uint64 as Uint64,
+)
+from ._core import (
+    Visualization as Visualization,
+)

avl_core-0.1.0/avl/_core/__init__.py

@@ -0,0 +1,93 @@
+from .agent import Agent
+from .bool import Bool
+from .component import Component
+from .coverage import Coverage
+from .coverbin import Coverbin
+from .covercross import Covercross
+from .covergroup import Covergroup
+from .coverpoint import Coverpoint
+from .driver import Driver
+from .enum import Enum
+from .env import Env
+from .factory import Factory
+from .fifo import Fifo
+from .float import Double, Float, Fp16, Fp32, Fp64, Half
+from .int import Byte, Int, Int8, Int16, Int32, Int64
+from .list import List, Queue
+from .log import Log
+from .logic import Logic
+from .model import Model
+from .monitor import Monitor
+from .object import Object
+from .phase import Phase
+from .phase_manager import PhaseManager
+from .port import Port
+from .scoreboard import Scoreboard
+from .scoreboard_indexed import IndexedScoreboard
+from .sequence import Sequence
+from .sequence_item import SequenceItem
+from .sequencer import Sequencer
+from .transaction import Transaction
+from .uint import Uint, Uint8, Uint16, Uint32, Uint64
+from .visualization import Visualization
+
+# Enable logging
+Log._override_cocotb_logging()
+
+# Add default phases
+PhaseManager.add_phase("RUN", None, top_down=False)
+PhaseManager.add_phase("REPORT", PhaseManager.get_phase("RUN"), top_down=False)
+
+# Add version
+__version__: str = "0.1.0"
+
+__all__ = [
+    "__version__",
+    "Log",
+    "List",
+    "Queue",
+    "Fifo",
+    "Port",
+    "Phase",
+    "Phase_Manager",
+    "Object",
+    "Transaction",
+    "Component",
+    "Driver",
+    "Sequencer",
+    "Monitor",
+    "Model",
+    "Scoreboard",
+    "IndexedScoreboard",
+    "Agent",
+    "Env",
+    "SequenceItem",
+    "Sequence",
+    "Logic",
+    "Bool",
+    "Int",
+    "Int8",
+    "Byte",
+    "Int16",
+    "Int32",
+    "Int64",
+    "Uint",
+    "Uint8",
+    "Uint16",
+    "Uint32",
+    "Uint64",
+    "Fp16",
+    "Half",
+    "Fp32",
+    "Float",
+    "Fp64",
+    "Double",
+    "Enum",
+    "Coverbin",
+    "Coverpoint",
+    "Covercross",
+    "Covergroup",
+    "Coverage",
+    "Visualization",
+    "Factory",
+]

avl_core-0.1.0/avl/_core/agent.py

@@ -0,0 +1,20 @@
+# Copyright 2024 Apheleia
+#
+# Description:
+# Apheleia Verification Library Agent
+
+from .component import Component
+
+
+class Agent(Component):
+    def __init__(self, name: str, parent: Component) -> None:
+        """
+        Initialize the avl_agent instance.
+        :param name: Name of the agent instance
+        :type name: str
+        :param parent: Parent component
+        :type parent: Component
+        """
+        super().__init__(name, parent)
+
+__all__ = ["Agent"]

avl_core-0.1.0/avl/_core/bool.py

@@ -0,0 +1,46 @@
+# Copyright 2024 Apheleia
+#
+# Description:
+# Apheleia Verification Library Variable Class
+
+from collections.abc import Callable
+from typing import Any
+
+from .logic import Logic
+
+
+class Bool(Logic):
+    def __init__(self, name: str, value: bool, auto_random: bool = True, fmt : Callable[..., int] = str) -> None:
+        """
+        Initialize an instance of the Bool class.
+
+        :param name: The name of the instance.
+        :type name: str
+        :param value: The initial value of the instance.
+        :type value: bool
+        :param auto_random: Flag indicating whether the instance should be automatically randomized, defaults to True.
+        :type auto_random: bool, optional
+        """
+        super().__init__(name, value, auto_random=auto_random, fmt=fmt, width=1)
+
+    def _cast_(self, other: Any) -> int:
+        """
+        Cast the value to the appropriate type based on the width of the variable.
+        :param other: The value to be cast.
+        :type other: Any
+        :return: The casted value.
+        :rtype: bool
+        """
+        return bool(super()._cast_(other))
+
+    def _wrap_(self, result : Any) -> Logic:
+        """
+        Wrap the result in an Logic instance.
+        :param result: The result to be wrapped.
+        :type result: Any
+        :return: An instance of Logic with the result.
+        :rtype: Logic
+        """
+        return type(self)(self.name, result, auto_random=self._auto_random_, fmt=self._fmt_)
+
+__all__ = ["Bool"]