`Components`#

class pyedb.grpc.database.components.Components(p_edb: Any)#

Bases: object

Manages EDB components and related methods accessible from Edb.components.

Parameters:

p_edbpyedb.grpc.edb.Edb: EDB object.

Examples

>>> from pyedb import Edb
>>> edbapp = Edb("myaedbfolder")
>>> edbapp.components

Overview#

Methods

`import_definition`	Import component definitions from a JSON file.
`export_definition`	Export component definitions to a JSON file.
`refresh_components`	Refresh the component dictionary.
`get_component_by_name`	Retrieve a component by name.
`get_pin_from_component`	Get pins from a component with optional filtering.
`get_components_from_nets`	Get components connected to specified nets.
`get_component_placement_vector`	Get placement vector between two components.
`get_solder_ball_height`	Get solder ball height of a component.
`get_vendor_libraries`	Get vendor component libraries.
`create_source_on_component`	Create sources on components.
`create_port_on_pins`	Create port on pins.
`create_port_on_component`	Create ports on a component.
`create`	Create a new component.
`create_component_from_pins`	Create component from pins.
`set_component_model`	Set component model.
`create_pingroup_from_pins`	Create pin group from pins.
`delete_single_pin_rlc`	Delete or deactivate single-pin RLC components.
`delete`	Delete a component.
`disable_rlc_component`	Disable RLC component.
`set_solder_ball`	Set solder ball properties for a component.
`set_component_rlc`	Set RLC values for a component.
`update_rlc_from_bom`	Update RLC values from BOM file.
`import_bom`	Import BOM file.
`export_bom`	Export BOM file.
`find_by_reference_designator`	Find component by reference designator.
`get_aedt_pin_name`	Get AEDT pin name.
`get_pins`	Get pins of a component.
`get_pin_position`	Get pin position.
`get_pins_name_from_net`	Get pin names from net.
`get_nets_from_pin_list`	Get nets from pin list.
`get_component_net_connection_info`	Get net connection info for a component.
`get_rats`	Get RATS (Reference Designator, Pin, Net) information.
`get_through_resistor_list`	Get through resistors below threshold.
`short_component_pins`	Short component pins with traces.
`create_pin_group`	Create pin group on a component.
`create_pin_group_on_net`	Create pin group by net name.
`deactivate_rlc_component`	Deactivate RLC component with a possibility to convert it to a circuit port.
`add_port_on_rlc_component`	Deactivate RLC component and replace it with a circuit port.
`replace_rlc_by_gap_boundaries`	Replace RLC component by RLC gap boundaries. These boundary types are compatible with 3D modeler export.
`add_rlc_boundary`	Add RLC gap boundary on component and replace it with a circuit port.

Properties

`instances`	Dictionary of all component instances in the layout.
`definitions`	Dictionary of all component definitions.
`nport_comp_definition`	Dictionary of N-port component definitions.
`resistors`	Dictionary of resistor components.
`capacitors`	Dictionary of capacitor components.
`inductors`	Dictionary of inductor components.
`ICs`	Dictionary of integrated circuit components.
`IOs`	Dictionary of I/O components.
`Others`	Dictionary of other components.
`components_by_partname`	Dictionary of components grouped by part name.

Special methods

__getitem__

Get a component or component definition by name.

Import detail#

from pyedb.grpc.database.components import Components

Property detail#

property Components.instances: Dict[str, pyedb.grpc.database.hierarchy.component.Component]#

Dictionary of all component instances in the layout.

Returns:

dict[str, pyedb.grpc.database.hierarchy.component.Component]: Dictionary of component instances keyed by name.

Examples

>>> edbapp.components.instances

property Components.definitions: Dict[str, pyedb.grpc.database.definition.component_def.ComponentDef]#

Dictionary of all component definitions.

Returns:

dict[str, pyedb.grpc.database.definition.component_def.ComponentDef]: Dictionary of component definitions keyed by name.

Examples

>>> edbapp.components.definitions

property Components.nport_comp_definition: Dict[str, pyedb.grpc.database.hierarchy.component.Component]#

Dictionary of N-port component definitions.

Returns:

dict[str, pyedb.grpc.database.hierarchy.component.Component]: Dictionary of N-port component definitions keyed by name.

property Components.resistors: Dict[str, pyedb.grpc.database.hierarchy.component.Component]#

Dictionary of resistor components.

Returns:

dict[str, pyedb.grpc.database.hierarchy.component.Component]: Dictionary of resistor components keyed by name.

Examples

>>> edbapp.components.resistors

property Components.capacitors: Dict[str, pyedb.grpc.database.hierarchy.component.Component]#

Dictionary of capacitor components.

Returns:

dict[str, pyedb.grpc.database.hierarchy.component.Component]: Dictionary of capacitor components keyed by name.

Examples

>>> edbapp.components.capacitors

property Components.inductors: Dict[str, pyedb.grpc.database.hierarchy.component.Component]#

Dictionary of inductor components.

Returns:

dict[str, pyedb.grpc.database.hierarchy.component.Component]: Dictionary of inductor components keyed by name.

Examples

>>> edbapp.components.inductors

property Components.ICs: Dict[str, pyedb.grpc.database.hierarchy.component.Component]#

Dictionary of integrated circuit components.

Returns:

dict[str, pyedb.grpc.database.hierarchy.component.Component]: Dictionary of IC components keyed by name.

Examples

>>> edbapp.components.ICs

property Components.IOs: Dict[str, pyedb.grpc.database.hierarchy.component.Component]#

Dictionary of I/O components.

Returns:

dict[str, pyedb.grpc.database.hierarchy.component.Component]: Dictionary of I/O components keyed by name.

Examples

>>> edbapp.components.IOs

property Components.Others: Dict[str, pyedb.grpc.database.hierarchy.component.Component]#

Dictionary of other components.

Returns:

dict[str, pyedb.grpc.database.hierarchy.component.Component]: Dictionary of other components keyed by name.

Examples

>>> edbapp.components.Others

property Components.components_by_partname: Dict[str, List[pyedb.grpc.database.hierarchy.component.Component]]#

Dictionary of components grouped by part name.

Returns:

dict[str, list[pyedb.grpc.database.hierarchy.component.Component]]: Dictionary of components lists keyed by part name.

Examples

>>> edbapp.components.components_by_partname

Method detail#

Components.__getitem__(name: str) → pyedb.grpc.database.hierarchy.component.Component | pyedb.grpc.database.definition.component_def.ComponentDef | None#

Get a component or component definition by name.

Parameters:

namestr: Name of the component or definition.

Returns:

pyedb.grpc.database.hierarchy.component.Component or
pyedb.grpc.database.definition.component_def.ComponentDef or None: Component instance if found, component definition if found by name, otherwise None.

Examples

>>> component = edbapp.components["R1"]

Components.import_definition(file_path) → bool#

Import component definitions from a JSON file.

Parameters:

file_pathstr: Path to the JSON file.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.import_definition("definitions.json")

Components.export_definition(file_path) → bool#

Export component definitions to a JSON file.

Parameters:

file_pathstr: Path to the output JSON file.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.export_definition("exported_definitions.json")

Components.refresh_components() → bool#

Refresh the component dictionary.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.refresh_components()

Components.get_component_by_name(name) → pyedb.grpc.database.hierarchy.component.Component#

Retrieve a component by name.

Parameters:

namestr: Name of the component.

Returns:

pyedb.grpc.database.hierarchy.component.Component: Component instance.

Examples

>>> comp = edbapp.components.get_component_by_name("R1")

Components.get_pin_from_component(component: str | pyedb.grpc.database.hierarchy.component.Component, net_name: str | List[str] | None = None, pin_name: str | None = None) → List[Any]#

Get pins from a component with optional filtering.

Parameters:

componentstr or pyedb.grpc.database.hierarchy.component.Component: Component name or instance.
net_namestr or list[str], optional: Net name(s) to filter by.
pin_namestr, optional: Pin name to filter by.

Returns:

list[pyedb.grpc.database.padstacks.PadstackInstance]: List of pin instances.

Examples

>>> pins = edbapp.components.get_pin_from_component("R1", net_name="GND")

Components.get_components_from_nets(netlist=None) → list[str]#

Get components connected to specified nets.

Parameters:

netliststr or list[str], optional: Net name(s) to filter by.

Returns:

list[str]: List of component names.

Examples

>>> comps = edbapp.components.get_components_from_nets(["GND", "VCC"])

Components.get_component_placement_vector(mounted_component: pyedb.grpc.database.hierarchy.component.Component, hosting_component: pyedb.grpc.database.hierarchy.component.Component, mounted_component_pin1: str, mounted_component_pin2: str, hosting_component_pin1: str, hosting_component_pin2: str, flipped: bool = False) → Tuple[bool, List[float], float, float]#

Get placement vector between two components.

Parameters:

mounted_componentpyedb.grpc.database.hierarchy.component.Component: Mounted component.
hosting_componentpyedb.grpc.database.hierarchy.component.Component: Hosting component.
mounted_component_pin1str: Pin name on mounted component.
mounted_component_pin2str: Pin name on mounted component.
hosting_component_pin1str: Pin name on hosting component.
hosting_component_pin2str: Pin name on hosting component.
flippedbool, optional: Whether the component is flipped.

Returns:

tuple: (success, vector, rotation, solder_ball_height)

Examples

>>> vec, rot, height = edbapp.components.get_component_placement_vector(...)

Components.get_solder_ball_height(cmp: str | pyedb.grpc.database.hierarchy.component.Component) → float#

Get solder ball height of a component.

Parameters:

cmpstr or pyedb.grpc.database.hierarchy.component.Component: Component name or instance.

Returns:

float: Solder ball height in meters.

Examples

>>> height = edbapp.components.get_solder_ball_height("U1")

Components.get_vendor_libraries() → pyedb.component_libraries.ansys_components.ComponentLib#

Get vendor component libraries.

Returns:

pyedb.component_libraries.ansys_components.ComponentLib: Component library object.

Examples

>>> lib = edbapp.components.get_vendor_libraries()

Components.create_source_on_component(sources=None)#

Create sources on components.

Deprecated since version 0.28.0: Use pyedb.grpc.core.excitations.create_source_on_component() instead.

Parameters:

sourceslist, optional: List of sources.

Returns:

bool: True if successful, False otherwise.

Components.create_port_on_pins(refdes, pins, reference_pins, impedance=50.0, port_name=None, pec_boundary=False, pingroup_on_single_pin=False)#

Create port on pins.

Deprecated since version 0.28.0: Use pyedb.grpc.core.excitations.create_port_on_pins() instead.

Parameters:

refdesstr: Reference designator.
pinslist: List of pins.
reference_pinslist: List of reference pins.
impedancefloat, optional: Port impedance.
port_namestr, optional: Port name.
pec_boundarybool, optional: Use PEC boundary.
pingroup_on_single_pinbool, optional: Use pin group on single pin.

Returns:

bool: True if successful, False otherwise.

Components.create_port_on_component(component, net_list, port_type=SourceType.CoaxPort, do_pingroup=True, reference_net='gnd', port_name=None, solder_balls_height=None, solder_balls_size=None, solder_balls_mid_size=None, extend_reference_pins_outside_component=False)#

Create ports on a component.

Deprecated since version 0.28.0: Use pyedb.grpc.core.excitations.create_port_on_component() instead.

Parameters:

componentstr: Component name.
net_listlist: List of nets.
port_typeSourceType, optional: Port type.
do_pingroupbool, optional: Use pin groups.
reference_netstr, optional: Reference net.
port_namestr, optional: Port name.
solder_balls_heightfloat, optional: Solder ball height.
solder_balls_sizefloat, optional: Solder ball size.
solder_balls_mid_sizefloat, optional: Solder ball mid size.
extend_reference_pins_outside_componentbool, optional: Extend reference pins outside component.

Returns:

bool: True if successful, False otherwise.

Components.create(pins: List[Any], component_name: str | None = None, placement_layer: str | None = None, component_part_name: str | None = None, is_rlc: bool = False, r_value: float | None = None, c_value: float | None = None, l_value: float | None = None, is_parallel: bool = False) → pyedb.grpc.database.hierarchy.component.Component | bool#

Create a new component.

Parameters:

pinslist[pyedb.grpc.database.padstacks.PadstackInstance]: List of pins.
component_namestr, optional: Component name.
placement_layerstr, optional: Placement layer name.
component_part_namestr, optional: Part name.
is_rlcbool, optional: Whether the component is RLC.
r_valuefloat, optional: Resistance value.
c_valuefloat, optional: Capacitance value.
l_valuefloat, optional: Inductance value.
is_parallelbool, optional: Whether RLC is parallel.

Returns:

pyedb.grpc.database.hierarchy.component.Component or bool: New component instance if successful, False otherwise.

Examples

>>> new_comp = edbapp.components.create(pins, "R1")

Components.create_component_from_pins(pins, component_name, placement_layer=None, component_part_name=None) → pyedb.grpc.database.hierarchy.component.Component | bool#

Create component from pins.

Deprecated since version 0.6.62: Use create() instead.

Parameters:

pinslist: List of pins.
component_namestr: Component name.
placement_layerstr, optional: Placement layer.
component_part_namestr, optional: Part name.

Returns:

pyedb.grpc.database.hierarchy.component.Component or bool: Component instance if successful, False otherwise.

Components.set_component_model(componentname: str, model_type: str = 'Spice', modelpath: str | None = None, modelname: str | None = None) → bool#

Set component model.

Parameters:

componentnamestr: Component name.
model_typestr, optional: Model type (“Spice” or “Touchstone”).
modelpathstr, optional: Model file path.
modelnamestr, optional: Model name.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.set_component_model("U1", "Spice", "path/to/model.sp")

Components.create_pingroup_from_pins(pins: List[Any], group_name: str | None = None) → pyedb.grpc.database.hierarchy.pingroup.PinGroup | bool#

Create pin group from pins.

Parameters:

pinslist[pyedb.grpc.database.padstacks.PadstackInstance]: List of pins.
group_namestr, optional: Group name.

Returns:

pyedb.grpc.database.hierarchy.pingroup.PinGroup or bool: Pin group instance if successful, False otherwise.

Examples

>>> pingroup = edbapp.components.create_pingroup_from_pins(pins, "GND_pins")

Components.delete_single_pin_rlc(deactivate_only: bool = False) → List[str]#

Delete or deactivate single-pin RLC components.

Parameters:

deactivate_onlybool, optional: Whether to only deactivate instead of deleting.

Returns:

list[str]: List of affected components.

Examples

>>> deleted = edbapp.components.delete_single_pin_rlc()

Components.delete(component_name: str) → bool#

Delete a component.

Parameters:

component_namestr: Component name.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.delete("R1")

Components.disable_rlc_component(component_name: str) → bool#

Disable RLC component.

Parameters:

component_namestr: Component name.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.disable_rlc_component("R1")

Components.set_solder_ball(component: str | pyedb.grpc.database.hierarchy.component.Component = '', sball_diam: float | None = None, sball_height: float | None = None, shape: str = 'Cylinder', sball_mid_diam: float | None = None, chip_orientation: str = 'chip_down', auto_reference_size: bool = True, reference_size_x: float = 0, reference_size_y: float = 0, reference_height: float = 0) → bool#

Set solder ball properties for a component.

Parameters:

componentstr or pyedb.grpc.database.hierarchy.component.Component, optional: Component name or instance.
sball_diamfloat, optional: Solder ball diameter.
sball_heightfloat, optional: Solder ball height.
shapestr, optional: Solder ball shape (“Cylinder” or “Spheroid”).
sball_mid_diamfloat, optional: Solder ball mid diameter.
chip_orientationstr, optional: Chip orientation (“chip_down” or “chip_up”).
auto_reference_sizebool, optional: Use auto reference size.
reference_size_xfloat, optional: Reference size X.
reference_size_yfloat, optional: Reference size Y.
reference_heightfloat, optional: Reference height.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.set_solder_ball("U1", sball_diam=0.5e-3)

Components.set_component_rlc(componentname: str, res_value: float | None = None, ind_value: float | None = None, cap_value: float | None = None, isparallel: bool = False) → bool#

Set RLC values for a component.

Parameters:

componentnamestr: Component name.
res_valuefloat, optional: Resistance value.
ind_valuefloat, optional: Inductance value.
cap_valuefloat, optional: Capacitance value.
isparallelbool, optional: Whether RLC is parallel.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.set_component_rlc("R1", res_value=50)

Components.update_rlc_from_bom(bom_file: str, delimiter: str = ';', valuefield: str = 'Func des', comptype: str = 'Prod name', refdes: str = 'Pos / Place') → bool#

Update RLC values from BOM file.

Parameters:

bom_filestr: BOM file path.
delimiterstr, optional: Delimiter character.
valuefieldstr, optional: Value field name.
comptypestr, optional: Component type field name.
refdesstr, optional: Reference designator field name.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.update_rlc_from_bom("bom.csv")

Components.import_bom(bom_file: str, delimiter: str = ',', refdes_col: int = 0, part_name_col: int = 1, comp_type_col: int = 2, value_col: int = 3) → bool#

Import BOM file.

Parameters:

bom_filestr: BOM file path.
delimiterstr, optional: Delimiter character.
refdes_colint, optional: Reference designator column index.
part_name_colint, optional: Part name column index.
comp_type_colint, optional: Component type column index.
value_colint, optional: Value column index.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.import_bom("bom.csv")

Components.export_bom(bom_file: str, delimiter: str = ',') → bool#

Export BOM file.

Parameters:

bom_filestr: Output file path.
delimiterstr, optional: Delimiter character.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.export_bom("exported_bom.csv")

Components.find_by_reference_designator(reference_designator: str) → pyedb.grpc.database.hierarchy.component.Component#

Find component by reference designator.

Parameters:

reference_designatorstr: Reference designator.

Returns:

pyedb.grpc.database.hierarchy.component.Component: Component instance.

Examples

>>> comp = edbapp.components.find_by_reference_designator("R1")

Components.get_aedt_pin_name(pin: Any) → str#

Get AEDT pin name.

Parameters:

pinpyedb.grpc.database.padstacks.PadstackInstance: Pin instance.

Returns:

str: AEDT pin name.

Examples

>>> name = edbapp.components.get_aedt_pin_name(pin)

Components.get_pins(reference_designator: str, net_name: str | None = None, pin_name: str | None = None) → Dict[str, Any]#

Get pins of a component.

Parameters:

reference_designatorstr: Reference designator.
net_namestr, optional: Net name filter.
pin_namestr, optional: Pin name filter.

Returns:

dict: Dictionary of pins.

Examples

>>> pins = edbapp.components.get_pins("U1", net_name="GND")

Components.get_pin_position(pin: Any) → List[float]#

Get pin position.

Parameters:

pinpyedb.grpc.database.padstacks.PadstackInstance: Pin instance.

Returns:

list[float]: [x, y] position in meters.

Examples

>>> pos = edbapp.components.get_pin_position(pin)

Components.get_pins_name_from_net(net_name: str, pin_list: List[Any] | None = None) → List[str]#

Get pin names from net.

Parameters:

net_namestr: Net name.
pin_listlist, optional: List of pins to search.

Returns:

list[str]: List of pin names.

Examples

>>> pins = edbapp.components.get_pins_name_from_net("GND")

Components.get_nets_from_pin_list(pins: List[Any]) → List[str]#

Get nets from pin list.

Parameters:

pinslist: List of pins.

Returns:

list[str]: List of net names.

Examples

>>> nets = edbapp.components.get_nets_from_pin_list(pins)

Components.get_component_net_connection_info(refdes: str) → Dict[str, List[str]]#

Get net connection info for a component.

Parameters:

refdesstr: Reference designator.

Returns:

dict: Dictionary with refdes, pin_name, and net_name.

Examples

>>> info = edbapp.components.get_component_net_connection_info("U1")

Components.get_rats() → List[Dict[str, List[str]]]#

Get RATS (Reference Designator, Pin, Net) information.

Returns:

list[dict]: List of dictionaries with refdes, pin_name, and net_name.

Examples

>>> rats = edbapp.components.get_rats()

Components.get_through_resistor_list(threshold: float = 1) → List[str]#

Get through resistors below threshold.

Parameters:

thresholdfloat, optional: Resistance threshold.

Returns:

list[str]: List of component names.

Examples

>>> resistors = edbapp.components.get_through_resistor_list(1)

Components.short_component_pins(component_name: str, pins_to_short: List[str] | None = None, width: float = 0.001) → bool#

Short component pins with traces.

Parameters:

component_namestr: Component name.
pins_to_shortlist[str], optional: List of pin names to short.
widthfloat, optional: Trace width.

Returns:

bool: True if successful, False otherwise.

Examples

>>> edbapp.components.short_component_pins("J4A2", ["G4", "9", "3"])

Components.create_pin_group(reference_designator: str, pin_numbers: str | List[str], group_name: str | None = None) → Tuple[str, pyedb.grpc.database.hierarchy.pingroup.PinGroup] | bool#

Create pin group on a component.

Parameters:

reference_designatorstr: Reference designator.
pin_numberslist[str]: List of pin names.
group_namestr, optional: Group name.

Returns:

tuple[str, pyedb.grpc.database.hierarchy.pingroup.PinGroup] or bool: (group_name, PinGroup) if successful, False otherwise.

Examples

>>> name, group = edbapp.components.create_pin_group("U1", ["1", "2"])

Components.create_pin_group_on_net(reference_designator: str, net_name: str, group_name: str | None = None) → pyedb.grpc.database.hierarchy.pingroup.PinGroup#

Create pin group by net name.

Parameters:

reference_designatorstr: Reference designator.
net_namestr: Net name.
group_namestr, optional: Group name.

Returns:

pyedb.grpc.database.hierarchy.pingroup.PinGroup: Pin group instance.

Examples

>>> group = edbapp.components.create_pin_group_on_net("U1", "GND")

Components.deactivate_rlc_component(component: str | None = None, create_circuit_port: bool = False, pec_boundary: bool = False) → bool#

Deactivate RLC component with a possibility to convert it to a circuit port.

Parameters:

componentstr: Reference designator of the RLC component.
create_circuit_portbool, optional: Whether to replace the deactivated RLC component with a circuit port. The default is False.
pec_boundarybool, optional: Whether to define the PEC boundary, The default is False. If set to True, a perfect short is created between the pin and impedance is ignored. This parameter is only supported on a port created between two pins, such as when there is no pin group.

Returns:

bool: True when successful, False when failed.

Examples

>>> from pyedb import Edb
>>> edb_file = r"C:\my_edb_file.aedb"
>>> edb = Edb(edb_file)
>>> for cmp in list(edb.components.instances.keys()):
>>>     edb.components.deactivate_rlc_component(component=cmp, create_circuit_port=False)
>>> edb.save_edb()
>>> edb.close_edb()

Components.add_port_on_rlc_component(component: str | pyedb.grpc.database.hierarchy.component.Component | None = None, circuit_ports: bool = True, pec_boundary: bool = False) → bool#

Deactivate RLC component and replace it with a circuit port. The circuit port supports only two-pin components.

Parameters:

componentstr: Reference designator of the RLC component.
circuit_portsbool: True will replace RLC component by circuit ports, False gap ports compatible with HFSS 3D modeler export.
pec_boundarybool, optional: Whether to define the PEC boundary, The default is False. If set to True, a perfect short is created between the pin and impedance is ignored. This parameter is only supported on a port created between two pins, such as when there is no pin group.

Returns:

bool: True when successful, False when failed.

Examples

>>> from pyedb import Edb
>>> edb = Edb()
>>> edb.source_excitation.add_port_on_rlc_component("R1")

Components.replace_rlc_by_gap_boundaries(component: str | pyedb.grpc.database.hierarchy.component.Component | None = None) → bool#

Replace RLC component by RLC gap boundaries. These boundary types are compatible with 3D modeler export. Only 2 pins RLC components are supported in this command.

Parameters:

componentstr: Reference designator of the RLC component.

Returns:

bool
True when succeed, False if it failed.

Examples

>>> from pyedb import Edb
>>> edb = Edb(edb_file)
>>>  for refdes, cmp in edb.components.capacitors.items():
>>>     edb.components.replace_rlc_by_gap_boundaries(refdes)
>>> edb.save_edb()
>>> edb.close_edb()

Components.add_rlc_boundary(component: str | pyedb.grpc.database.hierarchy.component.Component | None = None, circuit_type: bool = True) → bool#

Add RLC gap boundary on component and replace it with a circuit port. The circuit port supports only 2-pin components.

. deprecated:: pyedb 0.28.0 Use pyedb.grpc.core.excitations.add_rlc_boundary() instead.

Parameters:

componentstr: Reference designator of the RLC component.
circuit_typebool: When True circuit type are defined, if False gap type will be used instead (compatible with HFSS 3D modeler). Default value is True.

Returns:

bool: True when successful, False when failed.

Components#

Overview#

Import detail#

Property detail#

Method detail#

`Components`#