tidy3d.plugins.smatrix.run.run

Contents

tidy3d.plugins.smatrix.run.run#

class run[source]#

Bases:

Execute the full simulation workflow for a given component modeler.

This function orchestrates the end-to-end process: 1. Creates a Batch of simulations from the modeler. 2. Submits the Batch for execution and waits for results. 3. Composes the results into a structured ComponentModelerDataType object.

Parameters:

  • modeler (ComponentModelerType) – The component modeler defining the simulations to be run.

  • path_dir (str, optional) – The directory where the batch file will be saved. Defaults to “.”.

  • **kwargs – Extra keyword arguments propagated to the Batch creation.

Returns:

An object containing the processed simulation data, ready for S-parameter extraction and analysis.

Return type:

ComponentModelerDataType

Inherited Common Usage