.. avl documentation master file, created by
   sphinx-quickstart on Sun Jan 12 13:21:12 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Apheleia Verification Library Documentation
===========================================

.. image:: /images/apheleia_logo.png
   :align: center

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   introduction/introduction
   quickstart/quickstart
   overview/isa
   overview/elf
   overview/trace
   packages/packages
   modules/all_modules

.. code-block:: bash

    usage: avl-riscv-coverage [-h] [--ref REF] [--extensions [EXTENSIONS ...]] [--packages [PACKAGES ...]] [--elf ELF] [--trace TRACE] [--output OUTPUT] [--html] [--verbose]

    options:
      -h, --help            show this help message and exit
      --ref REF             Pointer to instr_dict.json (generated from https://github.com/riscv/riscv-opcodes) (default: ./avl-riscv-coverage/avl_riscv_coverage/instr_dict.json)
      --extensions [EXTENSIONS ...
                            List of extensions
      --packages [PACKAGES ...]
                            List of python packages containing covergroups
      --elf ELF             Elf file for testcase
      --trace TRACE         List of trace files
      --output OUTPUT       Output directory for report
      --html                Generate HTML report
      --verbose             Verbose messages


Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`