gplugins.sax.read.model_from_component

gplugins.sax.read.model_from_component#

gplugins.sax.read.model_from_component(component, simulator: Literal['lumerical', 'meep', 'tidy3d'], **kwargs) → Annotated[Annotated[Callable[[...], dict[tuple[Annotated[str, PlainValidator(func=val_port, json_schema_input_type=Any)], Annotated[str, PlainValidator(func=val_port, json_schema_input_type=Any)]], Annotated[Array, complexfloating, PlainValidator(func=val_complex_array, json_schema_input_type=Any)]]], PlainValidator(func=val_model, json_schema_input_type=Any)] | Annotated[Callable[[...], tuple[Annotated[Array, complexfloating, PlainValidator(func=val_complex_array, json_schema_input_type=Any)], dict[Annotated[str, PlainValidator(func=val_port, json_schema_input_type=Any)], int]]], PlainValidator(func=val_model, json_schema_input_type=Any)] | Annotated[Callable[[...], tuple[Annotated[Array | ndarray, signedinteger, 1, PlainValidator(func=val_int_array_1d, json_schema_input_type=Any)], Annotated[Array | ndarray, signedinteger, 1, PlainValidator(func=val_int_array_1d, json_schema_input_type=Any)], Annotated[Array, complexfloating, PlainValidator(func=val_complex_array, json_schema_input_type=Any)], dict[Annotated[str, PlainValidator(func=val_port, json_schema_input_type=Any)], int]]], PlainValidator(func=val_model, json_schema_input_type=Any)], PlainValidator(func=val_model, json_schema_input_type=Any)] | Annotated[Annotated[Callable[[...], tuple[Annotated[Array, complexfloating, PlainValidator(func=val_complex_array, json_schema_input_type=Any)], dict[Annotated[str, PlainValidator(func=val_port_mode, json_schema_input_type=Any)], int]]], PlainValidator(func=val_model, json_schema_input_type=Any)] | Annotated[Callable[[...], tuple[Annotated[Array | ndarray, signedinteger, 1, PlainValidator(func=val_int_array_1d, json_schema_input_type=Any)], Annotated[Array | ndarray, signedinteger, 1, PlainValidator(func=val_int_array_1d, json_schema_input_type=Any)], Annotated[Array, complexfloating, PlainValidator(func=val_complex_array, json_schema_input_type=Any)], dict[Annotated[str, PlainValidator(func=val_port_mode, json_schema_input_type=Any)], int]]], PlainValidator(func=val_model, json_schema_input_type=Any)] | Annotated[Callable[[...], dict[tuple[Annotated[str, PlainValidator(func=val_port_mode, json_schema_input_type=Any)], Annotated[str, PlainValidator(func=val_port_mode, json_schema_input_type=Any)]], Annotated[Array, complexfloating, PlainValidator(func=val_complex_array, json_schema_input_type=Any)]]], PlainValidator(func=val_model, json_schema_input_type=Any)], PlainValidator(func=val_model, json_schema_input_type=Any)][source]#

Returns SAX model from lumerical FDTD simulations.

Parameters:

  • component – to simulate.

  • simulator – meep, lumerical or tidy3d.

  • kwargs – simulator settings.

Contents