tidy3d.plugins.klayout.check_installation

tidy3d.plugins.klayout.check_installation#

class check_installation[source]#

Bases:

Checks if KLayout is installed and added to the system PATH. If it is, this returns the path to the executable. Otherwise, returns None. Equivalent to $which(β€œklayout”) in the terminal.

Parameters:

raise_error (bool) – Whether to raise an error if KLayout is not found. If False, a warning is shown.

Returns:

The path to the KLayout executable. If KLayout is not found, returns None.

Return type:

Union[str, None]

Inherited Common Usage