photonforge 1.3.1__cp310-cp310-win_amd64.whl → 1.3.2__cp310-cp310-win_amd64.whl

photonforge/parametric.py

@@ -10,9 +10,10 @@ import photonforge as _pf
 
 from . import extension as _ext
 from . import typing as _pft
-from .analytic_models import WaveguideModel as _WaveguideModel
-from .circuit_model import CircuitModel as _CircuitModel
-from .tidy3d_model import Tidy3DModel as _Tidy3DModel
+from .models.analytic import WaveguideModel as _WaveguideModel
+from .models.circuit import CircuitModel as _CircuitModel
+from .models.circuit import DirectionalCouplerCircuitModel as _DirectionalCouplerCircuitModel
+from .models.tidy3d import Tidy3DModel as _Tidy3DModel
 
 _OptDimension = _pft.annotate(_pft.Dimension, optional=True)
 _OptPositiveDimension = _pft.annotate(_pft.PositiveDimension, optional=True)
@@ -895,7 +896,7 @@ def ring_coupler(
           technology is used.
         name: Component name.
         model: Model to be used with this component. If ``None`` a
-          :class:`photonforge.Tidy3DModel` is used.
+          :class:`photonforge.DirectionalCouplerCircuitModel` is used.
         tidy3d_model_kwargs: *(DEPRECATED)* Dictionary of keyword arguments
           passed to the component's :class:`photonforge.Tidy3DModel`.
 
@@ -931,7 +932,7 @@ def ring_coupler(
     coupling_length = _get_default(function, "coupling_length", coupling_length, 0)
     port_bends = _get_default(function, "port_bends", port_bends, False)
     name = _get_default(function, "name", name, "")
-    model = _get_default(function, "model", model, _Tidy3DModel())
+    model = _get_default(function, "model", model, "default")
 
     if tidy3d_model_kwargs is not None:
         _warn.warn(
@@ -944,7 +945,6 @@ def ring_coupler(
 
     c = _pf.Component(name, technology=technology)
     c.properties.__thumbnail__ = "dc"
-    c.add_model(model)
 
     xp = bus_length + 0.5 * coupling_length
     yp = -radius - coupling_distance
@@ -960,15 +960,29 @@ def ring_coupler(
         c.add(layer, path)
 
     if xp > 0:
-        c.add_port(_pf.Port((-xp, yp), 0, port_spec[0]))
-    p0 = c.add_port(_pf.Port((-xr, 0), -90, port_spec[1], inverted=True))
+        p0 = c.add_port(_pf.Port((-xp, yp), 0, port_spec[0]))
+    p1 = c.add_port(_pf.Port((-xr, 0), -90, port_spec[1], inverted=True))
     if xp > 0:
-        c.add_port(_pf.Port((xp, yp), 180, port_spec[0], inverted=True))
-    p1 = c.add_port(_pf.Port((xr, 0), -90, port_spec[1]))
+        p2 = c.add_port(_pf.Port((xp, yp), 180, port_spec[0], inverted=True))
+    p3 = c.add_port(_pf.Port((xr, 0), -90, port_spec[1]))
 
     if port_bends and euler_fraction == 0:
-        c[p0].bend_radius = radius
-        c[p1].bend_radius = -radius
+        c[p1].bend_radius = radius
+        c[p3].bend_radius = -radius
+
+    if model == "default":
+        if xp > 0:
+            model = _DirectionalCouplerCircuitModel(
+                arms_model={
+                    p0: _WaveguideModel(),
+                    p1: _Tidy3DModel(),
+                    p2: _WaveguideModel(),
+                    p3: _Tidy3DModel(),
+                }
+            )
+        else:
+            model = _Tidy3DModel()
+    c.add_model(model)
 
     return c
 
@@ -1012,7 +1026,7 @@ def s_bend_ring_coupler(
           technology is used.
         name: Component name.
         model: Model to be used with this component. If ``None`` a
-          :class:`photonforge.Tidy3DModel` is used.
+          :class:`photonforge.DirectionalCouplerCircuitModel` is used.
         tidy3d_model_kwargs: *(DEPRECATED)* Dictionary of keyword arguments
           passed to the component's :class:`photonforge.Tidy3DModel`.
 
@@ -1055,7 +1069,7 @@ def s_bend_ring_coupler(
     coupling_length = _get_default(function, "coupling_length", coupling_length, 0)
     port_bends = _get_default(function, "port_bends", port_bends, False)
     name = _get_default(function, "name", name, "")
-    model = _get_default(function, "model", model, _Tidy3DModel())
+    model = _get_default(function, "model", model, "default")
 
     if tidy3d_model_kwargs is not None:
         _warn.warn(
@@ -1068,7 +1082,6 @@ def s_bend_ring_coupler(
 
     c = _pf.Component(name, technology=technology)
     c.properties.__thumbnail__ = "dc"
-    c.add_model(model)
 
     xs = s_bend_length + 0.5 * coupling_length
     ys = -radius - coupling_distance - s_bend_offset
@@ -1088,14 +1101,25 @@ def s_bend_ring_coupler(
         path.arc(-90, -180, radius, endpoint=(-xr, 0), euler_fraction=euler_fraction)
         c.add(layer, path)
 
-    c.add_port(_pf.Port((-xs, ys), 0, port_spec[0]))
-    p0 = c.add_port(_pf.Port((-xr, 0), -90, port_spec[1], inverted=True))
-    c.add_port(_pf.Port((xs, ys), 180, port_spec[0], inverted=True))
-    p1 = c.add_port(_pf.Port((xr, 0), -90, port_spec[1]))
+    p0 = c.add_port(_pf.Port((-xs, ys), 0, port_spec[0]))
+    p1 = c.add_port(_pf.Port((-xr, 0), -90, port_spec[1], inverted=True))
+    p2 = c.add_port(_pf.Port((xs, ys), 180, port_spec[0], inverted=True))
+    p3 = c.add_port(_pf.Port((xr, 0), -90, port_spec[1]))
 
     if port_bends and euler_fraction == 0:
-        c[p0].bend_radius = radius
-        c[p1].bend_radius = -radius
+        c[p1].bend_radius = radius
+        c[p3].bend_radius = -radius
+
+    if model == "default":
+        model = _DirectionalCouplerCircuitModel(
+            arms_model={
+                p0: _WaveguideModel(),
+                p1: _Tidy3DModel(),
+                p2: _WaveguideModel(),
+                p3: _Tidy3DModel(),
+            }
+        )
+    c.add_model(model)
 
     return c
 
@@ -1135,7 +1159,7 @@ def dual_ring_coupler(
           technology is used.
         name: Component name.
         model: Model to be used with this component. If ``None`` a
-          :class:`photonforge.Tidy3DModel` is used.
+          :class:`photonforge.DirectionalCouplerCircuitModel` is used.
         tidy3d_model_kwargs: *(DEPRECATED)* Dictionary of keyword arguments
           passed to the component's :class:`photonforge.Tidy3DModel`.
 
@@ -1175,7 +1199,7 @@ def dual_ring_coupler(
     coupling_length = _get_default(function, "coupling_length", coupling_length, 0)
     port_bends = _get_default(function, "port_bends", port_bends, False)
     name = _get_default(function, "name", name, "")
-    model = _get_default(function, "model", model, _Tidy3DModel())
+    model = _get_default(function, "model", model, _DirectionalCouplerCircuitModel())
 
     if tidy3d_model_kwargs is not None:
         _warn.warn(
@@ -1255,7 +1279,7 @@ def s_bend_coupler(
           technology is used.
         name: Component name.
         model: Model to be used with this component. If ``None`` a
-          :class:`photonforge.Tidy3DModel` is used.
+          :class:`photonforge.DirectionalCouplerCircuitModel` is used.
         tidy3d_model_kwargs: *(DEPRECATED)* Dictionary of keyword arguments
           passed to the component's :class:`photonforge.Tidy3DModel`.
 
@@ -1297,7 +1321,9 @@ def s_bend_coupler(
     euler_fraction = _get_default(function, "euler_fraction", euler_fraction, 0)
     coupling_length = _get_default(function, "coupling_length", coupling_length, 0)
     name = _get_default(function, "name", name, "")
-    model = _get_default(function, "model", model, _Tidy3DModel())
+    model = _get_default(
+        function, "model", model, _DirectionalCouplerCircuitModel(arms_model=_WaveguideModel())
+    )
 
     if tidy3d_model_kwargs is not None:
         _warn.warn(
@@ -1373,7 +1399,7 @@ def s_bend_straight_coupler(
           technology is used.
         name: Component name.
         model: Model to be used with this component. If ``None`` a
-          :class:`photonforge.Tidy3DModel` is used.
+          :class:`photonforge.DirectionalCouplerCircuitModel` is used.
         tidy3d_model_kwargs: *(DEPRECATED)* Dictionary of keyword arguments
           passed to the component's :class:`photonforge.Tidy3DModel`.
 
@@ -1409,7 +1435,9 @@ def s_bend_straight_coupler(
     euler_fraction = _get_default(function, "euler_fraction", euler_fraction, 0)
     coupling_length = _get_default(function, "coupling_length", coupling_length, 0)
     name = _get_default(function, "name", name, "")
-    model = _get_default(function, "model", model, _Tidy3DModel())
+    model = _get_default(
+        function, "model", model, _DirectionalCouplerCircuitModel(arms_model=_WaveguideModel())
+    )
 
     if tidy3d_model_kwargs is not None:
         _warn.warn(
@@ -2307,6 +2335,10 @@ def route_taper(
     size1 = max1 - min1
     size2 = max2 - min2
 
+    ortho_1d = ((size1[0] < _pf.config.grid) and (size2[1] < _pf.config.grid)) or (
+        (size1[1] < _pf.config.grid) and (size2[0] < _pf.config.grid)
+    )
+
     prefer_x = (size1[0] < _pf.config.grid) or (size2[0] < _pf.config.grid)
     prefer_y = (size1[1] < _pf.config.grid) or (size2[1] < _pf.config.grid)
 
@@ -2318,7 +2350,7 @@ def route_taper(
     overlap_x = not (max1[0] < min2[0] or max2[0] < min1[0])
     overlap_y = not (max1[1] < min2[1] or max2[1] < min1[1])
 
-    if (overlap_x and overlap_y) or not use_box:
+    if ortho_1d or (overlap_x and overlap_y) or not use_box:
         taper = _pf.envelope([structure1, structure2])
     elif overlap_y or (not overlap_x and prefer_x):
         if max2[0] < min1[0]:

photonforge/plotting.py

@@ -15,7 +15,7 @@ from .extension import (
     config,
     frequency_classification,
 )
-from .tidy3d_model import Tidy3DModel
+from .models.tidy3d import Tidy3DModel
 from .utils import C_0
 
 

photonforge/pretty.py

@@ -2,7 +2,7 @@ import html
 from collections.abc import Sequence
 
 from .extension import Z_MAX, Component, ExtrusionSpec, LayerSpec, PortSpec, Technology
-from .tidy3d_model import _tidy3d_to_str
+from .models.tidy3d import _tidy3d_to_str
 
 
 class _Tree:

photonforge/thumbnails/electrical_absolute.svg

@@ -0,0 +1,8 @@
+<svg fill="none" width="51" height="51" viewBox="0 0 51 51" xmlns="http://www.w3.org/2000/svg">
+<path d="M.93 1.39h49v49h-49z" fill="#fff" stroke="#000"/>
+<path d="M13.98 25.37H1m49.43.08h-9.41" stroke="#000"/>
+<path d="m13.99 9.09 28.32 16.35L14 41.8z" fill="#C43C5B" stroke="#000" stroke-linecap="square" stroke-width=".99"/>
+<path d="m18.359 30.095v-9.3" stroke="#000"/>
+<path d="m26.94 30.095v-9.3" stroke="#000"/>
+<circle cx="22.649" cy="25.5" r="1.3421" fill="#000"/>
+</svg>

photonforge/thumbnails/electrical_adder.svg

@@ -0,0 +1,9 @@
+<svg fill="none" width="51" height="51" viewBox="0 0 51 51" xmlns="http://www.w3.org/2000/svg">
+<path d="M.93 1.39h49v49h-49z" fill="#fff" stroke="#000"/>
+<path d="m50.43 25.45h-9.41" stroke="#000"/>
+<path d="m13.99 9.09 28.32 16.35L14 41.8z" fill="#C43C5B" stroke="#000" stroke-linecap="square" stroke-width=".99"/>
+<path d="M 13.98,17.37 H 1" stroke="#000"/>
+<path d="M 13.98,33.37 H 1" stroke="#000"/>
+<path d="m27.841 25.445h-8.2276" stroke="#000"/>
+<path d="m23.727 29.559v-8.2276" stroke="#000"/>
+</svg>

photonforge/thumbnails/electrical_amplifier.svg

@@ -0,0 +1,5 @@
+<svg width="51" height="51" viewBox="0 0 51 51" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill="#fff" stroke="#000" d="M.93 1.39h49v49h-49z"/>
+<path d="M13.98 25.37H1m49.43.08h-9.41" stroke="#000"/>
+<path d="m13.99 9.09 28.32 16.35L14 41.8z" fill="#C43C5B" stroke-width=".99" stroke-linecap="square" stroke="#000"/>
+</svg>

photonforge/thumbnails/electrical_differential.svg

@@ -0,0 +1,6 @@
+<svg fill="none" width="51" height="51" viewBox="0 0 51 51" xmlns="http://www.w3.org/2000/svg">
+<path d="M.93 1.39h49v49h-49z" fill="#fff" stroke="#000"/>
+<path d="M13.98 25.37H1m49.43.08h-9.41" stroke="#000"/>
+<path d="m13.99 9.09 28.32 16.35L14 41.8z" fill="#C43C5B" stroke="#000" stroke-linecap="square" stroke-width=".99"/>
+<path d="m18.932 21.549q0.24088-0.16927 0.47526-0.29948 0.23437-0.13021 0.48177-0.21484 0.2474-0.09115 0.52083-0.13672 0.27344-0.04557 0.59245-0.04557 0.5664 0 1.0286 0.23437 0.46875 0.23438 0.80078 0.67708 0.33203 0.4362 0.50781 1.0742 0.18229 0.63151 0.18229 1.4323 0 1.2695-0.23438 2.3307-0.22786 1.0612-0.6901 1.8294-0.46224 0.76172-1.1589 1.1849-0.69661 0.42318-1.6276 0.42318-0.54687 0-1.0026-0.17578-0.45573-0.18229-0.78776-0.52083-0.32552-0.33854-0.50781-0.8138-0.18229-0.47526-0.18229-1.0742 0-0.72916 0.24088-1.3607t0.67057-1.1003q0.42969-0.46875 1.0156-0.73568 0.59245-0.26693 1.2956-0.26693 0.65104 0 1.1263 0.27344 0.48177 0.27344 0.78776 0.80078 0.01302-0.22135 0.01302-0.42318 0.0065-0.20833 0.0065-0.37109 0-1.237-0.4362-1.8685-0.42969-0.63151-1.1979-0.63151-0.26693 0-0.48828 0.0651-0.22135 0.05859-0.40364 0.13672-0.17578 0.07813-0.30599 0.14323-0.13021 0.05859-0.21484 0.05859-0.07162 0-0.13021-0.03906-0.05859-0.03906-0.13021-0.14974zm1.0156 7.5911q0.41016 0 0.77474-0.16927 0.37109-0.16927 0.67057-0.51432 0.30599-0.35156 0.52734-0.8789 0.22135-0.53385 0.34505-1.2565-0.0651-0.27344-0.1888-0.53385-0.11719-0.26042-0.30599-0.45573-0.1888-0.20182-0.46224-0.31901-0.26693-0.1237-0.63151-0.1237-0.52734 0-0.93099 0.19531-0.40364 0.1888-0.68359 0.53385-0.27344 0.33854-0.41667 0.80729-0.13672 0.46224-0.13672 1.0091 0 0.8138 0.38411 1.263 0.39062 0.44271 1.0547 0.44271zm7.4327-0.01286q0.26667 0 0.54666-0.04 0.28-0.05333 0.45333-0.10667v0.89333q-0.18667 0.09333-0.53333 0.14667-0.34667 0.06667-0.66666 0.06667-0.56 0-1.04-0.18667-0.46667-0.2-0.76-0.68-0.29333-0.48-0.29333-1.3467v-4.16h-1.0133v-0.56l1.0267-0.46667 0.46667-1.52h0.69333v1.64h2.0667v0.90666h-2.0667v4.1333q0 0.65333 0.30667 0.97333 0.32 0.30667 0.81333 0.30667z" fill="#000"/>
+</svg>

photonforge/thumbnails/electrical_integral.svg

@@ -0,0 +1,8 @@
+<svg fill="none" width="51" height="51" viewBox="0 0 51 51" xmlns="http://www.w3.org/2000/svg">
+<path d="M.93 1.39h49v49h-49z" fill="#fff" stroke="#000"/>
+<path d="M13.98 25.37H1m49.43.08h-9.41" stroke="#000"/>
+<path d="m13.99 9.09 28.32 16.35L14 41.8z" fill="#C43C5B" stroke="#000" stroke-linecap="square" stroke-width=".99"/>
+<path d="m25.43 15.695v-14.723" stroke="#000"/>
+<path d="m21.336 21.656q0.07813-0.63802 0.27344-1.0937 0.20182-0.46224 0.5013-0.75521 0.30599-0.29948 0.69661-0.4362 0.39062-0.14323 0.85286-0.14323 0.20833 0 0.4362 0.03906 0.23438 0.03906 0.42318 0.14323l-0.07161 0.48177q-0.01302 0.07161-0.03906 0.11719-0.02604 0.03906-0.08464 0.05859-0.05859 0.01953-0.15625 0.02604-0.09766 0.0065-0.2474 0.0065-0.35156 0-0.61198 0.08463t-0.44271 0.26693q-0.18229 0.18229-0.28646 0.47526-0.10417 0.28646-0.14974 0.69661l-0.80078 7.6041q-0.0651 0.63802-0.26042 1.1003-0.19531 0.46224-0.5013 0.75521-0.29948 0.29948-0.69661 0.4362-0.39062 0.14323-0.85286 0.14323-0.20833 0-0.4362-0.03906-0.23437-0.03906-0.42318-0.14323l0.07161-0.48177q0.01302-0.07161 0.03906-0.11719 0.02604-0.03906 0.08463-0.05859t0.15625-0.02604q0.09766-0.0065 0.2539-0.0065 0.35156 0 0.60547-0.08463 0.26042-0.08464 0.4362-0.26693 0.18229-0.18229 0.28646-0.47526t0.14974-0.70312z" fill="#000"/>
+</svg>
+

photonforge/thumbnails/electrical_multiplier.svg

@@ -0,0 +1,9 @@
+<svg fill="none" width="51" height="51" viewBox="0 0 51 51" xmlns="http://www.w3.org/2000/svg">
+<path d="M.93 1.39h49v49h-49z" fill="#fff" stroke="#000"/>
+<path d="m50.43 25.45h-9.41" stroke="#000"/>
+<path d="m13.99 9.09 28.32 16.35L14 41.8z" fill="#C43C5B" stroke="#000" stroke-linecap="square" stroke-width=".99"/>
+<path d="M 13.98,17.37 H 1" stroke="#000"/>
+<path d="M 13.98,33.37 H 1" stroke="#000"/>
+<path d="m26.636 28.354-5.8178-5.8178" stroke="#000"/>
+<path d="m20.818 28.354 5.8178-5.8178" stroke="#000"/>
+</svg>

photonforge/thumbnails/filter.svg

@@ -0,0 +1,8 @@
+<svg width="50" height="50" viewBox="0 0 50 50" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill="#fff" stroke="#000" d="M.5.5h49v49H.5z"/>
+<path stroke="#f3c90c" stroke-width="1.63" d="M29.27 32h15.02"/>
+<path stroke="#f3c90c" stroke-width="1.98" d="m23.47 15.42 6.69 17.06"/>
+<path stroke="#000" stroke-width="2" d="M7.89 8.4v35.01m-4.5-4.36h38.94"/>
+<path stroke="#f3c90c" stroke-width="2" d="M7.12 16.05H24.4"/>
+<path d="M10.37 8.4H5.4l2.49-4.3zm31.96 33.13v-4.97l4.3 2.49z" fill="#000"/>
+</svg>

photonforge/thumbnails/optical_amplifier.svg

@@ -0,0 +1,5 @@
+<svg width="51" height="51" viewBox="0 0 51 51" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill="#fff" stroke="#000" d="M.93 1.39h49v49h-49z"/>
+<path d="M13.98 25.37H1m49.43.08h-9.41" stroke="#000"/>
+<path d="m13.99 9.09 28.32 16.35L14 41.8z" fill="#2faa96" stroke-width=".99" stroke-linecap="square" stroke="#000"/>
+</svg>

photonforge/thumbnails.py

@@ -1,14 +1,9 @@
 from collections import defaultdict
 
 try:
-    from importlib.resources import files
+    from importlib.resources import as_file, files
 except ImportError:
-    from importlib_resources import files
-
-
-def _load(name):
-    global thumbnails, _thumb_dir
-    thumbnails[name.encode("utf-8")] = _thumb_dir.joinpath(name + ".svg").read_text()
+    from importlib_resources import as_file, files
 
 
 _thumb_dir = files("photonforge").joinpath("thumbnails")
@@ -17,34 +12,11 @@ _default = _thumb_dir.joinpath("black_box.svg").read_text()
 
 thumbnails = defaultdict(lambda: _default)
 
-_load("bend")
-_load("black_box")
-_load("bondpad")
-_load("connection")
-_load("crossing")
-_load("cw_laser")
-_load("dc")
-_load("dual_mrr")
-_load("edge_coupler")
-_load("electrical_termination")
-_load("eo_ps")
-_load("grating_coupler")
-_load("laser")
-_load("mmi1x2")
-_load("mmi2x2")
-_load("mrm")
-_load("mrr")
-_load("mzm")
-_load("photodiode")
-_load("psgc")
-_load("psr")
-_load("s-bend")
-_load("source")
-_load("taper")
-_load("termination")
-_load("to_ps")
-_load("transition")
-_load("u-bend")
-_load("wdm")
-_load("wg")
-_load("y-splitter")
+for item in _thumb_dir.iterdir():
+    if not item.is_file():
+        continue
+    with as_file(item) as f:
+        if f.suffix != ".svg":
+            continue
+        name = f.stem.encode("utf-8")
+    thumbnails[name] = item.read_text()