siepic-sin-forge 1.2.0__tar.gz

siepic_sin_forge-1.2.0/LICENSE

@@ -0,0 +1,19 @@
+Copyright 2024 Flexcompute Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

siepic_sin_forge-1.2.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: siepic-sin-forge
+Version: 1.2.0
+Summary: SiEPIC EBeam SiN PDK implementation for PhotonForge
+Author-email: "Flexcompute Inc." <info@flexcompute.com>
+Project-URL: homepage, https://github.com/flexcompute/siepic-forge
+Project-URL: documentation, https://github.com/flexcompute/siepic-forge
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: photonforge>=1.4.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.2; extra == "test"
+Dynamic: license-file
+
+# SiEPIC Forge
+
+This python module implements the [SiEPIC EBeam SiN
+PDK](https://github.com/SiEPIC/SiEPIC_EBeam_PDK) processes and components and
+technology specifications for
+[PhotonForge](https://docs.flexcompute.com/projects/photonforge/)
+
+
+## Installation
+
+### Python interface
+
+Installation via `pip`:
+
+    pip install siepic-sin-forge
+
+
+## Usage
+
+The simplest way to use the this PDK in PhotonForge is to set its technology as
+default:
+
+    import photonforge as pf
+    import siepic_sin_forge as siepic
+
+    tech = siepic.ebeam()
+    pf.config.default_technology = tech
+
+
+The `ebeam` function creates a parametric technology and accepts a number of
+parameters to fine-tune the technology.
+
+PDK components are available through the `component` function, which takes a
+component name as first argument. The list of component names is available as a
+set `component_names`:
+
+    print(siepic.component_names)
+    
+    pdk_component = siepic.component("ebeam_YBranch_895")
+
+
+More information can be obtained in the documentation for each function:
+
+    help(siepic.ebeam)
+
+    help(siepic.component)
+
+
+## Warnings
+
+Please note that the 3D structures obtained by extrusion through this module's
+technologies are a best approximation of the intended fabricated structures,
+but the actual final dimensions may differ due to several fabrication-specific
+effects. In particular, doping profiles are represented with hard-boundary,
+homogeneous solids, but, in practice will present process-dependent variations
+with smooth boundaries.
+
+
+## References
+
+Process stack and other information obtained from [ANT
+NanoSOI](https://www.appliednt.com/nanosoi/).
+
+The GDSII cell library comes from the main PDK repository.
+
+
+## Third-Party Licenses
+
+- [`SiEPIC_EBeam_PDK`](https://github.com/SiEPIC/SiEPIC_EBeam_PDK)
+
+  > This project is licensed under the terms of the MIT license.
+  > 
+  > Copyright (c) 2016-2020, Lukas Chrostowski and contributors
+  > 
+  > Permission is hereby granted, free of charge, to any person obtaining a
+  > copy of this software and associated documentation files (the "Software"),
+  > to deal in the Software without restriction, including without limitation
+  > the rights to use, copy, modify, merge, publish, distribute, sublicense,
+  > and/or sell copies of the Software, and to permit persons to whom the
+  > Software is furnished to do so, subject to the following conditions:
+  > 
+  > The above copyright notice and this permission notice shall be included in
+  > all copies or substantial portions of the Software.
+  > 
+  > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  > FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+  > DEALINGS IN THE SOFTWARE.

siepic_sin_forge-1.2.0/README.md

@@ -0,0 +1,91 @@
+# SiEPIC Forge
+
+This python module implements the [SiEPIC EBeam SiN
+PDK](https://github.com/SiEPIC/SiEPIC_EBeam_PDK) processes and components and
+technology specifications for
+[PhotonForge](https://docs.flexcompute.com/projects/photonforge/)
+
+
+## Installation
+
+### Python interface
+
+Installation via `pip`:
+
+    pip install siepic-sin-forge
+
+
+## Usage
+
+The simplest way to use the this PDK in PhotonForge is to set its technology as
+default:
+
+    import photonforge as pf
+    import siepic_sin_forge as siepic
+
+    tech = siepic.ebeam()
+    pf.config.default_technology = tech
+
+
+The `ebeam` function creates a parametric technology and accepts a number of
+parameters to fine-tune the technology.
+
+PDK components are available through the `component` function, which takes a
+component name as first argument. The list of component names is available as a
+set `component_names`:
+
+    print(siepic.component_names)
+    
+    pdk_component = siepic.component("ebeam_YBranch_895")
+
+
+More information can be obtained in the documentation for each function:
+
+    help(siepic.ebeam)
+
+    help(siepic.component)
+
+
+## Warnings
+
+Please note that the 3D structures obtained by extrusion through this module's
+technologies are a best approximation of the intended fabricated structures,
+but the actual final dimensions may differ due to several fabrication-specific
+effects. In particular, doping profiles are represented with hard-boundary,
+homogeneous solids, but, in practice will present process-dependent variations
+with smooth boundaries.
+
+
+## References
+
+Process stack and other information obtained from [ANT
+NanoSOI](https://www.appliednt.com/nanosoi/).
+
+The GDSII cell library comes from the main PDK repository.
+
+
+## Third-Party Licenses
+
+- [`SiEPIC_EBeam_PDK`](https://github.com/SiEPIC/SiEPIC_EBeam_PDK)
+
+  > This project is licensed under the terms of the MIT license.
+  > 
+  > Copyright (c) 2016-2020, Lukas Chrostowski and contributors
+  > 
+  > Permission is hereby granted, free of charge, to any person obtaining a
+  > copy of this software and associated documentation files (the "Software"),
+  > to deal in the Software without restriction, including without limitation
+  > the rights to use, copy, modify, merge, publish, distribute, sublicense,
+  > and/or sell copies of the Software, and to permit persons to whom the
+  > Software is furnished to do so, subject to the following conditions:
+  > 
+  > The above copyright notice and this permission notice shall be included in
+  > all copies or substantial portions of the Software.
+  > 
+  > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  > FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+  > DEALINGS IN THE SOFTWARE.

siepic_sin_forge-1.2.0/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools >= 45"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "siepic-sin-forge"
+version = "1.2.0"
+authors = [{name = "Flexcompute Inc.", email = "info@flexcompute.com"}]
+description = "SiEPIC EBeam SiN PDK implementation for PhotonForge"
+readme = "README.md"
+dependencies = ["photonforge >= 1.4.0"]  # Need typing submodule
+
+[project.optional-dependencies]
+test = ["pytest >= 7.2"]
+
+[project.urls]
+homepage = "https://github.com/flexcompute/siepic-forge"
+documentation = "https://github.com/flexcompute/siepic-forge"
+
+[tool.setuptools]
+packages = ["siepic_sin_forge", "siepic_sin_forge.library"]
+
+[tool.setuptools.package-data]
+siepic_sin_forge = ["library/*.gds"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+extend-select = [
+    "E",   # pycodestyle errors
+    "F",   # pyflakes
+    "B",   # bugbear
+    "I",   # isort
+    "UP",  # pyupgrade
+    "W",   # pycodestyle
+    "C4",  # flake8-comprehensions
+    "NPY", # numpy-specific rules
+    "RUF", # ruff builtins
+    "ISC", # implicit string concatenation
+    "PIE", # flake8-pie
+    "RSE", # unnecessary parantheses on raised exceptions
+    "PLE", # pylint errors
+    "PLC", # pylint conventions
+]
+
+extend-ignore = [
+    "RUF001",  # ambiguous unicode characters
+    "RUF002",  # ambiguous unicode characters
+    "RUF003",  # ambiguous unicode characters
+    "B006",    # mutable data structures for argument defaults
+    "PLC0206", # Extracting value from dictionary without calling `.items()`
+    "UP038",   # Unions instead of tuples in isinstance/issubclass
+]

siepic_sin_forge-1.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

siepic_sin_forge-1.2.0/siepic_sin_forge/__init__.py

@@ -0,0 +1,34 @@
+from .component import component, component_names  # noqa: F401
+from .technology import ebeam
+
+__version__ = "1.2.0"
+
+
+def plot_cross_section(technology=None):
+    import photonforge as pf
+
+    if technology is None:
+        technology = ebeam()
+
+    c = pf.Component("Extrusion test", technology)
+    c.add(
+        "SiN",
+        pf.Rectangle((-0.5, -1), (1, 1)),
+        "Oxide open to BOX",
+        pf.Rectangle((-2, -1), (2.5, 1)),
+        "SiN",
+        pf.Rectangle((4, -1), (5.5, 1)),
+        "M1_heater",
+        pf.Rectangle((6, -1), (12, 1)),
+        "M2_router",
+        pf.Rectangle((8, -1), (12, 1)),
+        "M_Open",
+        pf.Rectangle((9, -1), (11, 1)),
+        "Deep Trench",
+        pf.Rectangle((15, -1), (20, 1)),
+    )
+
+    ax = pf.tidy3d_plot(c, y=0)
+    ax.set(title=technology.name)
+
+    return ax

siepic_sin_forge-1.2.0/siepic_sin_forge/_component_data.py

@@ -0,0 +1,189 @@
+import math
+
+_symmetries_3port = [("P1", "P2", {"P0": "P0", "P2": "P1"})]
+
+_symmetries_crossing = [
+    ("P0", "P1", {"P1": "P0", "P2": "P3", "P3": "P2"}),
+    ("P2", "P3", {"P0": "P1", "P1": "P0", "P3": "P2"}),
+]
+
+_symmetries_directional_coupler = [
+    ("P0", "P1", {"P1": "P0", "P2": "P3", "P3": "P2"}),
+    ("P0", "P2", {"P1": "P3", "P2": "P0", "P3": "P1"}),
+    ("P0", "P3", {"P1": "P2", "P2": "P1", "P3": "P0"}),
+]
+
+_symmetries_mmi22 = _symmetries_directional_coupler
+
+_waist = 5.0
+
+_angle = 8 * math.pi / 180
+_vx8 = math.sin(_angle)
+_vy8 = -math.cos(_angle)
+
+_angle = 10 * math.pi / 180
+_te895_vx = math.sin(_angle)
+_te895_vy = -math.cos(_angle)
+
+_component_data = {
+    "ANT_MMI_1x2_te1550_3dB_BB": (
+        "ANT_MMI_1x2_te1550_3dB_BB",
+        [
+            ((-12.88, 0.0), 0, "SiN_TE_1550_750"),
+            ((12.88, -0.975), 180, "SiN_TE_1550_750"),
+            ((12.88, 0.975), 180, "SiN_TE_1550_750"),
+        ],
+        None,
+        "mmi1x2",
+    ),
+    "GC_SiN_TE_1310_8degOxide_BB": (
+        "GC_SiN_TE_1310_8degOxide_BB",
+        [
+            ((0.0, 0.0), 180, "SiN_TE_1310_750"),
+            ((-29.7, 0.0), (_vx8, 0, _vy8), _waist, 90),
+        ],
+        None,
+        "grating_coupler",
+    ),
+    "GC_SiN_TE_1550_8degOxide_BB": (
+        "GC_SiN_TE_1550_8degOxide_BB",
+        [
+            ((0.0, 0.0), 180, "SiN_TE_1550_750"),
+            ((-29.7, 0.0), (_vx8, 0, _vy8), _waist, 90),
+        ],
+        None,
+        "grating_coupler",
+    ),
+    "ebeam_MMI_2x2_5050_te1310": (
+        "ULaval",
+        [
+            ((-16.72, -1.2), 0, "SiN_TE_1550_800"),
+            ((-16.72, 1.2), 0, "SiN_TE_1550_800"),
+            ((16.72, -1.2), 180, "SiN_TE_1550_800"),
+            ((16.72, 1.2), 180, "SiN_TE_1550_800"),
+        ],
+        {"port_symmetries": _symmetries_mmi22},
+        "mmi2x2",
+    ),
+    "ebeam_YBranch_te1310": (
+        "ULaval",
+        [
+            ((-7.69, 0.0), 0, "SiN_TE_1310_800"),
+            ((15.5, -1.0), 180, "SiN_TE_1310_800"),
+            ((15.5, 1.0), 180, "SiN_TE_1310_800"),
+        ],
+        {"port_symmetries": _symmetries_3port},
+        "y-splitter",
+    ),
+    "crossing_horizontal": (
+        "crossing_horizontal",
+        [
+            ((-37.83, -17.12), 0, "SiN_TE_1550_750"),
+            ((-37.83, 17.12), 0, "SiN_TE_1550_750"),
+            ((37.83, -17.12), 180, "SiN_TE_1550_750"),
+            ((37.83, 17.12), 180, "SiN_TE_1550_750"),
+        ],
+        {"port_symmetries": _symmetries_directional_coupler},
+        "crossing",
+    ),
+    "crossing_manhattan": (
+        "crossing_manhattan",
+        [
+            ((-3.5, 0.0), 0, "SiN_TE_1550_750"),
+            ((3.5, 0.0), 180, "SiN_TE_1550_750"),
+            ((0.0, -3.5), 90, "SiN_TE_1550_750"),
+            ((0.0, 3.5), 270, "SiN_TE_1550_750"),
+        ],
+        {"port_symmetries": _symmetries_crossing},
+        "crossing",
+    ),
+    "ebeam_BondPad": (
+        "ebeam_BondPad",
+        [((0, 0), (100, 100), "M2_router")],
+        None,
+        "bondpad",
+    ),
+    "ebeam_DC_2-1_te895": (
+        "ebeam_DC_2-1_te895",
+        [
+            ((-14.56, -2.285), 0, "SiN_TE_895_450"),
+            ((-14.56, 2.285), 0, "SiN_TE_895_450"),
+            ((14.56, -2.285), 180, "SiN_TE_895_450"),
+            ((14.56, 2.285), 180, "SiN_TE_895_450"),
+        ],
+        {"port_symmetries": _symmetries_directional_coupler},
+        "dc",
+    ),
+    "ebeam_DC_te895": (
+        "ebeam_DC_te895",
+        [
+            ((-14.137, -2.285), 0, "SiN_TE_895_450"),
+            ((-14.137, 2.285), 0, "SiN_TE_895_450"),
+            ((14.137, -2.285), 180, "SiN_TE_895_450"),
+            ((14.137, 2.285), 180, "SiN_TE_895_450"),
+        ],
+        {"port_symmetries": _symmetries_directional_coupler},
+        "dc",
+    ),
+    "ebeam_Polarizer_TM_1550_UQAM": (
+        "ebeam_Polarizer_TM_1550_UQAM",
+        [((-6.0, 0.0), 0, "SiN_TE-TM_1550_1000"), ((6.0, 0.0), 180, "SiN_TE-TM_1550_1000")],
+        {},
+        "transition",
+    ),
+    "ebeam_YBranch_895": (
+        "ebeam_YBranch_895",
+        [
+            ((0.0, 0.0), 0, "SiN_TE_895_450"),
+            ((15.0, -2.75), 180, "SiN_TE_895_450"),
+            ((15.0, 2.75), 180, "SiN_TE_895_450"),
+        ],
+        {"port_symmetries": _symmetries_3port},
+        "y-splitter",
+    ),
+    "ebeam_gc_te895": (
+        "ebeam_gc_te895",
+        [
+            ((0.0, 0.0), 180, "SiN_TE_895_450"),
+            ((-29.0, 0), (_te895_vx, 0, _te895_vy), _waist, 90),
+        ],
+        {"symmetry": (0, -1, 0), "bounds": ((None, -10, None), (None, 10, None))},
+        "grating_coupler",
+    ),
+    "ebeam_terminator_SiN_1310": (
+        "ebeam_terminator_SiN_1310",
+        [((0.0, 0.0), 180, "SiN_TE_1310_800")],
+        {},
+        "termination",
+    ),
+    "ebeam_terminator_SiN_1550": (
+        "ebeam_terminator_SiN_1550",
+        [((0.0, 0.0), 180, "SiN_TE_1550_750")],
+        {},
+        "termination",
+    ),
+    "ebeam_terminator_SiN_te895": (
+        "ebeam_terminator_SiN_te895",
+        [((0.0, 0.0), 180, "SiN_TE_895_450")],
+        {},
+        "termination",
+    ),
+    "port_SiN_800": (
+        "port_SiN_800",
+        [((1.0, 0.0), 180, "SiN_TE_1550_800")],
+        {},
+        "termination",
+    ),
+    "taper_SiN_750_3000": (
+        "taper_SiN_750_3000",
+        [((0.0, 0.0), 0, "SiN_TE_1550_750"), ((50.0, 0.0), 180, "MM_SiN_TE_1550_3000")],
+        {},
+        "taper",
+    ),
+    "taper_SiN_750_800": (
+        "taper_SiN_750_800",
+        [((0.0, 0.0), 0, "SiN_TE_1550_800"), ((2.0, 0.0), 180, "SiN_TE_1550_750")],
+        {},
+        "taper",
+    ),
+}

siepic_sin_forge-1.2.0/siepic_sin_forge/_layers.py

@@ -0,0 +1,116 @@
+import photonforge as pf
+
+_layers = {
+    "PinRec": pf.LayerSpec((1, 10), "SiEPIC", "#ff80a818", ""),
+    "PinRecM": pf.LayerSpec((1, 11), "SiEPIC", "#80000018", ""),
+    "SiN": pf.LayerSpec((4, 0), "Silicon Nitride Full Etch", "#c080ff18", "."),
+    "Direct Metal": pf.LayerSpec((5, 0), "Dedicated Run Layers", "#80a8ff18", ""),
+    "Oxide open to BOX": pf.LayerSpec((6, 0), "Dedicated Run Layers", "#ff000018", ""),
+    "Text": pf.LayerSpec((10, 0), "Text-Not Fabricated", "#00000018", "hollow"),
+    "M1_heater": pf.LayerSpec((11, 0), "TiW Heater", "#0000ff18", "\\\\"),
+    "M2_router": pf.LayerSpec((12, 0), "TiW/Au Routing Bilayer", "#ffbf0018", "//"),
+    "M_Open": pf.LayerSpec((13, 0), "Bond Pad Open", "#80005718", "\\\\"),
+    "Si n": pf.LayerSpec((20, 0), "Dedicated Run Layers", "#afff8018", ""),
+    "Si p": pf.LayerSpec((21, 0), "Dedicated Run Layers", "#ffd9df18", ""),
+    "Si n+": pf.LayerSpec((22, 0), "Dedicated Run Layers", "#ff800018", ""),
+    "Si p+": pf.LayerSpec((23, 0), "Dedicated Run Layers", "#ddff0018", ""),
+    "Si n++": pf.LayerSpec((24, 0), "Dedicated Run Layers", "#00ffff18", ""),
+    "Si p++": pf.LayerSpec((25, 0), "Dedicated Run Layers", "#00800018", ""),
+    "ANT Reserved": pf.LayerSpec((31, 0), "SiEPIC/ANT Reserved", "#9580ff18", "/"),
+    "ANT Reserved 1": pf.LayerSpec((33, 0), "ANT Reserved", "#9580ff18", "/"),
+    "Via to silicon": pf.LayerSpec((40, 0), "Dedicated Run Layers", "#0000ff18", ""),
+    "DevRec": pf.LayerSpec((68, 0), "SiEPIC", "#00800018", ""),
+    "FbrTgt": pf.LayerSpec((81, 0), "SiEPIC/Dedicated Run Layers", "#80808018", ""),
+    "ANT Reserved 2": pf.LayerSpec((102, 0), "ANT Reserved", "#9580ff18", "/"),
+    "ANT Reserved 3": pf.LayerSpec((110, 0), "ANT Reserved", "#9580ff18", "/"),
+    "Custom Dicing": pf.LayerSpec((189, 0), "", "#00000018", "hollow"),
+    "SEM Imaging": pf.LayerSpec((200, 0), "", "#ff000018", "x"),
+    "Deep Trench": pf.LayerSpec((201, 0), "", "#00ff0018", "."),
+    "Deep Trench Handling Exclusion": pf.LayerSpec((202, 0), "", "#00760018", ":"),
+    "Thermal Isolation Trenches": pf.LayerSpec((203, 0), "", "#00800018", "\\"),
+    "Laser Integration Shelf": pf.LayerSpec((205, 0), "Dedicated Run Layers", "#69ff0518", ""),
+    "Floor Plan-Not Fabricated": pf.LayerSpec((290, 0), "", "#c080ff18", "hollow"),
+    "Error: device layer width is less than design rule": pf.LayerSpec(
+        (301, 0), "DRC Errors", "#80005718", ""
+    ),
+    "Error: device layer spacing is less than design rule": pf.LayerSpec(
+        (301, 1), "DRC Errors", "#80005718", ""
+    ),
+    "Warning: polygons/paths on PinRec layer (1/10) will NOT be fabricated": pf.LayerSpec(
+        (301, 2), "DRC Errors", "#80005718", ""
+    ),
+    "Error: direct metal width is less than 5 microns": pf.LayerSpec(
+        (305, 0), "DRC Errors", "#80808018", ""
+    ),
+    "Error: direct metal spacing is less than 10 microns": pf.LayerSpec(
+        (305, 1), "DRC Errors", "#80808018", ""
+    ),
+    "Error: TiW width is less than 3 microns": pf.LayerSpec(
+        (311, 0), "DRC Errors", "#ffa08018", ""
+    ),
+    "Error: TiW spacing is less than 3 microns": pf.LayerSpec(
+        (311, 1), "DRC Errors", "#ffa08018", ""
+    ),
+    "Error: Al width is less than design rule": pf.LayerSpec(
+        (312, 0), "DRC Errors", "#00ffff18", ""
+    ),
+    "Error: Al spacing is less than design rule": pf.LayerSpec(
+        (312, 1), "DRC Errors", "#00ffff18", ""
+    ),
+    "Error: Spacing between TiW and Al is less than 5 microns": pf.LayerSpec(
+        (312, 3), "DRC Errors", "#00ffff18", ""
+    ),
+    "Error: Oxide window width is less than 10 microns": pf.LayerSpec(
+        (313, 0), "DRC Errors", "#01ff6b18", ""
+    ),
+    "Error: Oxide window spacing is less than 10 microns": pf.LayerSpec(
+        (313, 1), "DRC Errors", "#01ff6b18", ""
+    ),
+    "Error: Oxide window is not placed over Al": pf.LayerSpec(
+        (313, 2), "DRC Errors", "#01ff6b18", ""
+    ),
+    "Standard Design Area": pf.LayerSpec((350, 0), "DRC Errors", "#ddff0018", ""),
+    "Error: Features outside design area. Verify design size and centering.": pf.LayerSpec(
+        (350, 1), "DRC Errors", "#ddff0018", ""
+    ),
+    "Error: Dicing lane width is less than 100 microns": pf.LayerSpec(
+        (389, 0), "DRC Errors", "#ff00ff18", ""
+    ),
+    "Error: Spacing between dicing lane and devices is less than 50 microns": pf.LayerSpec(
+        (389, 1), "DRC Errors", "#ff00ff18", ""
+    ),
+    "Error: SEM width is less than 500 nm": pf.LayerSpec((400, 0), "DRC Errors", "#ff9d9d18", ""),
+    "Deep Trench Design Area": pf.LayerSpec((401, 0), "DRC Errors", "#80a8ff18", ""),
+    "Error: Metal, SEM, or handling region overlap with deep trenches. Verify design centering": pf.LayerSpec(
+        (401, 1), "DRC Errors", "#80a8ff18", ""
+    ),
+    "Warning: Silicon features outside deep trench design area. Verify accuracy before submission": pf.LayerSpec(
+        (401, 2), "DRC Errors", "#80a8ff18", ""
+    ),
+    "Error: Spacing between metal and deep trench is less than 30 microns": pf.LayerSpec(
+        (401, 3), "DRC Errors", "#80a8ff18", ""
+    ),
+    "Error: Deep trench width is less than 260 microns": pf.LayerSpec(
+        (401, 4), "DRC Errors", "#80a8ff18", ""
+    ),
+    "Error: Deep trench handling area missing. Please add handling area of size shown by polygons": pf.LayerSpec(
+        (402, 0), "DRC Errors", "#ff000018", ""
+    ),
+    "Error: Features inside deep trench handling area": pf.LayerSpec(
+        (402, 1), "DRC Errors", "#ff000018", ""
+    ),
+    "Error: Thermal isolation width is less than design rule": pf.LayerSpec(
+        (403, 0), "DRC Errors", "#50008018", ""
+    ),
+    "Error: Thermal isolation spacing is less than design rule": pf.LayerSpec(
+        (403, 1), "DRC Errors", "#50008018", ""
+    ),
+    "Error: Spacing between thermal isolation and metal is less than design rule": pf.LayerSpec(
+        (403, 2), "DRC Errors", "#50008018", ""
+    ),
+    "Error: Thermal isolation and device layer overlap, or spacing is less than design rule": pf.LayerSpec(
+        (403, 3), "DRC Errors", "#50008018", ""
+    ),
+    "Dream Photonics Black Box-Not Fabricated": pf.LayerSpec((998, 0), "", "#00000018", "hollow"),
+    "Errors": pf.LayerSpec((999, 0), "SiEPIC", "#0000ff18", ""),
+}

siepic_sin_forge-1.2.0/siepic_sin_forge/component.py

@@ -0,0 +1,107 @@
+import warnings
+
+try:
+    from importlib.resources import as_file, files
+except ImportError:
+    from importlib_resources import as_file, files
+
+import photonforge as pf
+import photonforge.typing as pft
+
+from ._component_data import _component_data
+
+component_names = set(_component_data.keys())
+
+
+def component(
+    cell_name: str,
+    technology: pf.Technology | None = None,
+    tidy3d_model_kwargs: pft.kwargs_for(pf.Tidy3DModel) = {},
+) -> pf.Component:
+    """Load a component from the default PDK library.
+
+    Args:
+        cell_name (str): Name of the component to load.
+        technology (Technology): Technology for the created component.
+        tidy3d_model_kwargs (dict): Keyword arguments passed to the Tidy3D
+          model of the created component.
+
+    Returns:
+        Component: Component loaded from the default PDK library.
+
+    Note:
+        The available component names are listed in the module-level tuple
+        ``component_names``.
+    """
+    libname, port_data, kwargs, thumbnail = _component_data.get(
+        cell_name, (None, None, None, None)
+    )
+
+    if technology is None:
+        technology = pf.config.default_technology
+        if "SiEPIC" not in technology.name:
+            warnings.warn(
+                f"Current default technology {technology.name} does not seem compatible with the "
+                f"SiEPIC component library",
+                RuntimeWarning,
+                2,
+            )
+
+    # Load library cell
+    gdsii = files("siepic_sin_forge") / "library" / (libname + ".gds")
+    with as_file(gdsii) as fname:
+        c = pf.load_layout(fname, technology=technology)[cell_name]
+
+    if thumbnail:
+        c.properties.__thumbnail__ = thumbnail
+
+    for layer, labels in c.labels.items():
+        for label in labels:
+            if "lumerical" in label.text.lower():
+                c.remove(label, layer=layer)
+
+    # Add ports
+    z = (
+        0.1
+        + technology.parametric_kwargs.get("top_oxide_thickness", 3.0)
+        + technology.parametric_kwargs.get("passivation_oxide_thickness", 0.3)
+    )
+    port_error = False
+    for data in port_data:
+        if len(data) == 3:
+            if isinstance(data[1], tuple):
+                terminal = pf.Terminal(
+                    technology.layers[data[2]].layer, pf.Rectangle(center=data[0], size=data[1])
+                )
+                c.add_terminal(terminal)
+            else:
+                port_spec = technology.ports.get(data[2])
+                if port_spec is None:
+                    port_error = True
+                    warnings.warn(
+                        f"Required port spec {data[2]} not available in technology "
+                        f"{technology.name!r}. Port skipped.",
+                        RuntimeWarning,
+                        2,
+                    )
+                else:
+                    port = pf.Port(data[0], data[1], port_spec)
+                    c.add_port(port)
+        else:
+            port = pf.GaussianPort(
+                data[0] + (z,),
+                data[1],
+                waist_radius=data[2],
+                polarization_angle=data[3],
+            )
+            c.add_port(port)
+
+    # Add model
+    if kwargs is not None:
+        kwargs = dict(kwargs)
+        if port_error and "port_symmetries" in kwargs:
+            del kwargs["port_symmetries"]
+        kwargs.update(tidy3d_model_kwargs)
+        c.add_model(pf.Tidy3DModel(**kwargs), "Tidy3D")
+
+    return c

siepic_sin_forge-1.2.0/siepic_sin_forge/technology.py

@@ -0,0 +1,215 @@
+import photonforge as pf
+import photonforge.typing as pft
+import tidy3d as td
+
+from ._layers import _layers
+
+# References:
+# https://www.appliednt.com/nanosoi-fabrication-service/
+# https://www.appliednt.com/nanosoi/sys/
+
+
+@pf.parametric_technology
+def ebeam(
+    *,
+    sin_thickness: pft.PositiveDimension = 0.400,
+    sin_mask_dilation: pft.Coordinate = 0.0,
+    sidewall_angle: pft.Angle = 0.0,
+    heater_thickness: pft.PositiveDimension = 0.2,
+    router_thickness: pft.PositiveDimension = 0.6,
+    bottom_oxide_thickness: pft.PositiveDimension = 4.5,
+    top_oxide_thickness: pft.PositiveDimension = 3.0,
+    passivation_oxide_thickness: pft.PositiveDimension = 0.3,
+    sio2: dict[str, pft.Medium] = {
+        "optical": td.material_library["SiO2"]["Palik_Lossless"],
+        "electrical": td.Medium(permittivity=4.2, name="SiO2"),
+    },
+    si: dict[str, pft.Medium] = {
+        "optical": td.material_library["cSi"]["Li1993_293K"],
+        "electrical": td.Medium(permittivity=12.3, name="Si"),
+    },
+    sin: dict[str, pft.Medium] = {
+        "optical": td.material_library["Si3N4"]["Luke2015PMLStable"],
+        "electrical": td.Medium(permittivity=7.5, name="Si3N4"),
+    },
+    router_metal: dict[str, pft.Medium] = {
+        "optical": td.material_library["Au"]["Olmon2012evaporated"],
+        "electrical": td.LossyMetalMedium(
+            conductivity=17,
+            frequency_range=[0.1e9, 200e9],
+            fit_param=td.SurfaceImpedanceFitterParam(max_num_poles=16),
+        ),
+    },
+    heater_metal: dict[str, pft.Medium] = {
+        "optical": td.material_library["W"]["Werner2009"],
+        "electrical": td.LossyMetalMedium(
+            conductivity=1.6,
+            frequency_range=[0.1e9, 200e9],
+            fit_param=td.SurfaceImpedanceFitterParam(max_num_poles=16),
+        ),
+    },
+    opening: pft.Medium = td.Medium(permittivity=1.0),
+) -> pf.Technology:
+    """Create a technology for the e-beam SiN PDK.
+
+    Args:
+        sin_thickness: SiN layer thickness.
+        sin_mask_dilation: Mask dilation for the SiN layer.
+        sidewall_angle: Sidewall angle (in degrees) for SiN etching.
+        heater_thickness: Thickness of the heater metal layer.
+        router_thickness: Thickness of the routing metal bilayer.
+        bottom_oxide_thickness: Thickness of the bottom oxide clad.
+        top_oxide_thickness: Thickness of the top oxide clad, measured from
+          the substrate.
+        passivation_oxide_thickness: Thickness of oxide above metal layers.
+        sio2: Background medium.
+        si: Silicon medium.
+        sin: Silicon nitride medium.
+        router_metal: Routing metal medium.
+        heater_metal: Heater metal medium.
+        opening: Medium for openings.
+
+    Returns:
+        Technology: E-Beam PDK technology definition.
+    """
+
+    layers = {k: v.copy() for k, v in _layers.items()}
+
+    z_router = top_oxide_thickness + heater_thickness
+    z_open = z_router + router_thickness
+    z_top = z_open + passivation_oxide_thickness
+
+    extrusion_specs = [
+        pf.ExtrusionSpec(pf.MaskSpec(), si, (-pf.Z_INF, 0)),
+        pf.ExtrusionSpec(
+            pf.MaskSpec(),
+            sio2,
+            (-bottom_oxide_thickness, top_oxide_thickness + passivation_oxide_thickness),
+        ),
+        pf.ExtrusionSpec(
+            pf.MaskSpec((11, 0), dilation=passivation_oxide_thickness),
+            sio2,
+            (top_oxide_thickness, z_router + passivation_oxide_thickness),
+        ),
+        pf.ExtrusionSpec(
+            pf.MaskSpec((12, 0), dilation=passivation_oxide_thickness),
+            sio2,
+            (top_oxide_thickness, z_top),
+        ),
+        pf.ExtrusionSpec(pf.MaskSpec((11, 0)), heater_metal, (top_oxide_thickness, z_router)),
+        pf.ExtrusionSpec(pf.MaskSpec((12, 0)), router_metal, (z_router, z_open)),
+        pf.ExtrusionSpec(pf.MaskSpec((13, 0)), opening, (z_open, z_top)),
+        pf.ExtrusionSpec(pf.MaskSpec((6, 0)), opening, (0, pf.Z_INF)),
+        pf.ExtrusionSpec(
+            pf.MaskSpec((4, 0), dilation=sin_mask_dilation), sin, (0, sin_thickness), sidewall_angle
+        ),
+        pf.ExtrusionSpec(pf.MaskSpec([(201, 0), (203, 0)]), opening, (-pf.Z_INF, pf.Z_INF)),
+    ]
+
+    ports = {
+        "SiN_TE_895_450": pf.PortSpec(
+            description="SiN Strip TE 895 nm, w=450 nm",
+            width=2.0,
+            limits=(-0.7, 0.7 + sin_thickness),
+            num_modes=1,
+            added_solver_modes=0,
+            polarization=None,
+            target_neff=2.1,
+            path_profiles=((0.45, 0.0, (4, 0)),),
+        ),
+        "SiN_TE_1550_750": pf.PortSpec(
+            description="SiN Strip TE 1550 nm, w=750 nm",
+            width=4.0,
+            limits=(-1.5, 1.5 + sin_thickness),
+            num_modes=1,
+            added_solver_modes=0,
+            polarization=None,
+            target_neff=2.1,
+            path_profiles=((0.75, 0.0, (4, 0)),),
+        ),
+        "SiN_TE_1550_800": pf.PortSpec(
+            description="SiN Strip TE 1550 nm, w=800 nm",
+            width=4.0,
+            limits=(-1.5, 1.5 + sin_thickness),
+            num_modes=1,
+            added_solver_modes=0,
+            polarization=None,
+            target_neff=2.1,
+            path_profiles=((0.8, 0.0, (4, 0)),),
+        ),
+        "SiN_TE_1550_1000": pf.PortSpec(
+            description="SiN Strip TE 1550 nm, w=1000 nm",
+            width=4.0,
+            limits=(-1.5, 1.5 + sin_thickness),
+            num_modes=1,
+            added_solver_modes=0,
+            polarization=None,
+            target_neff=2.1,
+            path_profiles=((1.0, 0.0, (4, 0)),),
+        ),
+        "SiN_TM_1550_1000": pf.PortSpec(
+            description="SiN Strip TM 1550 nm, w=1000 nm",
+            width=3.5,
+            limits=(-1.2, 1.2 + sin_thickness),
+            num_modes=1,
+            added_solver_modes=1,
+            polarization="TM",
+            target_neff=2.1,
+            path_profiles=((1.0, 0.0, (4, 0)),),
+        ),
+        # Added for ebeam_Polarizer_TM_1550_UQAM
+        "SiN_TE-TM_1550_1000": pf.PortSpec(
+            description="SiN Strip TM 1550 nm, w=1000 nm",
+            width=4.0,
+            limits=(-1.8, 1.8 + sin_thickness),
+            num_modes=2,
+            added_solver_modes=0,
+            polarization=None,
+            target_neff=2.1,
+            path_profiles=((1.0, 0.0, (4, 0)),),
+        ),
+        "SiN_TE_1310_750": pf.PortSpec(
+            description="SiN Strip TE 1310 nm, w=750 nm",
+            width=3.0,
+            limits=(-1, 1 + sin_thickness),
+            num_modes=1,
+            added_solver_modes=0,
+            polarization=None,
+            target_neff=2.1,
+            path_profiles=((0.75, 0.0, (4, 0)),),
+        ),
+        "SiN_TE_1310_800": pf.PortSpec(
+            description="SiN Strip TE 1310 nm, w=800 nm",
+            width=3.0,
+            limits=(-1, 1 + sin_thickness),
+            num_modes=1,
+            added_solver_modes=0,
+            polarization=None,
+            target_neff=2.1,
+            path_profiles=((0.8, 0.0, (4, 0)),),
+        ),
+        "SiN_TM_1310_750": pf.PortSpec(
+            description="SiN Strip TM 1310 nm, w=750 nm",
+            width=3.0,
+            limits=(-1.2, 1.2 + sin_thickness),
+            num_modes=1,
+            added_solver_modes=1,
+            polarization="TM",
+            target_neff=2.1,
+            path_profiles=((0.75, 0.0, (4, 0)),),
+        ),
+        "MM_SiN_TE_1550_3000": pf.PortSpec(
+            description="Multimode SiN Strip TE 1550 nm, w=3000 nm",
+            width=8.0,
+            limits=(-2.5, 2.5 + sin_thickness),
+            num_modes=7,
+            added_solver_modes=0,
+            polarization=None,
+            target_neff=2.1,
+            path_profiles=((3.0, 0.0, (4, 0)),),
+        ),
+    }
+
+    result = pf.Technology("SiEPIC EBeam SiN", "1.2.0", layers, extrusion_specs, ports, opening)
+    result.random_variables = []
+    return result

siepic_sin_forge-1.2.0/siepic_sin_forge.egg-info/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: siepic-sin-forge
+Version: 1.2.0
+Summary: SiEPIC EBeam SiN PDK implementation for PhotonForge
+Author-email: "Flexcompute Inc." <info@flexcompute.com>
+Project-URL: homepage, https://github.com/flexcompute/siepic-forge
+Project-URL: documentation, https://github.com/flexcompute/siepic-forge
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: photonforge>=1.4.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.2; extra == "test"
+Dynamic: license-file
+
+# SiEPIC Forge
+
+This python module implements the [SiEPIC EBeam SiN
+PDK](https://github.com/SiEPIC/SiEPIC_EBeam_PDK) processes and components and
+technology specifications for
+[PhotonForge](https://docs.flexcompute.com/projects/photonforge/)
+
+
+## Installation
+
+### Python interface
+
+Installation via `pip`:
+
+    pip install siepic-sin-forge
+
+
+## Usage
+
+The simplest way to use the this PDK in PhotonForge is to set its technology as
+default:
+
+    import photonforge as pf
+    import siepic_sin_forge as siepic
+
+    tech = siepic.ebeam()
+    pf.config.default_technology = tech
+
+
+The `ebeam` function creates a parametric technology and accepts a number of
+parameters to fine-tune the technology.
+
+PDK components are available through the `component` function, which takes a
+component name as first argument. The list of component names is available as a
+set `component_names`:
+
+    print(siepic.component_names)
+    
+    pdk_component = siepic.component("ebeam_YBranch_895")
+
+
+More information can be obtained in the documentation for each function:
+
+    help(siepic.ebeam)
+
+    help(siepic.component)
+
+
+## Warnings
+
+Please note that the 3D structures obtained by extrusion through this module's
+technologies are a best approximation of the intended fabricated structures,
+but the actual final dimensions may differ due to several fabrication-specific
+effects. In particular, doping profiles are represented with hard-boundary,
+homogeneous solids, but, in practice will present process-dependent variations
+with smooth boundaries.
+
+
+## References
+
+Process stack and other information obtained from [ANT
+NanoSOI](https://www.appliednt.com/nanosoi/).
+
+The GDSII cell library comes from the main PDK repository.
+
+
+## Third-Party Licenses
+
+- [`SiEPIC_EBeam_PDK`](https://github.com/SiEPIC/SiEPIC_EBeam_PDK)
+
+  > This project is licensed under the terms of the MIT license.
+  > 
+  > Copyright (c) 2016-2020, Lukas Chrostowski and contributors
+  > 
+  > Permission is hereby granted, free of charge, to any person obtaining a
+  > copy of this software and associated documentation files (the "Software"),
+  > to deal in the Software without restriction, including without limitation
+  > the rights to use, copy, modify, merge, publish, distribute, sublicense,
+  > and/or sell copies of the Software, and to permit persons to whom the
+  > Software is furnished to do so, subject to the following conditions:
+  > 
+  > The above copyright notice and this permission notice shall be included in
+  > all copies or substantial portions of the Software.
+  > 
+  > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  > FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+  > DEALINGS IN THE SOFTWARE.

siepic_sin_forge-1.2.0/siepic_sin_forge.egg-info/SOURCES.txt

@@ -0,0 +1,33 @@
+LICENSE
+README.md
+pyproject.toml
+siepic_sin_forge/__init__.py
+siepic_sin_forge/_component_data.py
+siepic_sin_forge/_layers.py
+siepic_sin_forge/component.py
+siepic_sin_forge/technology.py
+siepic_sin_forge.egg-info/PKG-INFO
+siepic_sin_forge.egg-info/SOURCES.txt
+siepic_sin_forge.egg-info/dependency_links.txt
+siepic_sin_forge.egg-info/requires.txt
+siepic_sin_forge.egg-info/top_level.txt
+siepic_sin_forge/library/ANT_MMI_1x2_te1550_3dB_BB.gds
+siepic_sin_forge/library/GC_SiN_TE_1310_8degOxide_BB.gds
+siepic_sin_forge/library/GC_SiN_TE_1550_8degOxide_BB.gds
+siepic_sin_forge/library/ULaval.gds
+siepic_sin_forge/library/crossing_SiN_1550.gds
+siepic_sin_forge/library/crossing_SiN_1550_extended.gds
+siepic_sin_forge/library/crossing_horizontal.gds
+siepic_sin_forge/library/crossing_manhattan.gds
+siepic_sin_forge/library/ebeam_BondPad.gds
+siepic_sin_forge/library/ebeam_DC_2-1_te895.gds
+siepic_sin_forge/library/ebeam_DC_te895.gds
+siepic_sin_forge/library/ebeam_Polarizer_TM_1550_UQAM.gds
+siepic_sin_forge/library/ebeam_YBranch_895.gds
+siepic_sin_forge/library/ebeam_gc_te895.gds
+siepic_sin_forge/library/ebeam_terminator_SiN_1310.gds
+siepic_sin_forge/library/ebeam_terminator_SiN_1550.gds
+siepic_sin_forge/library/ebeam_terminator_SiN_te895.gds
+siepic_sin_forge/library/port_SiN_800.gds
+siepic_sin_forge/library/taper_SiN_750_3000.gds
+siepic_sin_forge/library/taper_SiN_750_800.gds

siepic_sin_forge-1.2.0/siepic_sin_forge.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

siepic_sin_forge-1.2.0/siepic_sin_forge.egg-info/requires.txt

@@ -0,0 +1,4 @@
+photonforge>=1.4.0
+
+[test]
+pytest>=7.2

siepic_sin_forge-1.2.0/siepic_sin_forge.egg-info/top_level.txt

@@ -0,0 +1 @@
+siepic_sin_forge