create(...) - create(...) - 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 IP by name and settings dictionary. Default value is applied to each missing setting in the dictionary if applicable, otherwise, if a setting is mandatory, creation fails.

Syntax

create(<name>, <settings_dict>)

Parameters

Name Description
<name> IP name.
<settings_dict> IP settings dictionary. Execute get_sample_settings(template=True) to see the full IP settings dictionary structure.

Examples

# Create an IP with sample settings
proj = open_project('my_design.pdm')
handler = proj.get_ip_handler('GTM2')
handler.create('g1', handler.get_sample_settings())
# Create an IP with custom settings
handler = proj.get_ip_handler('GTH')
handler.create('a1', {'protocol': 'PCIe Gen1', 'data_rate': 2.5, 'data_path': 64})
# Create an IP with partial settings (defaults used for missing settings)
handler = proj.get_ip_handler('LPDDRMC')
stg = handler.get_sample_settings()
stg['standard'] = 'LPDDR5X'
stg['ecc'] = 'Disabled'
handler.create('lp1', stg)