run_lvs

ipkiss3.all.run_lvs(gds_file, schematic_file, canvas_library, canvas_cell, log_file='LVS_check.log', ignore_electrical=False)

Run an LVS check between the layout from a GDSII file and a reference known-good schematic.

Netlists are extracted from both layout and schematic and compared against each other.

The GDSII file has to be annotated with port information for the netlist extraction to work. Such annotations are not exported by default from IPKISS with write_gdsii. To export port information set export_ports=True, i.e. layout.write_gdsii(“lvs_example.gds”, export_ports=True).

Parameters:

gds_file: str | Path

The path to the GDSII file with the layout to be compared against a reference schematic.

schematic_file: str | Path

The path to the .icproject file with the reference schematic.

canvas_library: str

Canvas library name.

canvas_cell: str

Canvas cell name.

log_file: str | Path

The path to the file to which the LVS report is written. Optional, default is LVS_check.log.

ignore_electrical: bool

Whether to ignore electrical terms. This means only optical instances, terms and connections are checked by LVS. Optional, default is False.

Returns:

True if LVS check passed, false if it failed.