UVM Testbench Flow diagram with Python

Introduction

uvm_tb_arch_doc_py is a python script to automatically generate the UVM testbench Architecture.

It reads a UVM simulation log file and converts in to a JPEG diagram.

What you Achieve

A UVM Testbench Architecture Template using the PythonScript.

Refer the pdf file attached in the main directory - uvm_tb_arch_doc_py_diagram.pdf

Requirements

For generating the UVM TB Architecture we have to write an example testbench code (top, test, env, agent etc) in UVM Methodology.

1. UVM Testbench log file with extension .log format

2. Pycharm Editor (version 2021.1.1 x64)

3. Libraries required:

   • OpenCV ( To help with plotting the image and to also save the generated testbench image)

   • PIL (Includes functions like Image, ImageDraw. ImageFont)

   • Tkinter (Help with setting up the canvas for plotting the image)

4. Packages to be installed:

   • pip install pillow
   • pip install opencv-python
   • pip install python-docx

Usage

The PyCharm Editor is suitable to run this project as it provides an environment to install packages within a terminal present in the editor.

-- Youtube link to be provided how to use

1. open the Pycharm editor.

2. click File -> New Project.

3. Create the project in a specific directory.

4. Configure the base interpreter of python if it is already installed on the system. If python is not present in the system, install Pycharm and then there will be an option provided to set a base interpreter.

5. Create a virtual environment for your project. ( This setup will take 2-3 minutes).

6. Open the Pycharm terminal and install the packages one after another as mentioned in point 4) of the Requirements section.

7. Create a folder named 'log' in the project directory.

8. Copy all the files into the Project directory that has been created. (For example, the path I have created is C:\Users\Priya A\PycharmProjects\UVM_TB_ARCH)

9. Make sure to copy the log file into the log folder in the project.(For example, suppose the log file has a name testbench.log, then the file should be in the folder named 'log')

10. Execute the Python Script by clicking on the Run button in Pycharm

11. The output window will ask the user to enter the following:

    • Enter the name of the log directory (Enter 'log')

    • Enter the number of interfaces (for eg:4)

    • Enter the number of agents (for eg: 2)

    • Enter the number of tb connect to DUT (for eg: 3 it depends on how many interfaces you want to conenct with DUT)

12. The output testbench will then be displayed in the background as per ther various inputs provided.