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

Syntax

create(<name>, <settings_dict>)

Parameters

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

Examples

# Create a clock with sample settings
proj = open_project('my_design.pdm')
clock_handler = proj.get_clock_handler()
settings = clock_handler.get_sample_settings()
clock_handler.create('clk1', settings)
# Create a clock with custom settings
clock_handler.create('clk2', {
	'freq': 500.0,
	'io_type': 'HD',
	'io_standard': 'LVCMOS 1.8V',
	'is_gated': True,
	'min_scaled_freq': 50.0
})
# Create a clock with empty settings (uses defaults)
clock_handler.create('clk3', {})