Recreating a Workspace with Scripts - 2024.1 English

Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393)

Document ID
UG1393
Release Date
2024-05-30
Version
2024.1 English

The Vitis Unified IDE keeps a log of the actions taken during the current session of the IDE. These actions let you recreate the workspace, components, and projects if necessary. The actions are recorded to the builder.py python script found in <workspace>/logs/ folder.

Note: The builder.py script records the actions taken in the Vitis Unified IDE for the duration of time the IDE is opened. When you close the IDE and reopen it, a new builder.py script is recorded. A limited number or older scripts are saved, but can be overwritten.

The builder.py script can be useful in the following ways:

  • Automate the component and application creation and configuration workflow in script mode so that the flow can be reproduced. This would require saving the builder.py created when the initial components and projects are created, and save it for use later.
  • To check in for source control only the source files and the workspace creation scripts, rather than the workspace metadata like vitis-comp.json and vitis-sys.json.
    Note: Checking in all workspace metadata is recommended.
Note: If you want to move the workspace to another location, you can move the workspace directory. The workspace is self-contained. Rebuilding the workspace is unnecessary in this case.

To use the builder.py script, edit the script as needed to modify paths and such, and then source the script to recreate the workspace:

vitis -s ./builder.py