open_project - 2021.1 English - UG1399

Vitis High-Level Synthesis User Guide (UG1399)
Document ID
UG1399
Release Date
2021-06-16
Version
2021.1 English

Description

Opens an existing project, or creates a new one if the specified project does not exist.

Important: In Vitis HLS, the open_project command returns an error when opening a Vivado HLS project, unless the -upgrade or -reset option is used.

There can only be one active project in a Vitis HLS session. To close a project:

  • Use the close_project command, or
  • Open or create another project with the open_project or open_tcl_project commands.

Use the delete_project command to completely delete the project directory (removing it from the disk) and any solutions associated it.

Syntax

open_project [OPTIONS] <name>
  • <name> specifies the project name.

Options

-reset
  • Resets the project by removing any data that already exists in the project.
  • Removes any previous project information on design source files, header file search paths, and the top-level function. The associated solution directories and files are kept, but might now have invalid results.
Recommended: Use the -reset option when executing Vitis HLS with Tcl scripts. Otherwise, each new add_files command adds additional files to the existing data.
-upgrade
Upgrade a Vivado HLS project to Vitis HLS.

Examples

Opens an existing project named Project_1, or creates a new one if it does not exist:

open_project Project_1

Opens a project and removes any existing data:

open_project -reset Project_2