Versal ACAP Power Tool part 2 - Installing the Pre-Built Power Tool

Under the most common circumstances, you will not need to install anything. The Versal Power Tool comes pre-installed with the System Controller Board Evaluation and Management (BEAM) Tool, and also comes pre-installed with the Versal Board Support Package (BSP). If this is the case, then you can simply proceed to the next section to use the Power Tool. However, there may be some custom cases where the Power Tool is not supported, either a new product or a custom configuration, where you may want to install and port the Versal Power Tool.


Table of Contents



1 Setup

If you are starting with the System Controller BEAM Tool, proceed to section 1.1. If you are starting with the Versal BSP, proceed to section 1.2. If you are installing the python from git, then proceed to section 1.3.

1.1 Software Setup - System Controller BEAM Tool

To run the Power Tool on the System Controller, the Power Tool comes pre-installed with the System Controller BEAM Tool, and may have been supplied on a pre-programmed uSD card for the System Controller. To set up the BEAM tool, follow the instructions here.
Beam Tool for VMK180 Evaluation Kit

1.2 Software Setup - Versal BSP

To run the Power Tool on the Versal, the Power Tool comes pre-installed with the Versal BSP. To use the Versal BSP in a PetaLinux build, follow the instructions in Documentation > ug1144 PetaLinux Tools Documentation: Reference Guide - Chapter 3 "Creating a Project / PetaLinux BSP Installation".
 

1.3 Software Setup - Python from Git

This section will be helpful to you if you are internal to Xilinx or otherwise have access to the raw files in the Git repository. In this section, you will know how to identify and install both the Power Tool Python library (poweradvantage.py) and the Power Tool Jupyter Notebook (Power_Advantage_Tool.ipynb) from your Git repository (https://github.com/Xilinx/jupyter-pat). 

1.3.1 Power Tool Python library: poweradvantage.py

jupyter-pat directory contains the poweradvantage folder which contains the Python code poweradvantage.py and other support files. This is installed to the target System Controller Linux by an SSH file copy of the entire folder to the Python library folder. The name of this Python library folder will depend on the current version of Python. For Python 3.7 the copy path would be /usr/lib/python3.7/site-packages.


1.3.2 Power Tool Jupyter Notebook: Power_Advantage_Tool.ipynb

jupyter-pat directory contains the Jupyter Notebook Power_Advantage_Tool.ipynb and its artwork folder img. This notebook is installed to the target System Controller Linux by an SSH file copy of Power_Advantage_Tool.ipynb and its artwork folder img to the folder where Jupyter Notebooks are found. The path of the Jupyter Notebooks folder is commonly /home/root. You may choose to use a sub-folder if you wish to organize your Jupyter notebooks.

1.4 Common Setup Issues

  • No known issues.

Related Links

Home Previous Next