gsim 0.0.0__py3-none-any.whl → 0.0.3__py3-none-any.whl

gsim/palace/models/results.py

@@ -0,0 +1,160 @@
+"""Result models for Palace simulations.
+
+This module contains Pydantic models for simulation results and validation.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class ValidationResult(BaseModel):
+    """Result of simulation configuration validation.
+
+    Attributes:
+        valid: Whether the configuration is valid
+        errors: List of error messages
+        warnings: List of warning messages
+    """
+
+    model_config = ConfigDict(validate_assignment=True)
+
+    valid: bool
+    errors: list[str] = Field(default_factory=list)
+    warnings: list[str] = Field(default_factory=list)
+
+    def __bool__(self) -> bool:
+        return self.valid
+
+    def __str__(self) -> str:
+        lines = []
+        if self.valid:
+            lines.append("Validation: PASSED")
+        else:
+            lines.append("Validation: FAILED")
+        if self.errors:
+            lines.append("Errors:")
+            lines.extend([f"  - {e}" for e in self.errors])
+        if self.warnings:
+            lines.append("Warnings:")
+            lines.extend([f"  - {w}" for w in self.warnings])
+        return "\n".join(lines)
+
+
+class SimulationResult(BaseModel):
+    """Result from running a Palace simulation.
+
+    Attributes:
+        mesh_path: Path to the generated mesh file
+        output_dir: Output directory path
+        config_path: Path to the Palace config file
+        results: Dictionary mapping result filenames to paths
+        conductor_groups: Physical group info for conductors
+        dielectric_groups: Physical group info for dielectrics
+        port_groups: Physical group info for ports
+        boundary_groups: Physical group info for boundaries
+        port_info: Port metadata
+    """
+
+    model_config = ConfigDict(validate_assignment=True, arbitrary_types_allowed=True)
+
+    mesh_path: Path
+    output_dir: Path
+    config_path: Path | None = None
+    results: dict[str, Path] = Field(default_factory=dict)
+
+    # Physical group info for Palace
+    conductor_groups: dict = Field(default_factory=dict)
+    dielectric_groups: dict = Field(default_factory=dict)
+    port_groups: dict = Field(default_factory=dict)
+    boundary_groups: dict = Field(default_factory=dict)
+
+    # Port metadata
+    port_info: list = Field(default_factory=list)
+
+    # Mesh statistics
+    mesh_stats: dict = Field(default_factory=dict)
+
+    def __str__(self) -> str:
+        lines = ["Mesh Summary"]
+        lines.append("=" * 40)
+
+        # Dimensions
+        if self.mesh_stats:
+            bbox = self.mesh_stats.get("bbox", {})
+            if bbox:
+                dx = bbox.get("xmax", 0) - bbox.get("xmin", 0)
+                dy = bbox.get("ymax", 0) - bbox.get("ymin", 0)
+                dz = bbox.get("zmax", 0) - bbox.get("zmin", 0)
+                lines.append(f"Dimensions: {dx:.1f} x {dy:.1f} x {dz:.1f} µm")
+
+            # Mesh info
+            nodes = self.mesh_stats.get("nodes", 0)
+            elements = self.mesh_stats.get("elements", 0)
+            tets = self.mesh_stats.get("tetrahedra", 0)
+            if nodes or elements:
+                lines.append(f"Nodes:      {nodes:,}")
+                lines.append(f"Elements:   {elements:,}")
+                if tets:
+                    lines.append(f"Tetrahedra: {tets:,}")
+
+            # Edge lengths
+            edge = self.mesh_stats.get("edge_length", {})
+            if edge:
+                e_min, e_max = edge.get("min", 0), edge.get("max", 0)
+                lines.append(f"Edge length: {e_min:.2f} - {e_max:.2f} µm")
+
+            # Mesh quality (gamma)
+            quality = self.mesh_stats.get("quality", {})
+            if quality:
+                q_min = quality.get("min", 0)
+                q_mean = quality.get("mean", 0)
+                lines.append(f"Quality:    {q_mean:.3f} (min: {q_min:.3f})")
+
+            # SICN quality (shows invalid elements)
+            sicn = self.mesh_stats.get("sicn", {})
+            if sicn:
+                invalid = sicn.get("invalid", 0)
+                if invalid > 0:
+                    lines.append(
+                        f"SICN:       {sicn.get('mean', 0):.3f} ({invalid} invalid!)"
+                    )
+                else:
+                    lines.append(f"SICN:       {sicn.get('mean', 0):.3f} (all valid)")
+
+            # Physical groups
+            groups = self.mesh_stats.get("groups", {})
+            if groups:
+                volumes = groups.get("volumes", [])
+                surfaces = groups.get("surfaces", [])
+                lines.append("-" * 40)
+                if volumes:
+                    lines.append(f"Volumes ({len(volumes)}):")
+                    for v in volumes:
+                        name = v["name"] if isinstance(v, dict) else v
+                        tag = v.get("tag", "") if isinstance(v, dict) else ""
+                        lines.append(f"  - {name}" + (f" [{tag}]" if tag else ""))
+                if surfaces:
+                    lines.append(f"Surfaces ({len(surfaces)}):")
+                    for s in surfaces:
+                        name = s["name"] if isinstance(s, dict) else s
+                        tag = s.get("tag", "") if isinstance(s, dict) else ""
+                        lines.append(f"  - {name}" + (f" [{tag}]" if tag else ""))
+
+        lines.append("-" * 40)
+        lines.append(f"Mesh:   {self.mesh_path}")
+        if self.config_path:
+            lines.append(f"Config: {self.config_path}")
+
+        return "\n".join(lines)
+
+    def __repr__(self) -> str:
+        return self.__str__()
+
+
+__all__ = [
+    "SimulationResult",
+    "ValidationResult",
+]

gsim/palace/models/stack.py

@@ -0,0 +1,59 @@
+"""Material configuration model for Palace simulations.
+
+This module contains the MaterialConfig Pydantic model for material property overrides
+in simulations. Layer and stack configuration is handled by gsim.common.stack.
+"""
+
+from __future__ import annotations
+
+from typing import Literal, Self
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class MaterialConfig(BaseModel):
+    """EM properties for a material.
+
+    Used for material property overrides in simulation classes.
+
+    Attributes:
+        type: Material type (conductor, dielectric, or semiconductor)
+        conductivity: Conductivity in S/m (for conductors)
+        permittivity: Relative permittivity (for dielectrics)
+        loss_tangent: Dielectric loss tangent
+    """
+
+    model_config = ConfigDict(validate_assignment=True)
+
+    type: Literal["conductor", "dielectric", "semiconductor"]
+    conductivity: float | None = Field(default=None, ge=0)
+    permittivity: float | None = Field(default=None, ge=1.0)
+    loss_tangent: float | None = Field(default=None, ge=0, le=1)
+
+    @classmethod
+    def conductor(cls, conductivity: float = 5.8e7) -> Self:
+        """Create a conductor material."""
+        return cls(type="conductor", conductivity=conductivity)
+
+    @classmethod
+    def dielectric(cls, permittivity: float, loss_tangent: float = 0.0) -> Self:
+        """Create a dielectric material."""
+        return cls(
+            type="dielectric", permittivity=permittivity, loss_tangent=loss_tangent
+        )
+
+    def to_dict(self) -> dict[str, object]:
+        """Convert to dictionary for YAML output."""
+        d: dict[str, object] = {"type": self.type}
+        if self.conductivity is not None:
+            d["conductivity"] = self.conductivity
+        if self.permittivity is not None:
+            d["permittivity"] = self.permittivity
+        if self.loss_tangent is not None:
+            d["loss_tangent"] = self.loss_tangent
+        return d
+
+
+__all__ = [
+    "MaterialConfig",
+]

gsim/palace/ports/config.py

@@ -11,7 +11,7 @@ from enum import Enum
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from gsim.palace.stack import LayerStack
+    from gsim.common.stack import LayerStack
 
 
 class PortType(Enum):

gsim/viz.py

@@ -5,10 +5,13 @@ This module provides visualization tools for meshes and simulation results.
 
 from __future__ import annotations
 
+import logging
 from pathlib import Path
 
-import meshio  # type: ignore[import-untyped]
-import pyvista as pv  # type: ignore[import-untyped]
+import meshio
+import pyvista as pv
+
+logger = logging.getLogger(__name__)
 
 
 def plot_mesh(
@@ -44,7 +47,7 @@ def plot_mesh(
     else:
         plotter = pv.Plotter(off_screen=True, window_size=[1200, 900])
 
-    plotter.set_background("white")
+    plotter.set_background("white")  # type: ignore[arg-type]
 
     if show_groups:
         # Filter to matching groups
@@ -64,7 +67,7 @@ def plot_mesh(
                     line_width=1,
                     label=group_map.get(gid, str(gid)),
                 )
-        plotter.add_legend()
+        plotter.add_legend()  # type: ignore[call-arg]
     else:
         plotter.add_mesh(mesh, style="wireframe", color="black", line_width=1)
 
@@ -79,8 +82,8 @@ def plot_mesh(
         plotter.close()
         # Display in notebook if available
         try:
-            from IPython.display import Image, display  # type: ignore[import-untyped]
+            from IPython.display import Image, display
 
             display(Image(str(output)))
         except ImportError:
-            print(f"Saved: {output}")
+            logger.info("Saved mesh plot to %s", output)

{gsim-0.0.0.dist-info → gsim-0.0.3.dist-info}/METADATA

@@ -1,14 +1,15 @@
 Metadata-Version: 2.4
 Name: gsim
-Version: 0.0.0
-Author-email: flaport <floris.laporte@gmail.com>
+Version: 0.0.3
+Author-email: GDSFactory <contact@gdsfactory.com>
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
-Requires-Python: <3.14,>=3.12
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
-Requires-Dist: gdsfactory>=8.32.2
-Requires-Dist: gdsfactoryplus>=1.3.7
+Requires-Dist: gdsfactory>=9.32.0
+Requires-Dist: gdsfactoryplus>=1.3.12
 Requires-Dist: gmsh
 Requires-Dist: meshio>=5.0.0
 Requires-Dist: plotly
@@ -43,8 +44,10 @@ Requires-Dist: towncrier>=24.0.0; extra == "dev"
 Requires-Dist: vega-datasets>=0.9.0; extra == "dev"
 Requires-Dist: nbstripout>=0.8.1; extra == "dev"
 Requires-Dist: ty>=0.0.13; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: ihp-gdsfactory>=0.1.4; extra == "docs"
 
-# Gsim 0.0.0
+# Gsim 0.0.3
 
 > a GDSFactory Simulation Plugin
 

gsim-0.0.3.dist-info/RECORD

@@ -0,0 +1,35 @@
+gsim/__init__.py,sha256=nh1lQGlwYoL_ugWb6OIZHqtqs-AUEwN0GmJXNWsD7vc,288
+gsim/gcloud.py,sha256=47ThJn-MSMSi2jGb4rElUknN70iY-YIO3mk6LxBRt7E,7426
+gsim/viz.py,sha256=joFz6c7XasW8YER8ZLtJlqKFnzkt0O96Ye9hFxyfUUo,2673
+gsim/common/__init__.py,sha256=HYVmB77s_0ELtEsp3ryaBod3thwiMPiz5rN-oc1SBxU,1298
+gsim/common/geometry.py,sha256=WdFhbHFZjKM7HL35UDmNgmgwWJHPf3YFs-sxMd4w6f4,2170
+gsim/common/stack/__init__.py,sha256=0v44u-BQSnW7Gb9t7a9tZ0HFxBVaCFKIAbXf40C3sFU,4023
+gsim/common/stack/extractor.py,sha256=dRm63yOZntjV_TWp7c7yOCQs-32-xuFtvT1fHYGwxNU,17849
+gsim/common/stack/materials.py,sha256=hQunUO3YwXDecrJxlklCTDcv0oXdSbhG_ByksgoOMrU,5164
+gsim/common/stack/visualization.py,sha256=avBKbuXHcFXksK7xcjsiHgd2VDCTVhIPrpVj2wOokoI,19294
+gsim/palace/__init__.py,sha256=SVUI7YRDKQeeKziu4Lc8hKGLRk_nxt4mK8o-hvveiec,3744
+gsim/palace/base.py,sha256=XFmPM6KJFV5B-tl1217nmkC8D8g5AkJfvmHVW2WVP78,12561
+gsim/palace/driven.py,sha256=w0j-hoXtt_XbTO9vt9e8_wWQqIhAIFEoZFth-sfYKYQ,25029
+gsim/palace/eigenmode.py,sha256=2RXWW5Ph9-gbBSQMQqfCsac2kIt-XM4HX43fbnx0jVY,19001
+gsim/palace/electrostatic.py,sha256=E0LKcWecBEZ0Z3WYwnUFRgqZtSwmvXx3dfbvq6WxRRU,13259
+gsim/palace/mesh/__init__.py,sha256=m6p_RsxYgVXP5euVRoxpGag50R9TzCrkLH_vR8Ll2hc,1438
+gsim/palace/mesh/config_generator.py,sha256=YebLBybZ3RK5dKpFb1U5SJAT_zw1a5SOHHAsaatkC-I,11581
+gsim/palace/mesh/generator.py,sha256=c1-fshWHwB6H05wZiwEKzaYq403UOKn7CS0OPuJrkwY,8217
+gsim/palace/mesh/geometry.py,sha256=jhnqpnTt9c2Ahs-FH7RAlpvol8swk4JyCvDdBpfRUfk,14675
+gsim/palace/mesh/gmsh_utils.py,sha256=G8JJUSlUL2Rr1tcM9G0M6F9UjxePFpWSUGfmJ-LWh8E,13801
+gsim/palace/mesh/groups.py,sha256=f-en11W2-RtR18xLMbSWHoWMf50-N59_yCNbUwE2nns,6243
+gsim/palace/mesh/pipeline.py,sha256=cMGyuHuY6ZJYoT3cjf1Jneck2UZQTgGQQhG-D-0oz9Q,6695
+gsim/palace/models/__init__.py,sha256=CHjp_1apFtROmBtyWmwuk8EpOYNj8WLqqAX2LPuSeic,1497
+gsim/palace/models/geometry.py,sha256=9jD2HKeJKYhyaBLLCNc4LyuW-OpIouX32WYiE2XP9wg,987
+gsim/palace/models/mesh.py,sha256=20aOEKViSe58JavFB90L02ZTGrNiopKiyUm_9MC3vJw,3446
+gsim/palace/models/numerical.py,sha256=waWxOlOXTIoSdnxa5FujGv6DAfVBnu7GXAAoUv7P1DU,1818
+gsim/palace/models/ports.py,sha256=ZcWwOGP59qPGjvv9Cu_gZ7pdlfbfAeaABSYqOLfWadw,4520
+gsim/palace/models/problems.py,sha256=CPVsCprNWx3Sch5Y6RZMVJmw9Qo_zDmGygKoOIqT30s,6568
+gsim/palace/models/results.py,sha256=14Lsc1uKOjhQwGixb0GRSS4A4tFulvNr-wQj_a_u5L4,5607
+gsim/palace/models/stack.py,sha256=g3cw-YliXAoMqEoynMXYUY2Ys39llpN-9nPhRBQYfYU,1975
+gsim/palace/ports/__init__.py,sha256=IoP11atw-Uf447AkZC5ixNcgqlNrC3GCnTGugjR_wgw,803
+gsim/palace/ports/config.py,sha256=DK8TwspCsghQFl1uqKzu-YYEhjfu37rMDuHErOLPPgU,12289
+gsim-0.0.3.dist-info/METADATA,sha256=_j2Xmw-F1l7bpIdVGlvmfYDQ2nuoyosOIeyXBffemT8,4347
+gsim-0.0.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+gsim-0.0.3.dist-info/top_level.txt,sha256=USwf5QaCLsXq3JCR6ejGvHANZmIifvuQAAl7w-cUE0Y,5
+gsim-0.0.3.dist-info/RECORD,,

{gsim-0.0.0.dist-info → gsim-0.0.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.10.1)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

gsim-0.0.0.dist-info/RECORD

@@ -1,18 +0,0 @@
-gsim/__init__.py,sha256=FmMjn3al4lB-2cGAlMcYoDpfEgb1CotlaBTKbfCCbfA,288
-gsim/gcloud.py,sha256=ulYaNyGXCRoTbud0im1qHyuwcvIpNpk1RRvnRxekCe4,5155
-gsim/viz.py,sha256=cakE-oH_O0wuL51gURl5YjLeCZQz-FFUzfr2jn2-MI4,2645
-gsim/palace/__init__.py,sha256=FHY3L9NRGx5xFCU-mLHKIDjJZc_G0kcIMoq6pX9RHyo,2938
-gsim/palace/mesh/__init__.py,sha256=vif960c46QbH1fkr4J9ydFh5ODcmxRS_Nx3D6JaVlMw,1207
-gsim/palace/mesh/generator.py,sha256=wQR64aqRMuHwA6klLHIASr03Z6tIUqHvvuwvovtwOBY,30735
-gsim/palace/mesh/gmsh_utils.py,sha256=G8JJUSlUL2Rr1tcM9G0M6F9UjxePFpWSUGfmJ-LWh8E,13801
-gsim/palace/mesh/pipeline.py,sha256=K5G1mb5kk9_y_lVHQH7fOOUquarlGEBtw3NTcNpni60,5936
-gsim/palace/ports/__init__.py,sha256=IoP11atw-Uf447AkZC5ixNcgqlNrC3GCnTGugjR_wgw,803
-gsim/palace/ports/config.py,sha256=LHgKqpk4w7rutUBEf-368bRu2l4N02m-Y8qPdKOuQmk,12289
-gsim/palace/stack/__init__.py,sha256=xcofg-9HuAiymv_77_AuEtTyVnpAjBbxOqRC3-kjQXs,3910
-gsim/palace/stack/extractor.py,sha256=elQn4aEux9_gslyPB1zDTdcOpdiBbCADF7B9vVPd6hg,20440
-gsim/palace/stack/materials.py,sha256=IzUGuPufWu7tx4uTuERodygsh8mA-BZh7NQfSBYLLBU,4637
-gsim/palace/stack/visualization.py,sha256=JwUDmdWqKYjSfeBX_EA1vp3ggxYAX8lI5soNIKHpwkg,19216
-gsim-0.0.0.dist-info/METADATA,sha256=ZNJ5JOBN4ruqnQszxFq9jP-Z1lxDpRP3lEI_RHvaxt4,4225
-gsim-0.0.0.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
-gsim-0.0.0.dist-info/top_level.txt,sha256=USwf5QaCLsXq3JCR6ejGvHANZmIifvuQAAl7w-cUE0Y,5
-gsim-0.0.0.dist-info/RECORD,,