Archiving Projects - 2020.2 English

Vivado Design Suite User Guide System-Level Design Entry (UG895)

Document ID
Release Date
2020.2 English

You can create a project archive to store as backup or to send to a remote site. When archiving a project, the Vivado IDE does the following:

  • Parses the hierarchy of the design.
  • Copies the required source files, include files, and remote files from the library directories.
  • Copies the constraints.
  • Optionally, copies the results of the various synthesis, simulation, and implementation runs.
  • Creates a ZIP file of the project.

To archive a project:

  1. Select File > Project > Archive.
  2. In the Archive Project dialog box, set the following options, and click OK.
    Archive name
    Specifies the name of the project archive.
    Temporary location
    (Windows only) Specifies a temporary directory to copy files to when creating the project archive. The temporary directory is created if it does not exist, and is emptied when the archive process is complete. By default, the Vivado tool creates a temporary directory inside of the current working directory.
    Include configuration settings
    Includes the Vivado_init.tcl file, which contains Tcl initialization commands that are helpful in debugging your design. For more information, see the Vivado Design Suite Tcl Command Reference Guide (UG835).
    Include run results
    Includes the settings and results of the runs performed on the project. Including the results of synthesis and implementation runs can significantly increase the size of the project archive.
    Include local IP cache results
    Includes the information included in the local IP cache (if any) to speed up IP generation times using version of the tools.
    Figure 1. Archive Project Dialog Box

    The Vivado IDE creates a project archive in ZIP file format that contains the required source files, include files, and run files (if specified) as well as an archive.log file of the archival process. You can review the creation of the archive in the archive.log file.

    You can also use the write_project_tcl command to generate a tcl script that will recreate the current project. The script will keep the project settings and sources, but may not retain output products or design state.