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 | str | None = None, use_pcie_icn: int | bool | str = False, compute_retries: int = 3) → bool | float | list

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

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 "EVENODD". 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_icnint, bool, str, optional

ICN calculation standard to use. The default is False, which uses "COM_CHNICN" and returns the "ICN" result. Passing True uses "PCIE_CCICN" and returns the "ccICN" result. Integer values map to 0 for "COM_CHNICN", 1 for "PCIE_CCICN", and 2 for "GENERIC_CCICN". String values can be "COM_CHNICN", "PCIE_CCICN", or "GENERIC_CCICN". "GENERIC_CCICN" is a generic custom parameters approach supported in AEDT 2027 R1 and later. In order to customize parameters for "GENERIC_CCICN" user can provide a custom "config_file".

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 (for example, “2GHz”). The default is 25e9.

compute_retriesint, optional

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

Returns:

bool or float or list

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)