new_project(...) - new_project(...) - 2026.1 English - UG1781

Python Scripting Guide for PDM Tool (UG1781)

Document_ID
UG1781
Release_Date
2026-06-23
Version
2026.1 English
Revision

Description

Create new project by importing a .xpe file or selecting a part and/or process.

Syntax

new_project(<pdm_file>, part='', process='Maximum', xpe_file='')

Returns

PdmProject object representing the newly created project.

Parameters

Name Description
<pdm_file> Path to the .pdm file for project creation.
[part] Vivado part string - case insensitive string, for example 'xcve1752-NSVG1369-2mp-e-s'. Mutually exclusive with 'xpe_file' option.

Default: PDM tool default part

[process] Manufacturing process variations - case insensitive string 'Typ[ical]' or 'Max[imum]'.

Default: Maximum

[xpe_file] Path to the .xpe file for import during creation. Mutually exclusive with 'part' option.

Default: None

Examples

# Create a new project by importing an .xpe file
proj = new_project('my_design.pdm', xpe_file='baseline.xpe')
# Create a new project with default part and default process
proj = new_project('my_design.pdm')
# Create a new project with a specifiied part and process
proj = new_project('my_design.pdm', part='xcve1752-NSVG1369-2mp-e-s', process='Typical')
# Create a new project with default part and specified process
proj = new_project('my_design.pdm', process='Typical')
# Create a new project with part and process taken from valid list
proj = new_project('my_design.pdm', part=get_parts(regex='XCVP')[0], process=get_processes()[0])