`Modeler`#

class pyedb.grpc.database.modeler.Modeler(p_edb)#

Bases: object

Manages EDB methods for primitives management accessible from Edb.modeler.

Examples

>>> from pyedb import Edb
>>> edbapp = Edb("myaedbfolder", edbversion="2021.2")
>>> edb_layout = edbapp.modeler

Overview#

Methods

`clear_cache`	Force reload of all primitives and reset indexes.
`get_primitive`	Retrieve primitive from give id.
`get_polygons_by_layer`	Retrieve polygons by layer.
`get_primitive_by_layer_and_point`	Get primitive at specified point on layer.
`get_polygon_bounding_box`	Get bounding box of polygon.
`get_polygon_points`	Get points defining a polygon.
`parametrize_polygon`	Parametrize polygon points based on another polygon.
`create_trace`	Create trace path.
`create_polygon`	Create polygon primitive.
`create_rectangle`	Create rectangle primitive.
`create_circle`	Create circle primitive.
`create_text`	Create text primitive.
`delete_primitives`	Delete primitives by net name(s).
`get_primitives`	Get primitives with filtering.
`fix_circle_void_for_clipping`	Fix circle void clipping issues.
`parametrize_trace_width`	Parametrize trace width.
`unite_polygons_on_layer`	Unite polygons on layer.
`defeature_polygon`	Defeature polygon.
`get_layout_statistics`	Get layout statistics.
`create_bondwire`	Create bondwire.
`create_pin_group`	Create pin group.
`insert_layout_instance_on_layer`	Insert a layout instance into the active layout.
`insert_layout_instance_placement_3d`	Insert a 3D component placement into the active layout.
`insert_3d_component_placement_3d`	Insert a 3D component placement into the active layout.
`insert_3d_component_on_layer`	Insert a layout instance into the active layout.
`create_taper`	Create an RF trace taper polygon between two points.
`open_solder_mask`	Create solder mask openings for components, voids, and traces.

Properties

`primitives`	Primitives.
`primitives_by_layer`	Primitives organized by layer names.
`polygons_by_layer`	Primitives with layer names as keys.
`rectangles`	All rectangle primitives.
`circles`	All circle primitives.
`paths`	All path primitives.
`texts`	All text primitives.
`polygons`	All polygon primitives.
`primitives_by_net`	Primitives with net names as keys.

Static methods

add_void

Add void to shape.

Special methods

__getitem__

Get a primitive by name or ID.

Import detail#

from pyedb.grpc.database.modeler import Modeler

Property detail#

property Modeler.primitives#

Primitives.

Deprecated since version 0.70.0: Use edb.layout.primitives instead.

Returns:

list of pyedb.grpc.database.primitives.Primitive: List of primitives.

property Modeler.primitives_by_layer#

Primitives organized by layer names.

Deprecated since version 0.70.0.

use layout.primitives_by_layer property instead.

property Modeler.polygons_by_layer: dict[str, List[pyedb.grpc.database.primitive.polygon.Polygon]]#

Primitives with layer names as keys.

Deprecated since version 0.70.0.

use layout.polygons_by_layer property instead.

Returns:

dict: Dictionary of polygons with layer names as keys.

property Modeler.rectangles: List[pyedb.grpc.database.primitive.rectangle.Rectangle | pyedb.grpc.database.primitive.primitive.Primitive]#

All rectangle primitives.

Returns:

list: List of pyedb.grpc.database.edb_data.primitives_data.Rectangle objects.

property Modeler.circles: List[pyedb.grpc.database.primitive.circle.Circle | pyedb.grpc.database.primitive.primitive.Primitive]#

All circle primitives.

Deprecated since version 0.70.0.

use layout.circles instead.

Returns:

list: List of pyedb.grpc.database.edb_data.primitives_data.Circle objects.

property Modeler.paths: List[pyedb.grpc.database.primitive.path.Path | pyedb.grpc.database.primitive.primitive.Primitive]#

All path primitives.

Deprecated since version 0.70.0.

use layout.paths instead.

Returns:

list: List of pyedb.grpc.database.edb_data.primitives_data.Path objects.

property Modeler.texts: List[pyedb.grpc.database.primitive.text.Text | pyedb.grpc.database.primitive.primitive.Primitive]#

All text primitives.

Returns:

list: List of pyedb.grpc.database.edb_data.primitives_data.Text objects.

property Modeler.polygons: List[pyedb.grpc.database.primitive.polygon.Polygon | pyedb.grpc.database.primitive.primitive.Primitive]#

All polygon primitives.

Deprecated since version 0.70.0.

use layout.polygons instead.

Returns:

list: List of pyedb.grpc.database.primitive.polygon.Polygon objects.

property Modeler.primitives_by_net: dict[str, List[pyedb.grpc.database.primitive.primitive.Primitive]]#

Primitives with net names as keys.

Deprecated since version 0.70.0.

use layout.primitives_by_net instead.

Returns:

dict: Dictionary of primitives with net names as keys.

Method detail#

Modeler.__getitem__(name: str | int) → pyedb.grpc.database.primitive.primitive.Primitive#

Get a primitive by name or ID.

Parameters:

namestr or int: Name or ID of the primitive.

Returns:

pyedb.grpc.database.primitive.primitive.Primitive: Primitive instance if found, None otherwise.

Raises:

TypeError: If name is not str or int.

Modeler.clear_cache()#: Force reload of all primitives and reset indexes.

Modeler.get_primitive(primitive_id: int) → list[pyedb.grpc.database.primitive.primitive.Primitive]#

Retrieve primitive from give id.

Deprecated since version 0.70.0.

use layout.find_object_by_id method instead.

Parameters:

primitive_idint: Primitive id.

Returns:

list of pyedb.grpc.database.primitive.primitive.Primitive: List of primitives.

Modeler.get_polygons_by_layer(layer_name: str, net_list: List[str] | None = None) → List[pyedb.grpc.database.primitive.primitive.Primitive]#

Retrieve polygons by layer.

Deprecated since version 0.70.0.

use layout.get_polygons_by_layer method instead.

Parameters:

layer_namestr: Layer name.
net_listlist, optional: List of net names to filter by.

Returns:

list: List of polygon objects.

Get primitive at specified point on layer.

Parameters:

pointlist, optional: [x, y] coordinate point.
layerstr or list, optional: Layer name(s) to filter by.
netsstr or list, optional: Net name(s) to filter by.

Returns:

list: List of primitive objects at the point.

Raises:

ValueError: If point is invalid.

Modeler.get_polygon_bounding_box(polygon: pyedb.grpc.database.primitive.primitive.Primitive) → List[float]#

Get bounding box of polygon.

Deprecated since version 0.70.0.

use layout.get_polygon_bounding_box method instead.

Parameters:

polygonpyedb.grpc.database.edb_data.primitives_data.Primitive: Polygon primitive.

Returns:

list: Bounding box coordinates [min_x, min_y, max_x, max_y].

Modeler.get_polygon_points(polygon) → List[List[float]]#

Get points defining a polygon.

Deprecated since version 0.70.0.

use layout.get_polygon_points method instead.

Parameters:

polygonpyedb.grpc.database.edb_data.primitives_data.Primitive: Polygon primitive.

Returns:

list: List of point coordinates.

Modeler.parametrize_polygon(polygon, selection_polygon, offset_name='offsetx', origin=None) → bool#

Parametrize polygon points based on another polygon.

Parameters:

polygonpyedb.grpc.database.edb_data.primitives_data.Primitive: Polygon to parametrize.
selection_polygonpyedb.grpc.database.edb_data.primitives_data.Primitive: Polygon used for selection.
offset_namestr, optional: Name of offset parameter.
originlist, optional: [x, y] origin point for vector calculation.

Returns:

bool: True if successful, False otherwise.

Modeler.create_trace(path_list: Iterable[float] | ansys.edb.core.geometry.polygon_data.PolygonData, layer_name: str, width: float = 1, net_name: str = '', start_cap_style: str = 'Round', end_cap_style: str = 'Round', corner_style: str = 'Round') → pyedb.grpc.database.primitive.primitive.Primitive | None#

Create trace path.

Parameters:

path_listIterable: List of points [x,y] or [[x, y], …] or [(x, y)…].
layer_namestr: Layer name.
widthfloat, optional: Trace width.
net_namestr, optional: Associated net name.
start_cap_stylestr, optional: Start cap style (“Round”, “Extended”, “Flat”).
end_cap_stylestr, optional: End cap style (“Round”, “Extended”, “Flat”).
corner_stylestr, optional: Corner style (“Round”, “Sharp”, “Mitered”).

Returns:

pyedb.grpc.database.edb_data.primitives_data.Path or bool: Path object if created, False otherwise.

Modeler.create_polygon(points: List[List[float]] | ansys.edb.core.geometry.polygon_data.PolygonData, layer_name: str, voids: List[Any] | None = [], net_name: str = '') → pyedb.grpc.database.primitive.primitive.Primitive | None | bool#

Create polygon primitive.

Parameters:

pointslist or ansys.edb.core.geometry.polygon_data.PolygonData: Polygon points or PolygonData object.
layer_namestr: Layer name.
voidslist, optional: List of void shapes or points.
net_namestr, optional: Associated net name.

Returns:

pyedb.grpc.database.edb_data.primitives_data.Polygon or bool: Polygon object if created, False otherwise.

Modeler.create_rectangle(layer_name: str, net_name: str = '', lower_left_point: str = '', upper_right_point: str = '', center_point: str = '', width: str | float = '', height: str | float = '', representation_type: str = 'lower_left_upper_right', corner_radius: str = '0mm', rotation: str = '0deg') → pyedb.grpc.database.primitive.primitive.Primitive | None#

Create rectangle primitive.

Parameters:

layer_namestr: Layer name.
net_namestr, optional: Associated net name.
lower_left_pointlist: Required for representation type: “lower_left_upper_right” [x,y] lower left point.
upper_right_pointlist: Required for representation type: “lower_left_upper_right” [x,y] upper right point.
center_pointlist: Required for representation type: “center_width_height” [x,y] center point.
widthstr or float, optional: Required for representation type: “center_width_height” Rectangle width.
heightstr or float, optional: Required for representation type: “center_width_height”

Rectangle height.
representation_typestr, optional: “lower_left_upper_right” or “center_width_height”. Default value is “lower_left_upper_right”.
corner_radiusstr, optional: Corner radius with units.
rotationstr, optional: Rotation angle with units.

Returns:

pyedb.grpc.database.edb_data.primitives_data.Rectangle or bool: Rectangle object if created, False otherwise.

Modeler.create_circle(layer_name: str, x: float | str, y: float | str, radius: float | str, net_name: str = '') → pyedb.grpc.database.primitive.primitive.Primitive | None#

Create circle primitive.

Parameters:

layer_namestr: Layer name.
xfloat: Center x-coordinate.
yfloat: Center y-coordinate.
radiusfloat: Circle radius.
net_namestr, optional: Associated net name.

Returns:

pyedb.grpc.database.edb_data.primitives_data.Circle or bool: Circle object if created, False otherwise.

Modeler.create_text(layer_name: str, x: float | str, y: float | str, text: str) → pyedb.grpc.database.primitive.primitive.Primitive | None#

Create text primitive.

Parameters:

layer_namestr: Layer name.
xfloat: Center x-coordinate.
yfloat: Center y-coordinate.
textstr: Text of the displayed object.

Returns:

pyedb.grpc.database.edb_data.primitives_data.Text or bool: Text object if created, False otherwise.

Modeler.delete_primitives(net_names: str | List[str]) → bool#

Delete primitives by net name(s).

Parameters:

net_namesstr or list: Net name(s).

Returns:

bool: True if successful, False otherwise.

Modeler.get_primitives(net_name: str | None = None, layer_name: str | None = None, prim_type: str | None = None, is_void: bool | None = None) → List[pyedb.grpc.database.primitive.primitive.Primitive]#

Get primitives with filtering.

Parameters:

net_namestr, optional: Net name filter.
layer_namestr, optional: Layer name filter.
prim_typestr, optional: Primitive type filter.
is_voidbool, optional: Void primitive filter. When None, both standard primitives and voids are returned.

Returns:

list: List of filtered primitives.

Modeler.fix_circle_void_for_clipping() → bool#

Fix circle void clipping issues.

Returns:

bool: True if changes made, False otherwise.

Parametrize trace width.

Parameters:

nets_namestr or list: Net name(s).
layers_namestr or list, optional: Layer name(s) filter.
parameter_namestr, optional: Parameter name prefix.
variable_valuefloat or str, optional: Initial parameter value.

Returns:

bool: True if successful, False otherwise.

Modeler.unite_polygons_on_layer(layer_name: str | List[str] | None = None, delete_padstack_gemometries: bool = False, net_names_list: List[str] | None = None) → bool#

Unite polygons on layer.

Parameters:

layer_namestr or list, optional: Layer name(s) to process.
delete_padstack_gemometriesbool, optional: Whether to delete padstack geometries.
net_names_listlist, optional: Net names filter.

Returns:

bool: True if successful, False otherwise.

Modeler.defeature_polygon(poly: pyedb.grpc.database.primitive.polygon.Polygon, tolerance: float = 0.001) → bool#

Defeature polygon.

Parameters:

polypyedb.grpc.database.edb_data.primitives_data.Polygon: Polygon to defeature.
tolerancefloat, optional: Maximum surface deviation tolerance.

Returns:

bool: True if successful, False otherwise.

Modeler.get_layout_statistics(evaluate_area: bool = False, net_list: List[str] | None = None) → pyedb.grpc.database.utility.layout_statistics.LayoutStatistics#

Get layout statistics.

Parameters:

evaluate_areabool, optional: Whether to compute metal area statistics.
net_listlist, optional: Net list for area computation.

Returns:

LayoutStatistics: Layout statistics object.

Modeler.create_bondwire(definition_name: str, placement_layer: str, width: float | str, material: str, start_layer_name: str, start_x: float | str, start_y: float | str, end_layer_name: str, end_x: float | str, end_y: float | str, net: str, start_cell_instance_name: str | None = None, end_cell_instance_name: str | None = None, bondwire_type: str = 'jedec4') → pyedb.grpc.database.primitive.bondwire.Bondwire#

Create bondwire.

Parameters:

definition_namestr: Bondwire definition name.
placement_layerstr: Placement layer name.
widthfloat or str: Bondwire width.
materialstr: Material name.
start_layer_namestr: Start layer name.
start_xfloat or str: Start x-coordinate.
start_yfloat or str: Start y-coordinate.
end_layer_namestr: End layer name.
end_xfloat or str: End x-coordinate.
end_yfloat or str: End y-coordinate.
netstr: Associated net name.
start_cell_instance_namestr, optional: Start cell instance name.
end_cell_instance_namestr, optional: End cell instance name.
bondwire_typestr, optional: Bondwire type (“jedec4”, “jedec5”, “apd”).

Returns:

pyedb.grpc.database.edb_data.primitives_data.Bondwire or bool: Bondwire object if created, False otherwise.

Modeler.create_pin_group(name: str, pins_by_id: List[int] | None = None, pins_by_aedt_name: List[str] | None = None, pins_by_name: List[str] | None = None) → bool#

Create pin group.

Parameters:

namestr: Pin group name.
pins_by_idlist, optional: List of pin IDs.
pins_by_aedt_namelist, optional: List of pin AEDT names.
pins_by_namelist, optional: List of pin names.

Returns:

pyedb.grpc.database.siwave.pin_group.PinGroup or bool: PinGroup object if created, False otherwise.

static Modeler.add_void(shape: pyedb.grpc.database.primitive.primitive.Primitive, void_shape: pyedb.grpc.database.primitive.primitive.Primitive | List[pyedb.grpc.database.primitive.primitive.Primitive]) → bool#

Add void to shape.

Parameters:

shapepyedb.grpc.database.edb_data.primitives_data.Primitive: Main shape.
void_shapelist or pyedb.grpc.database.edb_data.primitives_data.Primitive: Void shape(s).

Returns:

bool: True if successful, False otherwise.

Insert a layout instance into the active layout.

Parameters:

cell_name: str: Name of the layout to insert.
placement_layer: str: Placement Layer.
rotationfloat or str: Rotation angle around Z-axis, specified counter-clockwise in radians.
rotation_xfloat or str: Rotation angle around X-axis, specified counter-clockwise in radians.
rotation_yfloat or str: Rotation angle around Y-axis, specified counter-clockwise in radians.
xfloat or str: X offset.
yfloat or str: Y offset.
place_on_bottombool: Whether to place the layout instance on the bottom of the layer.
local_origin_x: float or str: Local origin X coordinate.
local_origin_y: float or str: Local origin Y coordinate.

Insert a 3D component placement into the active layout.

Parameters:

cell_name: str: Name of the layout to insert.
x: float or str: X coordinate.
y: float or str: Y coordinate.
z: float or str: Z coordinate.
rotation_x: float or str: Rotation angle around X-axis, specified counter-clockwise in radians.
rotation_y: float or str: Rotation angle around Y-axis, specified counter-clockwise in radians.
rotation_z: float or str: Rotation angle around Z-axis, specified counter-clockwise in radians.
local_origin_x: float or str: Local origin X coordinate.
local_origin_y: float or str: Local origin Y coordinate.
local_origin_z: float or str: Local origin Z coordinate.

Insert a 3D component placement into the active layout.

Parameters:

a3dcomp_path: str or Path: File path to the 3D component.
x: float or str: X coordinate.
y: float or str: Y coordinate.
z: float or str: Z coordinate.
rotation_x: float or str: Rotation angle around X-axis, specified counter-clockwise in radians.
rotation_y: float or str: Rotation angle around Y-axis, specified counter-clockwise in radians.
rotation_z: float or str: Rotation angle around Z-axis, specified counter-clockwise in radians.
local_origin_x: float or str: Local origin X coordinate.
local_origin_y: float or str: Local origin Y coordinate.
local_origin_z: float or str: Local origin Z coordinate.

Insert a layout instance into the active layout.

Parameters:

a3dcomp_path: str or Path: File path to the 3D component.
placement_layer: str: Placement Layer.
rotationfloat or str: Rotation angle, specified counter-clockwise in radians.
rotation_xfloat or str: Rotation angle, specified counter-clockwise in radians.
rotation_yfloat or str: Rotation angle, specified counter-clockwise in radians.
xfloat or str: X offset.
yfloat or str: Y offset.
place_on_bottombool: Whether to place the layout instance on the bottom of the layer.
local_origin_x: float or str: Local origin X coordinate.
local_origin_y: float or str: Local origin Y coordinate.
local_origin_z: float or str: Local origin Z coordinate.

Create an RF trace taper polygon between two points.

The taper is a trapezoidal polygon with start_width at start_point and end_width at end_point, rotated to match the direction between the two points.

(y)
 ↑
 |              <─      End Width      ─>
 |              ─────── End Point ───────
 |             /           |                              |            /            |                               |           /             |                                |          ────────── Start Point ─────────
 |          <─         Start Width        ─>
 +──────────────────────────────────────→ (x)

Parameters:

start_pointtuple[str or float, str or float]: Start point coordinates as (x, y).
end_pointtuple[str or float, str or float]: End point coordinates as (x, y).
start_widthstr or float: Width of the taper at the start point.
end_widthstr or float: Width of the taper at the end point.
layer_namestr, optional: Name of the layer on which to create the taper. The default is "".
voidslist, optional: List of void polygons to subtract from the taper. The default is None.
net_namestr, optional: Net name to assign to the taper polygon. The default is "".

Returns:

Polygon: Created taper polygon object.

Modeler.open_solder_mask(open_components: bool = True, component_filter: list[str] | None = None, components_opening_offset: float | str = 0.0, open_voids: bool = True, voids_opening_offset: float | str = 0.0, open_traces: bool = True, traces_offset: float | str = 0.0, open_traces_net_filter: list[str] | None = None, solder_mask_layer_name: str = 'Solder', solder_mask_thickness: float | str = '30um', solder_mask_material: str = '', reference_signal_layer: str = '', open_top: bool = True) → bool#

Create solder mask openings for components, voids, and traces.

This method creates a solder mask dielectric layer with openings (negative geometries) for:

Component pads and bodies
Polygon voids (cutouts) in power/ground planes
PCB traces (transmission lines)

The solder mask is created as a negative layer (inverted copper representation) in EDB, and openings are implemented as rectangular or polygonal shapes placed on this layer. A default solder mask material (εᵣ = 4) is created automatically if no material is specified.

Parameters:

open_componentsbool, optional: Enable creation of solder mask openings for component pads and bodies. If True and component_filter is None, openings are created for all components on the reference signal layer. The default is True.
component_filterlist[str], optional: Reference designators (RefDes) of specific components to open (e.g., ["C1", "R2"]). If specified, only these components receive solder mask openings. If None, all components on the reference layer are opened. The default is None.
components_opening_offsetfloat or str, optional: Offset distance (in layout units or string with units) to expand component opening rectangles beyond the component bounding box. Use positive values to expand the opening, negative values to shrink it. The default is 0.0. Example: "0.1mm" or 0.0001 (in default unit).
open_voidsbool, optional: Enable creation of solder mask openings for polygon voids (cutouts in planes). When enabled, iterates all polygons on the reference layer and extracts nested voids to create corresponding mask openings. The default is True.
voids_opening_offsetfloat or str, optional: Scaling factor for void opening polygons. Positive values expand the void, negative values shrink it (relative scaling, not absolute offset). The default is 0.0.
open_tracesbool, optional: Enable creation of solder mask openings for traces (paths) on the reference layer. When enabled, all path primitives are converted to polygonal mask openings. The default is True.
traces_offsetfloat or str, optional: Scaling factor for trace opening polygons. The default is 0.0.
open_traces_net_filterlist[str], optional: Net name filter to select only specific traces for mask openings (e.g., ["GND", "SIG1"]). If None, all traces on the reference layer are opened. The default is None.
solder_mask_layer_namestr, optional: Name of the solder mask layer to create or reuse. If a layer with this name already exists in the stackup, it is reused; otherwise, a new layer is created. The default is "Solder".
solder_mask_thicknessfloat or str, optional: Thickness of the solder mask layer (in layout units or string with units). The default is "30um".
solder_mask_materialstr, optional: Name of the dielectric material for the solder mask layer. If the material does not exist in the database, a default solder mask material with εᵣ = 4 is created and a warning is logged. The default is "" (empty string triggers default creation).
reference_signal_layerstr, optional: Name of the signal layer to reference for component placement and primitive filtering. If not specified, the topmost signal layer is used when open_top=True, or the bottommost signal layer when open_top=False. The default is "".
open_topbool, optional: If True, the solder mask layer is placed on top of the board and references the topmost signal layer. If False, the mask is placed on the bottom and references the bottommost signal layer. The default is True.

Returns:

bool: True if the solder mask layer and all openings were created successfully. Raises ValueError if component_filter specifies RefDes values that do not exist in the design.

Raises:

ValueError: If any reference designator in component_filter is not found in the design.

Modeler#

Overview#

Import detail#

Property detail#

Method detail#

`Modeler`#