siepic-forge 1.0.0__tar.gz

siepic_forge-1.0.0/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## v1.0.0 - 2024-02-13
+
+### Added
+- Initial release.

siepic_forge-1.0.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_forge-1.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include CHANGELOG.md
+graft siepic_forge/library

siepic_forge-1.0.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: siepic-forge
+Version: 1.0.0
+Summary: SiEPIC 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.0.0rc1
+Provides-Extra: test
+Requires-Dist: pytest>=7.2; extra == "test"
+
+# SiEPIC Forge
+
+This python module implements the [SiEPIC EBeam
+PDK](https://github.com/SiEPIC/SiEPIC_EBeam_PDK) PDK as components and
+technology specification for
+[PhotonForge](https://docs.flexcompute.com/projects/photonforge/)
+
+
+## Installation
+
+### Python interface
+
+Installation via `pip`:
+
+    pip install siepic-forge
+
+
+### PhotonForge Web UI
+
+In the Tidy3D web interface, go to your [*Account
+Center*](https://tidy3d.simulation.cloud/account) and upload the token file
+(.tok) under *PhotonForge Libraries* to enable this module.
+
+
+## Usage
+
+The simplest way to use the this PDK in PhotonForge is to set its technology as
+default:
+
+    import photonforge as pf
+    import siepic_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_y_1550")
+
+
+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.
+
+
+## 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_forge-1.0.0/README.md

@@ -0,0 +1,90 @@
+# SiEPIC Forge
+
+This python module implements the [SiEPIC EBeam
+PDK](https://github.com/SiEPIC/SiEPIC_EBeam_PDK) PDK as components and
+technology specification for
+[PhotonForge](https://docs.flexcompute.com/projects/photonforge/)
+
+
+## Installation
+
+### Python interface
+
+Installation via `pip`:
+
+    pip install siepic-forge
+
+
+### PhotonForge Web UI
+
+In the Tidy3D web interface, go to your [*Account
+Center*](https://tidy3d.simulation.cloud/account) and upload the token file
+(.tok) under *PhotonForge Libraries* to enable this module.
+
+
+## Usage
+
+The simplest way to use the this PDK in PhotonForge is to set its technology as
+default:
+
+    import photonforge as pf
+    import siepic_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_y_1550")
+
+
+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.
+
+
+## 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_forge-1.0.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "siepic-forge"
+version = "1.0.0"
+authors = [{name = "Flexcompute Inc.", email = "info@flexcompute.com"}]
+description = "SiEPIC PDK implementation for PhotonForge"
+readme = "README.md"
+dependencies = ["photonforge ~= 1.0.0rc1"]
+
+[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_forge"]
+
+[tool.black]
+line-length = 100
+
+[build-system]
+requires = ["setuptools >= 45"]
+build-backend = "setuptools.build_meta"

siepic_forge-1.0.0/setup.cfg

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

siepic_forge-1.0.0/siepic_forge/__init__.py

@@ -0,0 +1,4 @@
+from .technology import ebeam
+from .component import component, component_names
+
+__version__ = "1.0.0"

siepic_forge-1.0.0/siepic_forge/component.py

@@ -0,0 +1,416 @@
+try:
+    from importlib.resources import files, as_file
+except ImportError:
+    from importlib_resources import files, as_file
+
+import math
+import warnings
+
+import photonforge as pf
+
+
+_symmetries_2port = [("P0", "P1", {"P1": "P0"})]
+
+_symmetries_3port = [("P1", "P2", {"P0": "P0", "P2": "P1"})]
+
+_symmetries_crossing = [
+    ("P0", "P1", {"P1": "P0", "P2": "P3", "P3": "P2"}),
+    ("P0", "P2", {"P1": "P3", "P2": "P1", "P3": "P0"}),
+    ("P0", "P3", {"P1": "P2", "P2": "P0", "P3": "P1"}),
+]
+
+_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_mmi12 = [("P0", "P2", {"P1": "P1", "P2": "P0"})]
+
+_symmetries_mmi22 = _symmetries_directional_coupler
+
+_waist = 5.0
+
+_angle = 8 * math.pi / 180
+_vx8 = math.sin(_angle)
+_vy8 = -math.cos(_angle)
+
+_angle = 7 * math.pi / 180
+_tm1550_vx = math.sin(_angle)
+_tm1550_vy = -math.cos(_angle)
+
+_angle = -21 * math.pi / 180
+_te1550_vx = math.sin(_angle)
+_te1550_vy = -math.cos(_angle)
+
+_angle = -7 * math.pi / 180
+_te895_vx = math.sin(_angle)
+_te895_vy = -math.cos(_angle)
+
+_component_data = {
+    "ANT_MMI_1x2_te1550_3dB_BB": (
+        "EBeam_SiN",
+        "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,
+    ),
+    "GC_SiN_TE_1550_8degOxide_BB": (
+        "EBeam_SiN",
+        "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,
+    ),
+    "ebeam_MMI_2x2_5050_te1310": (
+        "EBeam_SiN",
+        "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},
+    ),
+    # NOTE: no TE port at 1310 nm with 800 nm
+    "ebeam_YBranch_te1310": (
+        "EBeam_SiN",
+        "ULaval",
+        [
+            ((-7.69, 0.0), 0, "SiN_TE_1550_800"),
+            ((7.69, 0.7), 180, "SiN_TE_1550_800"),
+            ((7.69, -0.7), 180, "SiN_TE_1550_800"),
+        ],
+        {"port_symmetries": _symmetries_3port},
+    ),
+    "ebeam_BondPad": (
+        "EBeam_SiN",
+        "ebeam_BondPad",
+        [],
+        None,
+    ),
+    "ebeam_DC_2-1_te895": (
+        "EBeam_SiN",
+        "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},
+    ),
+    "ebeam_DC_te895": (
+        "EBeam_SiN",
+        "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},
+    ),
+    # WARN: Missing port (-6.0, 0.0).
+    # WARN: Missing port (6.0, 0.0).
+    # "ebeam_Polarizer_TM_1550_UQAM": (
+    #     "EBeam_SiN",
+    #     "ebeam_Polarizer_TM_1550_UQAM",
+    #     [],
+    #     None,
+    # ),
+    "ebeam_YBranch_895": (
+        "EBeam_SiN",
+        "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},
+    ),
+    "ebeam_gc_te895": (
+        "EBeam_SiN",
+        "ebeam_gc_te895",
+        [
+            ((-24.2, 0.0), 0, "SiN_TE_895_450"),
+            ((8, 0), (_te895_vx, 0, _te895_vy), _waist, 90),
+        ],
+        {"symmetry": (0, -1, 0), "bounds": ((None, -10, None), (25, 10, None))},
+    ),
+    "ebeam_terminator_SiN_1550": (
+        "EBeam_SiN",
+        "ebeam_terminator_SiN_1550",
+        [((0.0, 0.0), 180, "SiN_TE_1550_750")],
+        {},
+    ),
+    "ebeam_terminator_SiN_te895": (
+        "EBeam_SiN",
+        "ebeam_terminator_SiN_te895",
+        [((0.0, 0.0), 180, "SiN_TE_895_450")],
+        {},
+    ),
+    "taper_SiN_750_3000": (
+        "EBeam_SiN",
+        "taper_SiN_750_3000",
+        [
+            ((0.0, 0.0), 0, "SiN_TE_1550_750"),
+            ((50.0, 0.0), 180, "MM_SiN_TE_1550_3000"),
+        ],
+        {},
+    ),
+    "GC_TE_1310_8degOxide_BB": (
+        "EBeam",
+        "GCs_BB",
+        [
+            ((0.0, 0.0), 180, "TE_1310_350"),
+            ((-20.4, 0.0), (_vx8, 0, _vy8), _waist, 90),
+        ],
+        None,
+    ),
+    "GC_TE_1550_8degOxide_BB": (
+        "EBeam",
+        "GCs_BB",
+        [
+            ((0.0, 0.0), 180, "TE_1550_500"),
+            ((-20.4, 0.0), (_vx8, 0, _vy8), _waist, 90),
+        ],
+        None,
+    ),
+    # NOTE: no TM port with width 350 nm
+    "GC_TM_1310_8degOxide_BB": (
+        "EBeam",
+        "GCs_BB",
+        [
+            ((0.0, 0.0), 180, "TE_1310_350"),
+            ((-20.4, 0.0), (_vx8, 0, _vy8), _waist, 0),
+        ],
+        None,
+    ),
+    "GC_TM_1550_8degOxide_BB": (
+        "EBeam",
+        "GCs_BB",
+        [
+            ((0.0, 0.0), 180, "TM_1550_500"),
+            ((-20.4, 0.0), (_vx8, 0, _vy8), _waist, 0),
+        ],
+        None,
+    ),
+    "ebeam_adiabatic_te1550": (
+        "EBeam",
+        "ebeam_adiabatic_te1550",
+        [
+            ((0.1, -1.5), 0, "TE_1550_500"),
+            ((0.1, 1.5), 0, "TE_1550_500"),
+            ((195.9, -1.5), 180, "TE_1550_500"),
+            ((195.9, 1.5), 180, "TE_1550_500"),
+        ],
+        {},
+    ),
+    "ebeam_adiabatic_tm1550": (
+        "EBeam",
+        "ebeam_adiabatic_tm1550",
+        [
+            ((0.1, -1.5), 0, "TM_1550_500"),
+            ((0.1, 1.5), 0, "TM_1550_500"),
+            ((217.9, -1.5), 180, "TM_1550_500"),
+            ((217.9, 1.5), 180, "TM_1550_500"),
+        ],
+        {},
+    ),
+    "ebeam_bdc_te1550": (
+        "EBeam",
+        "ebeam_bdc_te1550",
+        [
+            ((-35.45, -2.35), 0, "TE_1550_500"),
+            ((-35.45, 2.35), 0, "TE_1550_500"),
+            ((35.3, -2.35), 180, "TE_1550_500"),
+            ((35.3, 2.35), 180, "TE_1550_500"),
+        ],
+        {},
+    ),
+    "ebeam_crossing4": (
+        "EBeam",
+        "ebeam_crossing4",
+        [
+            ((-4.8, 0.0), 0, "TE_1550_500"),
+            ((4.8, 0.0), 180, "TE_1550_500"),
+            ((0.0, -4.8), 90, "TE_1550_500"),
+            ((0.0, 4.8), 270, "TE_1550_500"),
+        ],
+        {"port_symmetries": _symmetries_crossing},
+    ),
+    "ebeam_gc_te1550": (
+        "EBeam",
+        "ebeam_gc_te1550",
+        [
+            ((0.0, 0.0), 180, "TE_1550_500"),
+            ((-20.4, 0.0), (_te1550_vx, 0, _te1550_vy), _waist, 90),
+        ],
+        {"symmetry": (0, -1, 0), "bounds": ((-33, -11, None), (None, 11, None))},
+    ),
+    "ebeam_gc_tm1550": (
+        "EBeam",
+        "ebeam_gc_tm1550",
+        [
+            ((0.0, 0.0), 180, "TM_1550_500"),
+            ((-24.4, 0.0), (_tm1550_vx, 0, _tm1550_vy), _waist, 0),
+        ],
+        {"symmetry": (0, 1, 0), "bounds": ((None, -11, None), (None, 11, None))},
+    ),
+    "ebeam_splitter_swg_assist_te1310": (
+        "EBeam",
+        "ebeam_splitter_swg_assist_te1310",
+        [
+            ((-63.001, -2.0), 0, "TE_1310_350"),
+            ((-63.001, 2.0), 0, "TE_1310_350"),
+            ((63.001, -2.0), 180, "TE_1310_350"),
+            ((63.001, 2.0), 180, "TE_1310_350"),
+        ],
+        {},
+    ),
+    "ebeam_splitter_swg_assist_te1550": (
+        "EBeam",
+        "ebeam_splitter_swg_assist_te1550",
+        [
+            ((-63.001, -1.975), 0, "TE_1550_500"),
+            ((-63.001, 1.975), 0, "TE_1550_500"),
+            ((63.001, -1.975), 180, "TE_1550_500"),
+            ((63.001, 1.975), 180, "TE_1550_500"),
+        ],
+        {},
+    ),
+    "ebeam_terminator_te1310": (
+        "EBeam",
+        "ebeam_terminator_te1310",
+        [((0.0, 0.0), 180, "TE_1310_350")],
+        {},
+    ),
+    "ebeam_terminator_te1550": (
+        "EBeam",
+        "ebeam_terminator_te1550",
+        [((0.0, 0.0), 180, "TE_1550_500")],
+        {},
+    ),
+    "ebeam_terminator_tm1550": (
+        "EBeam",
+        "ebeam_terminator_tm1550",
+        [((0.0, 0.0), 180, "TM_1550_500")],
+        {},
+    ),
+    "ebeam_y_1550": (
+        "EBeam",
+        "ebeam_y_1550",
+        [
+            ((-7.4, 0.0), 0, "TE_1550_500"),
+            ((7.4, -2.75), 180, "TE_1550_500"),
+            ((7.4, 2.75), 180, "TE_1550_500"),
+        ],
+        {"port_symmetries": _symmetries_3port},
+    ),
+    "ebeam_y_adiabatic": (
+        "EBeam",
+        "ebeam_y_adiabatic",
+        [
+            ((0.05, 0.0), 0, "TE-TM_1550_450"),
+            ((50.05, -1.25), 180, "TE-TM_1550_450"),
+            ((50.05, 1.25), 180, "TE-TM_1550_450"),
+        ],
+        {"port_symmetries": _symmetries_3port},
+    ),
+    "ebeam_y_adiabatic_500pin": (
+        "EBeam",
+        "ebeam_y_adiabatic_500pin",
+        [
+            ((-1.0, 0.0), 0, "TE_1550_500"),
+            ((51.0, -1.25), 180, "TE_1550_500"),
+            ((51.0, 1.25), 180, "TE_1550_500"),
+        ],
+        {"port_symmetries": _symmetries_3port},
+    ),
+    "taper_si_simm_1310": (
+        "EBeam",
+        "taper_si_simm_1310",
+        # NOTE: no MM TM port at 1310 nm
+        [((50.0, 0.0), 180, "MM_TE_1550_3000"), ((0.0, 0.0), 0, "TE_1310_350")],
+        {},
+    ),
+    "taper_si_simm_1550": (
+        "EBeam",
+        "taper_si_simm_1550",
+        [((50.0, 0.0), 180, "MM_TE_1550_3000"), ((0.0, 0.0), 0, "TE_1550_500")],
+        {},
+    ),
+}
+
+component_names = set(_component_data.keys())
+
+
+def component(
+    cell_name: str, technology: pf.Technology = None, tidy3d_model_kwargs: dict = {}
+) -> 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``.
+    """
+    family, libname, port_data, kwargs = _component_data.get(cell_name, (None, None, None, None))
+    if family is None:
+        raise KeyError(f"{cell_name} is not a library component.")
+
+    if technology is None:
+        technology = pf.config.default_technology
+        if not technology.name.startswith("SiEPIC EBeam"):
+            warnings.warn(
+                f"Current default technology {technology.name} does not seem supported by the "
+                "SiEPIC EBeam UW component library",
+                RuntimeWarning,
+                1,
+            )
+
+    # Load library cell
+    gdsii = files("siepic_forge") / "library" / family / (libname + ".gds")
+    with as_file(gdsii) as fname:
+        c = pf.load_layout(fname, technology=technology)[cell_name]
+
+    # Add ports
+    z = technology.parametric_kwargs.get("top_oxide_thickness", -1.0)
+    if z > 0:
+        z += 0.1
+    else:
+        z = 1.0
+    for data in port_data:
+        if len(data) == 3:
+            port = pf.Port(data[0], data[1], technology.ports[data[2]])
+        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)
+        kwargs.update(tidy3d_model_kwargs)
+        c.add_model(pf.Tidy3DModel(**kwargs), "Tidy3D")
+
+    return c

siepic_forge-1.0.0/siepic_forge/technology.py

@@ -0,0 +1,291 @@
+import tidy3d as td
+import photonforge as pf
+
+
+_Medium = td.components.medium.MediumType
+
+
+@pf.parametric_technology
+def ebeam(
+    *,
+    si_thickness: float = 0.220,
+    si_slab_thickness: float = 0.090,
+    sin_thickness: float = 0.400,
+    si_mask_dilation: float = 0.0,
+    si_slab_mask_dilation: float = 0.0,
+    sin_mask_dilation: float = 0.0,
+    sidewall_angle: float = 0.0,
+    top_oxide_thickness: float = 2.0,
+    bottom_oxide_thickness: float = 3.017,
+    include_top_opening: bool = False,
+    include_substrate: bool = False,
+    sio2: _Medium = td.material_library["SiO2"]["Palik_Lossless"],
+    si: _Medium = td.material_library["cSi"]["Li1993_293K"],
+    sin: _Medium = td.material_library["Si3N4"]["Luke2015PMLStable"],
+    opening: _Medium = td.Medium(permittivity=1.0),
+) -> pf.Technology:
+    """Create a technology for the e-beam PDK.
+
+    The current version does not extrude heaters or metal layers, nor oxide
+    opening windows.
+
+    Args:
+        si_thickness (float): Full silicon layer thickness.
+        si_slab_thickness (float): Partially etched slab thickness in
+          silicon.
+        sin_thickness (float): SiN layer thinckness.
+        si_mask_dilation (float): Mask dilation for the full-thickness Si
+          layer.
+        si_slab_mask_dilation (float): Mask dilation for the partially
+          etched Si layer.
+        sin_mask_dilation (float): Mask dilation for the SiN layer.
+        sidewall_angle (float): Sidewall angle (in degrees) for Si and SiN
+          etching.
+        top_oxide_thickness (float): Thickness of the top oxide clad,
+          measured from the substrate.
+        bottom_oxide_thickness (float): Thickness of the bottom oxide clad.
+        include_top_opening (bool): Flag indicating wether or not to include
+          the region above the top oxide.
+        include_substrate (bool): Flag indicating wether or not to include
+          the silicon substrate.
+        sio2 (Medium): Background medium.
+        si (Medium): Silicon medium.
+        sin (Medium): Silicon nitride medium.
+        opening (Medium): Medium for openings.
+
+    Returns:
+        Technology: E-Beam PDK technology definition.
+    """
+
+    layers = {
+        "Waveguide": pf.LayerSpec((1, 99), "Waveguides", "#ff80a818", "\\"),
+        "Si": pf.LayerSpec((1, 0), "Waveguides", "#ff80a818", "\\\\"),
+        "SiN": pf.LayerSpec((1, 5), "Waveguides", "#a6cee318", "\\\\"),
+        "Si slab": pf.LayerSpec((2, 0), "Waveguides", "#80a8ff18", "/"),
+        "Si_Litho193nm": pf.LayerSpec((1, 69), "Waveguides", "#cc80a818", "\\"),
+        "Oxide open (to BOX)": pf.LayerSpec((6, 0), "Waveguides", "#ffae0018", "\\"),
+        "Text": pf.LayerSpec((10, 0), "", "#0000ff18", "\\"),
+        "Si N": pf.LayerSpec((20, 0), "Doping", "#7000FF18", "\\\\"),
+        "Si N++": pf.LayerSpec((24, 0), "Doping", "#0000ff18", ":"),
+        "M1_heater": pf.LayerSpec((11, 0), "Metal", "#ebc63418", "xx"),
+        "M2_router": pf.LayerSpec((12, 0), "Metal", "#3471eb18", "xx"),
+        "M_Open": pf.LayerSpec((13, 0), "Metal", "#00000018", "xx"),
+        "VC": pf.LayerSpec((40, 0), "Metal", "#3a027f18", "xx"),
+        "FloorPlan": pf.LayerSpec((99, 0), "Misc", "#8000ff18", "hollow"),
+        "Deep Trench": pf.LayerSpec((201, 0), "Misc", "#c0c0c018", "solid"),
+        "Dicing": pf.LayerSpec((210, 0), "Misc", "#a0a0c018", "solid"),
+        "Chip design area": pf.LayerSpec((290, 0), "Misc", "#80005718", "hollow"),
+        "Keep out": pf.LayerSpec((202, 0), "Misc", "#a0a0c018", "//"),
+        "SEM": pf.LayerSpec((200, 0), "Misc", "#ff00ff18", "\\"),
+        "DevRec": pf.LayerSpec((68, 0), "SiEPIC", "#00408018", "hollow"),
+        "PinRec": pf.LayerSpec((1, 10), "SiEPIC", "#00408018", "/"),
+        "PinRecM": pf.LayerSpec((1, 11), "SiEPIC", "#00408018", "/"),
+        "FbrTgt": pf.LayerSpec((81, 0), "SiEPIC", "#00408018", "/"),
+        "Errors": pf.LayerSpec((999, 0), "SiEPIC", "#00008018", "/"),
+        "FDTD": pf.LayerSpec((733, 0), "SiEPIC", "#80005718", "hollow"),
+        "BlackBox": pf.LayerSpec((998, 0), "SiEPIC", "#00408018", "solid"),
+    }
+
+    extrusion_specs = [
+        pf.ExtrusionSpec(
+            pf.MaskSpec((1, 0), dilation=si_mask_dilation),
+            si,
+            (0, si_thickness),
+            sidewall_angle,
+        ),
+        pf.ExtrusionSpec(
+            pf.MaskSpec((2, 0), dilation=si_slab_mask_dilation),
+            si,
+            (0, si_slab_thickness),
+            sidewall_angle,
+        ),
+        pf.ExtrusionSpec(
+            pf.MaskSpec((1, 5), dilation=sin_mask_dilation),
+            sin,
+            (0, sin_thickness),
+            sidewall_angle,
+        ),
+        pf.ExtrusionSpec(pf.MaskSpec((201, 0), (210, 0), "+"), opening, (-pf.Z_INF, pf.Z_INF)),
+    ]
+
+    if include_top_opening:
+        extrusion_specs.insert(
+            0, pf.ExtrusionSpec(pf.MaskSpec(), opening, (top_oxide_thickness, pf.Z_INF))
+        )
+
+    if include_substrate:
+        extrusion_specs.insert(
+            0, pf.ExtrusionSpec(pf.MaskSpec(), si, (-pf.Z_INF, -bottom_oxide_thickness))
+        )
+
+    ports = {
+        "TE_1550_500": pf.PortSpec(
+            description="Strip TE 1550 nm, w=500 nm",
+            width=2.0,
+            limits=(-1, 1 + si_thickness),
+            num_modes=1,
+            target_neff=3.5,
+            path_profiles=((0.5, 0.0, (1, 0)),),
+        ),
+        "TE_1310_410": pf.PortSpec(
+            description="Strip TE 1310 nm, w=410 nm",
+            width=2.0,
+            limits=(-1, 1 + si_thickness),
+            num_modes=1,
+            target_neff=3.5,
+            path_profiles=((0.41, 0.0, (1, 0)),),
+        ),
+        "TE_1310_350": pf.PortSpec(
+            description="Strip TE 1310 nm, w=350 nm",
+            width=2.0,
+            limits=(-1, 1 + si_thickness),
+            num_modes=1,
+            target_neff=3.5,
+            path_profiles=((0.35, 0.0, (1, 0)),),
+        ),
+        "TM_1550_500": pf.PortSpec(
+            description="Strip TM 1550 nm, w=500 nm",
+            width=2.5,
+            limits=(-1, 1 + si_thickness),
+            num_modes=2,
+            target_neff=3.5,
+            path_profiles=((0.5, 0.0, (1, 0)),),
+        ),
+        "TE-TM_1550_450": pf.PortSpec(
+            description="Strip TE-TM 1550, w=450 nm",
+            width=2.0,
+            limits=(-1, 1 + si_thickness),
+            num_modes=2,
+            target_neff=3.5,
+            path_profiles=((0.45, 0.0, (1, 0)),),
+        ),
+        "MM_TE_1550_2000": pf.PortSpec(
+            description="Multimode Strip TE 1550 nm, w=2000 nm",
+            width=6.0,
+            limits=(-2, 2 + si_thickness),
+            num_modes=10,
+            target_neff=3.5,
+            path_profiles=((2.0, 0.0, (1, 0)),),
+        ),
+        "MM_TE_1550_3000": pf.PortSpec(
+            description="Multimode Strip TE 1550 nm, w=3000 nm",
+            width=6.0,
+            limits=(-2, 2 + si_thickness),
+            num_modes=14,
+            target_neff=3.5,
+            path_profiles=((3.0, 0.0, (1, 0)),),
+        ),
+        "Slot_TE_1550_500": pf.PortSpec(
+            description="Slot TE 1550 nm, w=500 nm, gap=100nm",
+            width=2.0,
+            limits=(-1, 1 + si_thickness),
+            num_modes=1,
+            target_neff=3.5,
+            path_profiles=((0.2, -0.15, (1, 0)), (0.2, 0.15, (1, 0))),
+        ),
+        "eskid_TE_1550": pf.PortSpec(
+            description="eskid TE 1550",
+            width=3.31,
+            limits=(-1, 1 + si_thickness),
+            num_modes=1,
+            target_neff=3.5,
+            path_profiles=(
+                (0.35, 0.0, (1, 0)),
+                (0.06, 0.265, (1, 0)),
+                (0.06, -0.265, (1, 0)),
+                (0.06, 0.385, (1, 0)),
+                (0.06, -0.385, (1, 0)),
+                (0.06, 0.505, (1, 0)),
+                (0.06, -0.505, (1, 0)),
+                (0.06, 0.625, (1, 0)),
+                (0.06, -0.625, (1, 0)),
+            ),
+        ),
+        "Rib_TE_1550_500": pf.PortSpec(
+            description="Rib (90 nm slab) TE 1550 nm, w=500 nm",
+            width=2.5,
+            limits=(-1, 1 + si_thickness),
+            num_modes=1,
+            target_neff=3.5,
+            path_profiles=((0.5, 0.0, (1, 0)), (3.0, 0.0, (2, 0))),
+        ),
+        "Rib_TE_1310_350": pf.PortSpec(
+            description="Rib (90 nm slab) TE 1310 nm, w=350 nm",
+            width=2.35,
+            limits=(-1, 1 + si_thickness),
+            num_modes=1,
+            target_neff=3.5,
+            path_profiles=((0.35, 0.0, (1, 0)), (3.0, 0.0, (2, 0))),
+        ),
+        "SiN_TE_895_450": pf.PortSpec(
+            description="SiN Strip TE 895 nm, w=450 nm",
+            width=4.0,
+            limits=(-2.0, 2.0 + sin_thickness),
+            num_modes=2,
+            target_neff=2.1,
+            path_profiles=((0.45, 0.0, (1, 5)),),
+        ),
+        "SiN_TE_1550_750": pf.PortSpec(
+            description="SiN Strip TE 1550 nm, w=750 nm",
+            width=3.0,
+            limits=(-1, 1 + sin_thickness),
+            num_modes=1,
+            target_neff=2.1,
+            path_profiles=((0.75, 0.0, (1, 5)),),
+        ),
+        "SiN_TE_1550_800": pf.PortSpec(
+            description="SiN Strip TE 1550 nm, w=800 nm",
+            width=3.0,
+            limits=(-1, 1 + sin_thickness),
+            num_modes=1,
+            target_neff=2.1,
+            path_profiles=((0.8, 0.0, (1, 5)),),
+        ),
+        "SiN_TE_1550_1000": pf.PortSpec(
+            description="SiN Strip TE 1550 nm, w=1000 nm",
+            width=3.0,
+            limits=(-1, 1 + sin_thickness),
+            num_modes=1,
+            target_neff=2.1,
+            path_profiles=((1.0, 0.0, (1, 5)),),
+        ),
+        "SiN_TM_1550_1000": pf.PortSpec(
+            description="SiN Strip TM 1550 nm, w=1000 nm",
+            width=3.0,
+            limits=(-1.5, 1.5 + sin_thickness),
+            num_modes=2,
+            target_neff=2.1,
+            path_profiles=((1.0, 0.0, (1, 5)),),
+        ),
+        "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,
+            target_neff=2.1,
+            path_profiles=((0.75, 0.0, (1, 5)),),
+        ),
+        "SiN_TM_1310_750": pf.PortSpec(
+            description="SiN Strip TM 1310 nm, w=750 nm",
+            width=3.0,
+            limits=(-1.5, 1.5 + sin_thickness),
+            num_modes=2,
+            target_neff=2.1,
+            path_profiles=((0.75, 0.0, (1, 5)),),
+        ),
+        "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=6,
+            target_neff=2.1,
+            path_profiles=((3.0, 0.0, (1, 5)),),
+        ),
+    }
+
+    result = pf.Technology("SiEPIC EBeam", "0.4.11", layers, extrusion_specs, ports, sio2)
+    result.random_variables = [
+        pf.monte_carlo.RandomVariable("si_thickness", value=0.22, stdev=0.0223 / 6),
+        pf.monte_carlo.RandomVariable("bottom_oxide_thickness", value=3.017, stdev=0.006 / 6),
+    ]
+    return result

siepic_forge-1.0.0/siepic_forge.egg-info/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: siepic-forge
+Version: 1.0.0
+Summary: SiEPIC 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.0.0rc1
+Provides-Extra: test
+Requires-Dist: pytest>=7.2; extra == "test"
+
+# SiEPIC Forge
+
+This python module implements the [SiEPIC EBeam
+PDK](https://github.com/SiEPIC/SiEPIC_EBeam_PDK) PDK as components and
+technology specification for
+[PhotonForge](https://docs.flexcompute.com/projects/photonforge/)
+
+
+## Installation
+
+### Python interface
+
+Installation via `pip`:
+
+    pip install siepic-forge
+
+
+### PhotonForge Web UI
+
+In the Tidy3D web interface, go to your [*Account
+Center*](https://tidy3d.simulation.cloud/account) and upload the token file
+(.tok) under *PhotonForge Libraries* to enable this module.
+
+
+## Usage
+
+The simplest way to use the this PDK in PhotonForge is to set its technology as
+default:
+
+    import photonforge as pf
+    import siepic_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_y_1550")
+
+
+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.
+
+
+## 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_forge-1.0.0/siepic_forge.egg-info/SOURCES.txt

@@ -0,0 +1,42 @@
+CHANGELOG.md
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+siepic_forge/__init__.py
+siepic_forge/component.py
+siepic_forge/technology.py
+siepic_forge.egg-info/PKG-INFO
+siepic_forge.egg-info/SOURCES.txt
+siepic_forge.egg-info/dependency_links.txt
+siepic_forge.egg-info/requires.txt
+siepic_forge.egg-info/top_level.txt
+siepic_forge/library/EBeam/GCs_BB.gds
+siepic_forge/library/EBeam/ebeam_adiabatic_te1550.gds
+siepic_forge/library/EBeam/ebeam_adiabatic_tm1550.gds
+siepic_forge/library/EBeam/ebeam_bdc_te1550.gds
+siepic_forge/library/EBeam/ebeam_crossing4.gds
+siepic_forge/library/EBeam/ebeam_gc_te1550.gds
+siepic_forge/library/EBeam/ebeam_gc_tm1550.gds
+siepic_forge/library/EBeam/ebeam_splitter_swg_assist_te1310.gds
+siepic_forge/library/EBeam/ebeam_splitter_swg_assist_te1550.gds
+siepic_forge/library/EBeam/ebeam_terminator_te1310.gds
+siepic_forge/library/EBeam/ebeam_terminator_te1550.gds
+siepic_forge/library/EBeam/ebeam_terminator_tm1550.gds
+siepic_forge/library/EBeam/ebeam_y_1550.gds
+siepic_forge/library/EBeam/ebeam_y_adiabatic.gds
+siepic_forge/library/EBeam/ebeam_y_adiabatic_500pin.gds
+siepic_forge/library/EBeam/taper_si_simm_1310.gds
+siepic_forge/library/EBeam/taper_si_simm_1550.gds
+siepic_forge/library/EBeam_SiN/ANT_MMI_1x2_te1550_3dB_BB.gds
+siepic_forge/library/EBeam_SiN/GC_SiN_TE_1550_8degOxide_BB.gds
+siepic_forge/library/EBeam_SiN/ULaval.gds
+siepic_forge/library/EBeam_SiN/ebeam_BondPad.gds
+siepic_forge/library/EBeam_SiN/ebeam_DC_2-1_te895.gds
+siepic_forge/library/EBeam_SiN/ebeam_DC_te895.gds
+siepic_forge/library/EBeam_SiN/ebeam_Polarizer_TM_1550_UQAM.gds
+siepic_forge/library/EBeam_SiN/ebeam_YBranch_895.gds
+siepic_forge/library/EBeam_SiN/ebeam_gc_te895.gds
+siepic_forge/library/EBeam_SiN/ebeam_terminator_SiN_1550.gds
+siepic_forge/library/EBeam_SiN/ebeam_terminator_SiN_te895.gds
+siepic_forge/library/EBeam_SiN/taper_SiN_750_3000.gds

siepic_forge-1.0.0/siepic_forge.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

siepic_forge-1.0.0/siepic_forge.egg-info/requires.txt

@@ -0,0 +1,4 @@
+photonforge~=1.0.0rc1
+
+[test]
+pytest>=7.2

siepic_forge-1.0.0/siepic_forge.egg-info/top_level.txt

@@ -0,0 +1 @@
+siepic_forge