SMatrixSweepCodelet

class ipkiss3.all.SMatrixSweepCodelet

A codelet for sweeping S-parameters over a range of wavelengths.

This class provides functionality to simulate and visualize the S-matrix of an IPKISS PCell over a specified range of wavelengths.

Parameters:

lib_name: ( str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters ), optional, *None allowed*

Name of the library to which the cell belongs

cell_name: ( str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters ), optional, *None allowed*

Name of the cell that’s to be loaded

project_file: ( str and String that contains only ISO/IEC 8859-1 (extended ASCII py3) or pure ASCII (py2) characters ), optional, *None allowed*

Path to the project

cell: ( PCell ), optional, *None allowed*

The cell for which the codelet get executed

run(start_wavelength=1.5, end_wavelength=1.6, n_wavelength_points=101, validate_netlist=True, progress_bar=False, verbose=False, spice_path=None)

Perform a sweep of S-parameters over a range of wavelengths.

This method performs a sweep of the S-matrix for the attached photonic circuit cell over the specified range of wavelengths, and then visualizes the results in decibel (dB) scale.

Parameters:

start_wavelengthfloat, optional

The starting wavelength of the sweep in micrometers. Default is 1.5.

end_wavelengthfloat, optional

The ending wavelength of the sweep in micrometers. Default is 1.6.

n_wavelength_pointsint, optional

The number of wavelength points over which to perform the sweep. Default is 101.

debugboolean, optional

When True, run all models in Python mode. That means they are run in pure Python, allowing you to debug your model more easily.

validate_netlistboolean, optional

When True, validate that the netlist doesn’t have unconnected terms, duplicate nets or optical terms with multiple links.

progress_bar: boolean, optional

Whether or not to display a progress bar for the parameter sweep. Defaults to False.

verbose: boolean, optional

Whether or not to display information about the simulated circuit. Defaults to False.

spice_path: str | Path | None

Optional. When set, the simulation is performed by first netlisting to spice, and running the simulation from the spice file directly.

Returns:

None