load_design

ipkiss3.all.canvas.load_design(project_file, lib_name, cell_name, instantiation_rewrite=<function _instantiation_rewrite>)

Load a design from IPKISS Canvas and returns the instances, links and external_terms.

With this function, users can retrieve the instances, links and external_terms from a design created in IPKISS Canvas. This is useful for programmatically verifying functionality of the design, performing SDL (schematic-driven layout), or similar.

Limitations

Assumes that the *.iclib files used in the project are placed next to all.py of the library they export. If this is not the case, automated library imports will fail, and load_design will be unable to resolve instances in your design.

Parameters:

project_file: str

Project filename to load the cell from.

lib_name, cell_name: str

library and cell name.

instantiation_rewrite: function

Allows to customize how IPKISS pcells are instantiated.

Returns:

instances: dict[str, PCell]

cell instances {instance_name: cell}

links: List[Tuple[str, …]]

connections in the schematic

external_terms: Dict[str, str]

external terms of the cell {“external_term_name”: “inst_name:inst_term_name”}