compute_icn

SpiSim.compute_icn(config_file: str | None = None, port_order: str = 'EVENODD', next_s4p: str | list | None = None, fext_s4p: str | list | None = None, bandwidth: float | None = None, use_pcie_icn: bool = False, compute_retries: int = 3) → bool | float

Compute the integrated crosstalk noise (ICN) in volts using Ansys SPISIM from S-parameter file.

Warning

Do not execute this function with untrusted function argument, environment variables or pyaedt global settings. See the security guide for details.

Parameters:

config_filestr, optional

Configuration file to use as a reference. The default is None, in which case this parameter is ignored.

port_orderstr, optional

Whether to use “EvenOdd” or “Incremental” numbering for S4P files. The default is None. This parameter is ignored if there are more than four ports.

next_s4pstr, list, optional

Near End s4p or list of s4p. The default is None.

fext_s4pstr, list, optional

Far End s4p or list of s4p. The default is None.

use_pcie_icnbool, optional

Whether to use PCIE or COM method to compute ICN. The default is COM.

bandwidthfloat, str, optional

Application bandwidth in hertz (Hz), which is the inverse of one UI (unit interval). The value can be a float or a string with the unit (“m”, “g”). The default is 25e9.

compute_retriesint, optional

Number of retries to compute ICN. The default is 3.

Returns:

bool or float

ICN in volts from the SPISIM executable command, False when failed.

Examples

>>> from ansys.aedt.core.visualization.post.spisim import SpiSim
>>> fext_s4p = "fext_s4p.s4p"
>>> next_s4p = "next_s4p.s4p"
>>> spisim = SpiSim()
>>> spisim.working_directory = test_tmp_dir
>>> icn = spisim.compute_icn(port_order="EvenOdd", fext_s4p=fext_s4p, next_s4p=next_s4p, bandwidth=10e9)