Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix docstring #519

Merged
merged 1 commit into from
Dec 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 18 additions & 21 deletions gplugins/sentaurus/sde.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ def initialize_sde(
"""Returns a string defining the geometry definition for a Sentaurus sde file based on a component, initial wafer state, and settings.

Arguments:
component,: gdsfactory component containing polygons defining the mask
component: gdsfactory component containing polygons defining the mask
waferstack: gdsfactory layerstack representing the initial wafer
layermap: gdsfactory LayerMap object containing all layers
process: list of gdsfactory.technology.processes process steps
xsection_bounds: two in-plane coordinates ((x1,y1), (x2,y2)) defining a line cut for a 2D process cross-section
xsection_bounds: two in-plane coordinates ((x1,y1), (x2,y2)) defining a line cut for a 2D process cross-section. If None, simulate in 3D.
u_offset: for the x-axis of the 2D coordinate system, useful to go back to component units if xsection_bounds parallel to x or y
round_tol (int): for gds cleanup (grid snapping by rounding coordinates)
simplify_tol (float): for gds cleanup (shape simplification)
round_tol: for gds cleanup (grid snapping by rounding coordinates)
simplify_tol: for gds cleanup (shape simplification)
header_str: initial string to write to the TCL file. Useful for settings
"""
output_str = ""

Expand Down Expand Up @@ -113,25 +113,22 @@ def write_sde(
"""Writes a Sentaurus Device Editor Scheme file for the component + layermap + initial waferstack + process.

Arguments:
component,: gdsfactory component containing polygons defining the mask
waferstack: gdsfactory layerstack representing the initial wafer
layermap: gdsfactory LayerMap object containing all layers
process: list of gdsfactory.technology.processes process steps
xsection_bounds: two in-plane coordinates ((x1,y1), (x2,y2)) defining a line cut for a 2D process cross-section. If None, simulate in 3D.
u_offset: offset for lateral dimension of xsection mesh
save_directory: directory where to save output and script. Default ./sprocess
component: gdsfactory component containing polygons defining the mask.
waferstack: gdsfactory layerstack representing the initial wafer.
layermap: gdsfactory LayerMap object containing all layers.
process: list of gdsfactory.technology.processes process steps.
contact_str: string defining the contacts to be added to the device.
slice_str: string defining the slices to be added to the device.
init_tdr: tdr file containing the initial structure, ready for sdevice simulation.
save_directory: directory where to save output and script. Default ./sprocess.
execution_directory: directory where sprocess will be run from. Default local ./
filename: name of the final sprocess command file
struct_prefix: prefixes of the final sprocess command file
structout: tdr file containing the final structure, ready for sdevice simulation. Defaults to component name.
contact_portnames Tuple(str): list of portnames to convert into device contacts
round_tol (int): for gds cleanup (grid snapping by rounding coordinates)
fileout: tdr file containing the final structure, ready for sdevice simulation. Defaults to component name.
round_tol: for gds cleanup (grid snapping by rounding coordinates).
simplify_tol (float): for gds cleanup (shape simplification)
split_steps (bool): if True, creates a new workbench node for each step, and saves a TDR file at each step. Useful for fabrication splits, visualization, and debugging.
init_lines (str): initial string to write to the TCL file. Useful for settings
initial_z_resolutions {key: float}: initial layername: spacing mapping for mesh resolution in the wafer normal direction
initial_xy_resolution (float): initial resolution in the wafer plane
global_device_remeshing_str (str): commands to apply before remeshing
device_remesh (bool): whether to remesh the device after processing.
remesh_str (str): string defining the remeshing options.
header_str (str): initial string to write to the TCL file. Useful for settings.
num_threads (int): for parallelization
"""
save_directory = Path("./sde/") if save_directory is None else Path(save_directory)
Expand Down
14 changes: 7 additions & 7 deletions gplugins/tidy3d/tests/test_materials.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def test_material_medium() -> None:
clad_material=td.Medium(permittivity=(1.448) ** 2),
**settings,
)
strip._data
assert strip._data


def test_material_float() -> None:
Expand All @@ -32,7 +32,7 @@ def test_material_float() -> None:
clad_material=1.4,
**settings,
)
strip._data
assert strip._data


def test_material_string() -> None:
Expand All @@ -41,7 +41,7 @@ def test_material_string() -> None:
clad_material="sio2",
**settings,
)
strip._data
assert strip._data


def test_material_validation_error() -> None:
Expand All @@ -51,7 +51,7 @@ def test_material_validation_error() -> None:
clad_material="sio2",
**settings,
)
strip._data
assert strip._data


def test_material_library_many_variants() -> None:
Expand All @@ -61,7 +61,7 @@ def test_material_library_many_variants() -> None:
clad_material="sio2",
**settings,
)
strip._data
assert strip._data


def test_material_library_single_variant() -> None:
Expand All @@ -70,7 +70,7 @@ def test_material_library_single_variant() -> None:
clad_material="AlxOy",
**settings,
)
strip._data
assert strip._data


def test_material_library() -> None:
Expand All @@ -79,7 +79,7 @@ def test_material_library() -> None:
clad_material="sio2",
**settings,
)
strip._data
assert strip._data


if __name__ == "__main__":
Expand Down
Loading