gsim 0.2.0__tar.gz → 0.3.0__tar.gz

{gsim-0.2.0/src/gsim.egg-info → gsim-0.3.0}/PKG-INFO

@@ -1,6 +1,7 @@
 Metadata-Version: 2.4
 Name: gsim
-Version: 0.2.0
+Version: 0.3.0
+Summary: Electromagnetic simulation for photonics and electronics, powered by GDSFactory.
 Author-email: GDSFactory <contact@gdsfactory.com>
 License: Apache-2.0
 Classifier: License :: OSI Approved :: Apache Software License
@@ -15,6 +16,7 @@ Requires-Dist: gmsh
 Requires-Dist: meshio>=5.0.0
 Requires-Dist: nbformat>=4.2.0
 Requires-Dist: nest_asyncio2
+Requires-Dist: pdk-schema==0.0.2
 Requires-Dist: plotly
 Requires-Dist: pyvista>=0.43.0
 Requires-Dist: trame
@@ -22,7 +24,7 @@ Requires-Dist: trame-vtk
 Requires-Dist: trame-vuetify
 Dynamic: license-file
 
-# gsim 0.2.0
+# gsim 0.3.0
 
 > Electromagnetic simulation for photonics and electronics, powered by [GDSFactory+](https://gdsfactory.com)
 

{gsim-0.2.0 → gsim-0.3.0}/README.md

@@ -1,4 +1,4 @@
-# gsim 0.2.0
+# gsim 0.3.0
 
 > Electromagnetic simulation for photonics and electronics, powered by [GDSFactory+](https://gdsfactory.com)
 

{gsim-0.2.0 → gsim-0.3.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "gsim"
-version = "0.2.0"
-description = ""
+version = "0.3.0"
+description = "Electromagnetic simulation for photonics and electronics, powered by GDSFactory."
 readme = "README.md"
 requires-python = "~=3.12.0"
 license = { text = "Apache-2.0" }
@@ -18,6 +18,7 @@ dependencies = [
   "meshio>=5.0.0",
   "nbformat>=4.2.0",
   "nest_asyncio2",
+  "pdk-schema==0.0.2",
   "plotly",
   "pyvista>=0.43.0",
   "trame",
@@ -69,18 +70,6 @@ test = [
 requires = ["build", "setuptools>=61", "uv", "wheel"]
 build-backend = "setuptools.build_meta"
 
-[[tool.bver.file]]
-src = "README.md"
-
-[[tool.bver.file]]
-src = "pyproject.toml"
-
-[[tool.bver.file]]
-src = "src/gsim/__init__.py"
-
-[tool.bver.git]
-commit-template = "Release {new-version}"
-
 [tool.codespell]
 ignore-words-list = "doubleclick,euclidian,te"
 

{gsim-0.2.0 → gsim-0.3.0}/src/gsim/__init__.py

@@ -12,7 +12,7 @@ from __future__ import annotations
 
 from gsim.gcloud import get_status, wait_for_results
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 
 __all__ = [
     "__version__",

gsim-0.3.0/src/gsim/common/materials.py

@@ -0,0 +1,191 @@
+"""Built-in optical material cards."""
+
+from collections.abc import Mapping
+
+import gdsfactory as gf
+from pdk_schema import (
+    Band,
+    Coord,
+    Index,
+    MaterialCard,
+    Provenance,
+    Regime,
+    Sellmeier,
+    SellmeierTerm,
+    TableData,
+    TabulatedValue,
+    Validity,
+)
+
+_LI_293K_DATA = (
+    (1.20, 3.5167),
+    (1.22, 3.5133),
+    (1.24, 3.5102),
+    (1.26, 3.5072),
+    (1.28, 3.5043),
+    (1.30, 3.5016),
+    (1.32, 3.4990),
+    (1.34, 3.4965),
+    (1.36, 3.4941),
+    (1.38, 3.4918),
+    (1.40, 3.4896),
+    (1.45, 3.4845),
+    (1.50, 3.4799),
+    (1.55, 3.4757),
+    (1.60, 3.4719),
+    (1.65, 3.4684),
+    (1.70, 3.4653),
+    (1.80, 3.4597),
+    (1.90, 3.4550),
+    (2.00, 3.4510),
+    (2.25, 3.4431),
+    (2.50, 3.4375),
+    (2.75, 3.4334),
+    (3.00, 3.4302),
+    (4.00, 3.4229),
+    (5.00, 3.4195),
+    (6.00, 3.4177),
+    (7.00, 3.4165),
+    (8.00, 3.4158),
+    (9.00, 3.4153),
+    (10.0, 3.4150),
+    (11.0, 3.4147),
+    (12.0, 3.4145),
+    (13.0, 3.4144),
+    (14.0, 3.4142),
+)
+
+
+def _validity(minimum_um: float, maximum_um: float) -> Validity:
+    """Return a strict wavelength validity range in micrometers."""
+    return Validity(
+        at=None,
+        over={
+            "wavelength": Band(
+                min=minimum_um,
+                max=maximum_um,
+                unit="um",
+                label=None,
+            )
+        },
+        on_out_of_range="raise",
+    )
+
+
+def _provenance(label: str) -> Provenance:
+    """Return the minimum required literature provenance."""
+    return Provenance(
+        source="literature",
+        label=label,
+        maturity="empirical",
+        citations=[],
+        comment=None,
+        url=None,
+        data_url=None,
+        info={},
+    )
+
+
+def _card(
+    name: str,
+    permittivity: Index | Sellmeier,
+    temperature_ref: float,
+) -> MaterialCard:
+    """Build an optical material card."""
+    return MaterialCard(
+        name=name,
+        optical=Regime(
+            temperature_ref=temperature_ref,
+            provenance=_provenance(name),
+            permittivity=permittivity,
+            conductivity=None,
+            permeability=None,
+            perturbations=[],
+            info={},
+        ),
+        rf=None,
+        info={},
+    )
+
+
+_SI_SALZBERG = _card(
+    name="Si-Salzberg",
+    temperature_ref=299.15,
+    permittivity=Sellmeier(
+        validity=_validity(1.357, 11.04),
+        variation=None,
+        conductivity=None,
+        terms=(
+            SellmeierTerm(b=10.6684293, c_um=0.301516485),
+            SellmeierTerm(b=0.0030434748, c_um=1.13475115),
+            SellmeierTerm(b=1.54133408, c_um=1104.0),
+        ),
+        offset=0.0,
+    ),
+)
+
+_SI_LI_293K = _card(
+    name="Si-Li-293K",
+    temperature_ref=293.0,
+    permittivity=Index(
+        validity=_validity(1.2, 14.0),
+        variation=None,
+        conductivity=None,
+        n=TabulatedValue(
+            unit="",
+            data=TableData(
+                dims=("wavelength",),
+                coords={
+                    "wavelength": Coord(
+                        values=[row[0] for row in _LI_293K_DATA],
+                        unit="um",
+                    )
+                },
+                values=[row[1] for row in _LI_293K_DATA],
+                attrs={},
+                interp="linear",
+            ),
+        ),
+        k=None,
+    ),
+)
+
+_SIO2_MALITSON = _card(
+    name="SiO2-Malitson",
+    temperature_ref=293.0,
+    permittivity=Sellmeier(
+        validity=_validity(0.21, 6.7),
+        variation=None,
+        conductivity=None,
+        terms=(
+            SellmeierTerm(b=0.6961663, c_um=0.0684043),
+            SellmeierTerm(b=0.4079426, c_um=0.1162414),
+            SellmeierTerm(b=0.8974794, c_um=9.896161),
+        ),
+        offset=0.0,
+    ),
+)
+
+GSIM_MATERIAL_CARDS: dict[str, MaterialCard] = {
+    "Si": _SI_SALZBERG.model_copy(update={"name": "Si"}),
+    "Si-Salzberg": _SI_SALZBERG,
+    "Si-Li-293K": _SI_LI_293K,
+    "SiO2": _SIO2_MALITSON.model_copy(update={"name": "SiO2"}),
+    "SiO2-Malitson": _SIO2_MALITSON,
+}
+
+
+def get_material_card(
+    material_name: str,
+    project_material_cards: Mapping[str, MaterialCard] | None = None,
+) -> MaterialCard:
+    """Return an active-PDK card when present, otherwise a built-in card."""
+    if project_material_cards is None:
+        active_pdk = gf.get_active_pdk()
+        project_material_cards = getattr(active_pdk, "material_cards", None)
+    if project_material_cards and material_name in project_material_cards:
+        return project_material_cards[material_name]
+    return GSIM_MATERIAL_CARDS[material_name]
+
+
+__all__ = ["GSIM_MATERIAL_CARDS", "get_material_card"]

{gsim-0.2.0 → gsim-0.3.0}/src/gsim/common/polygon.py

@@ -55,7 +55,26 @@ def fuse_polygons(
     Returns:
         Merged Shapely Polygon or MultiPolygon
     """
-    layer_region = layer.get_shapes(component)
+    source_layer = getattr(layer, "layer", layer)
+    derived_layer = getattr(layer, "derived_layer", None)
+
+    # Simulation export materializes derived layers onto their GDS targets.
+    # Prefer those polygons when present: re-evaluating the source Boolean
+    # expression loses LayerLevel.background semantics (notably full-height
+    # grating teeth). Fall back to evaluating the source expression for the
+    # ordinary, unmaterialized visualization path.
+    layer_region = None
+    if derived_layer is not None:
+        target = tuple(derived_layer.layer)
+        layer_index = component.kcl.layer(*target)
+        target_region = component.kdb_cell.begin_shapes_rec(layer_index)
+        if not target_region.at_end():
+            from kfactory import kdb
+
+            layer_region = kdb.Region(target_region)
+
+    if layer_region is None:
+        layer_region = source_layer.get_shapes(component)
 
     shapely_polygons = []
     for klayout_polygon in layer_region.each_merged():
@@ -100,15 +119,13 @@ def cleanup_component(
     Returns:
         Dict mapping layer name to merged Shapely polygon
     """
-    layer_stack_dict = layer_stack.to_dict()
-
     return {
         layername: fuse_polygons(
             component,
-            layer["layer"],
+            layer,
             round_tol=round_tol,
             simplify_tol=simplify_tol,
         )
-        for layername, layer in layer_stack_dict.items()
-        if layer["layer"] is not None
+        for layername, layer in layer_stack.layers.items()
+        if layer.layer is not None
     }

{gsim-0.2.0 → gsim-0.3.0}/src/gsim/common/stack/extractor.py

@@ -491,6 +491,13 @@ def extract_layer_stack(
             if not _is_dielectric_material(material):
                 continue
             if not _looks_like_passivation(layer_name, material):
+                if material.strip().lower() in {
+                    "si",
+                    "silicon",
+                    "ge",
+                    "germanium",
+                }:
+                    continue
                 bulk_material = material
                 break
 
@@ -502,13 +509,19 @@ def extract_layer_stack(
 
     if bulk_material is None and sorted_dielectric_layers:
         for _zmin, _zmax, material, _layer_name in sorted_dielectric_layers:
-            if _is_dielectric_material(material):
+            # Silicon/Ge layers can be classified as dielectrics for geometry
+            # purposes, but they are not a suitable blanket cladding.  If a
+            # PDK has no oxide-like layer, use the explicit SiO2 fallback
+            # below rather than turning the synthetic BOX/cladding into Si.
+            if _is_dielectric_material(material) and material.strip().lower() not in {
+                "si",
+                "silicon",
+                "ge",
+                "germanium",
+            }:
                 bulk_material = material
                 break
 
-    if bulk_material is None and sorted_dielectric_layers:
-        bulk_material = sorted_dielectric_layers[0][2]
-
     if bulk_material is None:
         # Rare fallback when a PDK stack defines no dielectric layers.
         bulk_material = "SiO2"

{gsim-0.2.0 → gsim-0.3.0}/src/gsim/meep/mode_solver.py

@@ -1270,7 +1270,7 @@ def refractive_index_profile(
         if layer.material == "air":
             continue
         gds_layer = getattr(layer, "gds_layer", None)
-        if gds_layer is None:
+        if not isinstance(gds_layer, tuple):
             continue
         intervals = interval_func(component, layer, cut_coord)
         if not intervals and not _layer_has_any_polygon(component, layer):
@@ -1292,6 +1292,8 @@ def refractive_index_profile(
         if eps <= 0:
             continue
         gds_layer = getattr(layer, "gds_layer", None)
+        if not isinstance(gds_layer, tuple):
+            continue
         h_mask = layer_h_masks.get(gds_layer)
         if h_mask is None:
             continue

{gsim-0.2.0 → gsim-0.3.0}/src/gsim/meep/models/results.py

@@ -475,9 +475,9 @@ class ModeResult(BaseModel):
             raise ValueError(
                 "Ambiguous geometry: both x_grid and y_grid are populated."
             )
-        if has_y:
+        if self.y_grid is not None:
             return self.y_grid, "y (µm)"
-        if has_x:
+        if self.x_grid is not None:
             return self.x_grid, "x (µm)"
         raise ValueError(
             "No horizontal grid available. Set x_grid or y_grid on ModeResult."

{gsim-0.2.0 → gsim-0.3.0}/src/gsim/meep/simulation.py

@@ -553,7 +553,52 @@ class Simulation(BaseModel):
         if mz_high < needed:
             self.domain.margin_z = (mz_low, needed)
 
-    def _resolve_z_ref_extent(self) -> tuple[float, float, str, float | None, bool]:
+    def _component_with_derived_layers(self, component: Any) -> Any:
+        """Return *component* augmented with any active-PDK derived layers.
+
+        GDS stores source mask layers, whereas a gdsfactory ``LayerStack`` may
+        describe physical layers using boolean expressions and ``derived_layer``
+        targets.  MEEP needs both: the evaluated layers for the physical stack
+        and the original layers for stack entries that are not derived.
+        """
+        import gdsfactory as gf
+
+        pdk_layer_stack = gf.get_active_pdk().layer_stack
+        if pdk_layer_stack is None:
+            return component.copy()
+        if not any(
+            level.derived_layer is not None for level in pdk_layer_stack.layers.values()
+        ):
+            return component.copy()
+
+        derived = pdk_layer_stack.get_component_with_derived_layers(component)
+        # ``get_component_with_derived_layers`` evaluates each layer's
+        # Boolean expression but does not apply gdsfactory's ``background``
+        # semantics.  Recreate those physical layers from the component bbox
+        # and the declared etch exclusions, matching ``Component.to_3d()``.
+        # This keeps the hierarchy intact; no flattening is required.
+        from kfactory import kdb
+
+        for level in pdk_layer_stack.layers.values():
+            if not getattr(level, "background", False) or level.derived_layer is None:
+                continue
+
+            target_layer = gf.get_layer_tuple(level.derived_layer.layer)
+            background = kdb.Region(component.kdb_cell.bbox())
+            for excluded_layer in getattr(level, "background_exclude_layers", ()):
+                layer_index = component.kcl.layer(*tuple(excluded_layer))
+                background -= kdb.Region(
+                    component.kdb_cell.begin_shapes_rec(layer_index)
+                )
+            derived.remove_layers([target_layer])
+            derived.add_polygon(background, layer=target_layer)
+
+        derived.add_ref(component)
+        return derived
+
+    def _resolve_z_ref_extent(
+        self, component: Any | None = None
+    ) -> tuple[float, float, str, float | None, bool]:
         """Resolve ``domain.z_ref`` to a vertical reference window.
 
         Single source of truth for both the fiber-margin expansion and the
@@ -588,7 +633,8 @@ class Simulation(BaseModel):
 
         if z_ref is None:
             layer, n = _find_highest_n_layer_in_component(
-                self.geometry.component, stack
+                component if component is not None else self.geometry.component,
+                stack,
             )
             if layer is None:
                 extent = self._stack_material_extent()
@@ -1139,11 +1185,21 @@ class Simulation(BaseModel):
         if self.geometry.component is None:
             raise ValueError("No geometry set.")
 
+        # Materialize derived PDK layers before inspecting or exporting the
+        # geometry.  A number of PDKs define the physical core as a boolean
+        # expression of fabrication-mask layers; those derived polygons are
+        # not present in an imported GDS until the layer stack evaluates them.
+        original_component = self._component_with_derived_layers(
+            self.geometry.component
+        )
+
         # Apply z-crop for 3D and XZ 2D (both use the vertical dimension).
         # XY 2D collapses z entirely so cropping is meaningless. The crop
         # window comes from domain.z_ref (default: the drawn photonic core).
         if (is_3d or plane == "xz") and not self._z_cropped:
-            ref_zmin, ref_zmax, ref_name, ref_n, is_auto = self._resolve_z_ref_extent()
+            ref_zmin, ref_zmax, ref_name, ref_n, is_auto = self._resolve_z_ref_extent(
+                component=original_component
+            )
             # When a fiber source is configured in XZ mode, expand the
             # above (high) side of margin_z so the cropped stack still
             # contains the beam plane (and PML headroom) — from the ref top.
@@ -1152,7 +1208,6 @@ class Simulation(BaseModel):
 
         import gdsfactory as gf
 
-        original_component = self.geometry.component.copy()
         stack = self.geometry.stack
 
         # Resolve the XZ cut Y-coordinate ('auto'/None -> bbox center).

{gsim-0.2.0 → gsim-0.3.0}/src/gsim/meep/viz.py

@@ -254,9 +254,8 @@ def build_cross_section_rectangles(
     directly so cross-section geometry for custom material stacks
     (e.g. TFLN) is rendered correctly.
 
-    Layers that have no GDS polygons at all (``_layer_has_any_polygon``
-    returns ``False``) are skipped, since their boundaries are already
-    implicit from adjacent layers.
+    Layers that have no GDS polygons are skipped, since their boundaries are
+    already implicit from adjacent layers.
 
     Args:
         component: gdsfactory Component with GDS polygons.
@@ -275,23 +274,6 @@ def build_cross_section_rectangles(
     if not stack.layers:
         return []
 
-    def _has_any_polygon(layer: object) -> bool:
-        gds = getattr(layer, "gds_layer", None)
-        if gds is None:
-            return False
-        try:
-            polys = component.get_polygons_points(layers=(gds,), merge=True)
-        except Exception:
-            return False
-        else:
-            if not isinstance(polys, dict):
-                return False
-            for v in polys.values():
-                items = v if isinstance(v, list) else [v]
-                if len(items) > 0:
-                    return True
-            return False
-
     if slice_axis == "y":
         cut_line = LineString([(-1e6, slice_coord), (1e6, slice_coord)])
     elif slice_axis == "x":
@@ -327,21 +309,9 @@ def build_cross_section_rectangles(
                 poly_items.extend(items)
 
         if not poly_items:
-            if _has_any_polygon(layer):
-                continue
-            rectangles.append(
-                {
-                    "h_min": -float("inf"),
-                    "h_max": float("inf"),
-                    "z_min": layer.zmin,
-                    "z_max": layer.zmax,
-                    "layer_name": layer.name,
-                    "material": layer.material,
-                    "sidewall_angle": float(
-                        getattr(layer, "sidewall_angle", 0.0) or 0.0
-                    ),
-                }
-            )
+            # The component does not draw this stack layer.  Do not turn it
+            # into an infinite slab: the runner likewise emits no geometry
+            # for a layer with no GDS polygons.
             continue
 
         for poly in poly_items:

{gsim-0.2.0 → gsim-0.3.0/src/gsim.egg-info}/PKG-INFO

@@ -1,6 +1,7 @@
 Metadata-Version: 2.4
 Name: gsim
-Version: 0.2.0
+Version: 0.3.0
+Summary: Electromagnetic simulation for photonics and electronics, powered by GDSFactory.
 Author-email: GDSFactory <contact@gdsfactory.com>
 License: Apache-2.0
 Classifier: License :: OSI Approved :: Apache Software License
@@ -15,6 +16,7 @@ Requires-Dist: gmsh
 Requires-Dist: meshio>=5.0.0
 Requires-Dist: nbformat>=4.2.0
 Requires-Dist: nest_asyncio2
+Requires-Dist: pdk-schema==0.0.2
 Requires-Dist: plotly
 Requires-Dist: pyvista>=0.43.0
 Requires-Dist: trame
@@ -22,7 +24,7 @@ Requires-Dist: trame-vtk
 Requires-Dist: trame-vuetify
 Dynamic: license-file
 
-# gsim 0.2.0
+# gsim 0.3.0
 
 > Electromagnetic simulation for photonics and electronics, powered by [GDSFactory+](https://gdsfactory.com)
 

{gsim-0.2.0 → gsim-0.3.0}/src/gsim.egg-info/SOURCES.txt

@@ -15,6 +15,7 @@ src/gsim/common/cross_section.py
 src/gsim/common/geometry.py
 src/gsim/common/geometry_model.py
 src/gsim/common/layered_component.py
+src/gsim/common/materials.py
 src/gsim/common/polygon.py
 src/gsim/common/polygon_utils.py
 src/gsim/common/types.py

{gsim-0.2.0 → gsim-0.3.0}/src/gsim.egg-info/requires.txt

@@ -4,6 +4,7 @@ gmsh
 meshio>=5.0.0
 nbformat>=4.2.0
 nest_asyncio2
+pdk-schema==0.0.2
 plotly
 pyvista>=0.43.0
 trame