Quickstart Guide
================

This guide will help you get started with the AVL RISCV Coverage library. It will show you how to install the library, \
and how to use the library in your own projects.

Before you start this guide, you should have a basic understanding of Python and HDL languages such as Verilog or VHDL.

In order to run the examples you will need to have installed:

- `Python <https://www.python.org/downloads/>`_

- The `riscv GNU toolchain < https://github.com/riscv-collab/riscv-gnu-toolchain>`_`

Installing From pip
---------------------

.. code-block:: bash

    # Standard build
    pip install avl-riscv-coverage

    # Development build
    pip install avl-riscv-coverage[dev]

This will install the latest version of the library and all required dependencies.
If you want to install a specific version, you can specify the version number:

.. code-block:: bash

    pip install avl-riscv-coverage==0.1.0

Installing From Source
----------------------

AVL RISCV Coverage is available via `GitHub <https://github.com/projectapheleia/avl-riscv-coverage.git>`_.

All required libraries are included in the pyproject.toml file.

.. code-block:: bash

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

    # Standard build
    pip install .

    # Development build
    pip install .[dev]

Or if you plan on editing the source code, you can install in editable mode:

.. code-block:: bash

    git clone https://github.com/projectapheleia/avl-riscv-coverage.git
    cd avl-riscv-coverage
    pip install --editable .[dev]

A script is provided to setup a python virtual environment and install all dependencies for development.

.. code-block:: bash

    git clone https://github.com/projectapheleia/avl-riscv-coverage.git
    cd avl-riscv_coverage
    source avl-riscv-coverage.sh

Building The Docs
-----------------

.. code-block:: bash

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