Workspace Journal Coverage - 2025.2 English - UG1400

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
UG1400
Release Date
2025-11-20
Version
2025.2 English

From a workspace management perspective, the workspace journal logs all user actions documented in the previous pages. These include component creation, building and configuration modifications. Specifically, the following actions are logged:

  • Component creation
  • Component builds
  • Modification to configuration files (UserConfig.cmake, lscript.ld, hls.config.cfg, aie_compiler.cfg)

The following is an example of a workspace journal file that logs the creation of these components and edits to their configuration files.

import vitis

client = vitis.create_client()
client.set_workspace(path="vitis_2025.2_ws")

platform = client.create_platform_component(name = "vck190_platform",hw_design = "/project_2/ext_platform_wrapper.xsa",os = "aie_runtime",cpu = "ai_engine",domain_name = "aie_runtime_ai_engine",generate_dtb = False)

platform = client.get_component(name="vck190_platform")
status = platform.build()

comp = client.create_aie_component(name="simple_aie_application", platform = "/vitis_2025.2_ws/vck190_platform/export/vck190_platform/vck190_platform.xpfm", template = "installed_aie_examples/simple")

comp = client.get_component(name="simple_aie_application")
comp.build(target="hw")

comp.build(target="hw")

comp.build(target="hw")

comp = client.create_hls_component(name = "mm2s",cfg_file = ["hls_config.cfg"],template = "empty_hls_component")

comp = client.create_hls_component(name = "s2mm",cfg_file = ["hls_config.cfg"],template = "empty_hls_component")

proj = client.create_sys_project(name="simple_aie_application_system_project", platform="/vitis_2025.2_ws/vck190_platform/export/vck190_platform/vck190_platform.xpfm", template="empty_accelerated_application" , build_output_type="xsa")

proj = client.get_sys_project(name="simple_aie_application_system_project")

status = proj.add_container(name="binary_container_1")

proj = proj.add_component(name="mm2s", container_name="binary_container_1")

proj = proj.add_component(name="s2mm", container_name="binary_container_1")

proj = proj.add_component(name="simple_aie_application", container_name="binary_container_1")

cfg = client.get_config_file(path="/vitis_2025.2_ws/simple_aie_application_system_project/hw_link/binary_container_1-link.cfg")

cfg.add_lines(values=["param=compiler.addOutputTypes=hw_export"])

cfg = client.get_config_file(path="/vitis_2025.2_ws/simple_aie_application/aiecompiler.cfg")

cfg.set_value(section="aie", key="event-trace", value="runtime")

cfg.set_value(section="aie", key="xlopt", value="2")

cfg = client.get_config_file(path="/vitis_2025.2_ws/mm2s/hls_config.cfg")

cfg.set_value(section="hls", key="syn.compile.clang_version", value="7")

cfg.set_value(section="hls", key="package.output.format", value="rtl")

vitis.dispose()
Note: To view your workspace journal file, in the Vitis Unified IDE navigate to VitisWorkspace Journal.