gsim 0.0.0__tar.gz

gsim-0.0.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: gsim
+Version: 0.0.0
+Author-email: flaport <floris.laporte@gmail.com>
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: <3.14,>=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: gdsfactory>=8.32.2
+Requires-Dist: gdsfactoryplus>=1.3.7
+Requires-Dist: gmsh
+Requires-Dist: meshio>=5.0.0
+Requires-Dist: plotly
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pyvista>=0.43.0
+Provides-Extra: dev
+Requires-Dist: altair>=5.5.0; extra == "dev"
+Requires-Dist: build>=1.2.0; extra == "dev"
+Requires-Dist: griffe>=1.5.6; extra == "dev"
+Requires-Dist: ipykernel>=6.29.5; extra == "dev"
+Requires-Dist: matplotlib>=3.10.0; extra == "dev"
+Requires-Dist: mkautodoc>=0.2.0; extra == "dev"
+Requires-Dist: mkdocs-autorefs>=1.3.0; extra == "dev"
+Requires-Dist: mkdocs-material>=9.6.0; extra == "dev"
+Requires-Dist: mkdocs-shadcn>=0.2; extra == "dev"
+Requires-Dist: mkdocs>=1.6.1; extra == "dev"
+Requires-Dist: mkdocstrings[python]>=0.27.0; extra == "dev"
+Requires-Dist: mkinit>=1.1.0; extra == "dev"
+Requires-Dist: mypy>=1.15.0; extra == "dev"
+Requires-Dist: nb-clean>=4.0.1; extra == "dev"
+Requires-Dist: nbconvert>=7.16.6; extra == "dev"
+Requires-Dist: papermill>=2.6.0; extra == "dev"
+Requires-Dist: plotly>=6.0.0; extra == "dev"
+Requires-Dist: pre-commit>=4.1.0; extra == "dev"
+Requires-Dist: pyright>=1.1.0; extra == "dev"
+Requires-Dist: pytest-cov>=6.0.0; extra == "dev"
+Requires-Dist: pytest-randomly>=3.16.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.6.0; extra == "dev"
+Requires-Dist: pytest>=8.3.0; extra == "dev"
+Requires-Dist: ruff>=0.9.0; extra == "dev"
+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"
+
+# Gsim 0.0.0
+
+> a GDSFactory Simulation Plugin
+
+![gsim-logo](./docs/assets/img/gsim-small.png)
+
+## Overview
+
+Gsim bridges the gap between circuit layout design (using [GDSFactory](https://gdsfactory.github.io/gdsfactory/)) and electromagnetic simulation (using [Palace](https://awslabs.github.io/palace/)). It automates the conversion of IC component layouts into simulation-ready mesh files and configuration.
+
+## Features
+
+- **Layer Stack Extraction**: Extract layer stacks from PDK definitions with a comprehensive material properties database
+- **Port Configuration**: Convert GDSFactory ports into Palace-compatible port definitions (inplane, via, and CPW ports)
+- **Mesh Generation**: Generate GMSH-compatible finite element meshes with configurable quality presets
+
+## Installation
+
+```bash
+pip install gsim
+```
+
+For development:
+
+```bash
+git clone https://github.com/doplaydo/gsim
+cd gsim
+pip install -e .[dev]
+```
+
+## Quick Start
+
+```python
+from gsim.palace import (
+    get_stack,
+    configure_inplane_port,
+    extract_ports,
+    generate_mesh,
+    MeshConfig,
+)
+
+# Get layer stack from active PDK
+stack = get_stack()
+
+# Configure ports on your component
+configure_inplane_port(c.ports["o1"], layer="topmetal2", length=5.0)
+configure_inplane_port(c.ports["o2"], layer="topmetal2", length=5.0)
+
+# Extract configured ports
+ports = extract_ports(c, stack)
+
+# Generate mesh
+result = generate_mesh(
+    component=c,
+    stack=stack,
+    ports=ports,
+    output_dir="./simulation",
+    config=MeshConfig.default(),
+)
+```
+
+## Mesh Presets
+
+| Preset  | Refined Size | Max Size | Use Case                          |
+| ------- | ------------ | -------- | --------------------------------- |
+| Coarse  | 10.0 µm      | 600.0 µm | Fast iteration (~2.5 elements/λ)  |
+| Default | 5.0 µm       | 300.0 µm | Balanced accuracy (~5 elements/λ) |
+| Fine    | 2.0 µm       | 70.0 µm  | High accuracy (~10 elements/λ)    |
+
+## Port Types
+
+- **Inplane ports**: Horizontal ports on single metal layer for CPW gaps
+- **Via ports**: Vertical ports between two metal layers for microstrip structures
+- **CPW ports**: Multi-element ports for proper Coplanar Waveguide excitation
+
+## Documentation
+
+See the [documentation](https://doplaydo.github.io/gsim/) for detailed API reference and examples.
+
+## License
+
+Copyright 2026 GDSFactory

gsim-0.0.0/README.md

@@ -0,0 +1,82 @@
+# Gsim 0.0.0
+
+> a GDSFactory Simulation Plugin
+
+![gsim-logo](./docs/assets/img/gsim-small.png)
+
+## Overview
+
+Gsim bridges the gap between circuit layout design (using [GDSFactory](https://gdsfactory.github.io/gdsfactory/)) and electromagnetic simulation (using [Palace](https://awslabs.github.io/palace/)). It automates the conversion of IC component layouts into simulation-ready mesh files and configuration.
+
+## Features
+
+- **Layer Stack Extraction**: Extract layer stacks from PDK definitions with a comprehensive material properties database
+- **Port Configuration**: Convert GDSFactory ports into Palace-compatible port definitions (inplane, via, and CPW ports)
+- **Mesh Generation**: Generate GMSH-compatible finite element meshes with configurable quality presets
+
+## Installation
+
+```bash
+pip install gsim
+```
+
+For development:
+
+```bash
+git clone https://github.com/doplaydo/gsim
+cd gsim
+pip install -e .[dev]
+```
+
+## Quick Start
+
+```python
+from gsim.palace import (
+    get_stack,
+    configure_inplane_port,
+    extract_ports,
+    generate_mesh,
+    MeshConfig,
+)
+
+# Get layer stack from active PDK
+stack = get_stack()
+
+# Configure ports on your component
+configure_inplane_port(c.ports["o1"], layer="topmetal2", length=5.0)
+configure_inplane_port(c.ports["o2"], layer="topmetal2", length=5.0)
+
+# Extract configured ports
+ports = extract_ports(c, stack)
+
+# Generate mesh
+result = generate_mesh(
+    component=c,
+    stack=stack,
+    ports=ports,
+    output_dir="./simulation",
+    config=MeshConfig.default(),
+)
+```
+
+## Mesh Presets
+
+| Preset  | Refined Size | Max Size | Use Case                          |
+| ------- | ------------ | -------- | --------------------------------- |
+| Coarse  | 10.0 µm      | 600.0 µm | Fast iteration (~2.5 elements/λ)  |
+| Default | 5.0 µm       | 300.0 µm | Balanced accuracy (~5 elements/λ) |
+| Fine    | 2.0 µm       | 70.0 µm  | High accuracy (~10 elements/λ)    |
+
+## Port Types
+
+- **Inplane ports**: Horizontal ports on single metal layer for CPW gaps
+- **Via ports**: Vertical ports between two metal layers for microstrip structures
+- **CPW ports**: Multi-element ports for proper Coplanar Waveguide excitation
+
+## Documentation
+
+See the [documentation](https://doplaydo.github.io/gsim/) for detailed API reference and examples.
+
+## License
+
+Copyright 2026 GDSFactory

gsim-0.0.0/pyproject.toml

@@ -0,0 +1,217 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools>=61", "uv", "build", "wheel"]
+
+[project]
+authors = [{name = "flaport", email = "floris.laporte@gmail.com"}]
+classifiers = [
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Operating System :: OS Independent"
+]
+dependencies = [
+  "gdsfactory>=8.32.2",
+  "gdsfactoryplus>=1.3.7",
+  "gmsh",
+  "meshio>=5.0.0",
+  "plotly",
+  "pydantic>=2.10.6",
+  "pyvista>=0.43.0"
+]
+description = ""
+name = "gsim"
+readme = "README.md"
+requires-python = ">=3.12,<3.14"
+version = "0.0.0"
+
+[project.optional-dependencies]
+dev = [
+  "altair>=5.5.0",
+  "build>=1.2.0",
+  "griffe>=1.5.6",
+  "ipykernel>=6.29.5",
+  "matplotlib>=3.10.0",
+  "mkautodoc>=0.2.0",
+  "mkdocs-autorefs>=1.3.0",
+  "mkdocs-material>=9.6.0",
+  "mkdocs-shadcn>=0.2",
+  "mkdocs>=1.6.1",
+  "mkdocstrings[python]>=0.27.0",
+  "mkinit>=1.1.0",
+  "mypy>=1.15.0",
+  "nb-clean>=4.0.1",
+  "nbconvert>=7.16.6",
+  "papermill>=2.6.0",
+  "plotly>=6.0.0",
+  "pre-commit>=4.1.0",
+  "pyright>=1.1.0",
+  "pytest-cov>=6.0.0",
+  "pytest-randomly>=3.16.0",
+  "pytest-xdist>=3.6.0",
+  "pytest>=8.3.0",
+  "ruff>=0.9.0",
+  "towncrier>=24.0.0",
+  "vega-datasets>=0.9.0",
+  "nbstripout>=0.8.1",
+  "ty>=0.0.13"
+]
+
+[[tool.bver.file]]
+src = "README.md"
+
+[[tool.bver.file]]
+src = "pyproject.toml"
+
+[[tool.bver.file]]
+src = "src/gsim/__init__.py"
+
+[tool.mypy]
+mypy_path = ["src"]
+python_version = "3.12"
+strict = true
+
+[[tool.mypy.overrides]]
+implicit_reexport = true
+module = "gsim"
+
+[[tool.mypy.overrides]]
+check_untyped_defs = false
+disable_error_code = ["no-untyped-def", "no-untyped-call", "var-annotated", "assignment"]
+disallow_any_generics = false
+disallow_untyped_defs = false
+# The Palace subpackage is still evolving and uses optional dependencies
+# (e.g., gmsh, plotly). Keep mypy strict overall, but relax it here so
+# contributors aren't blocked by large refactors during early development.
+module = "gsim.palace.*"
+warn_return_any = false
+
+[[tool.mypy.overrides]]
+ignore_errors = true
+module = "tests.*"
+
+[[tool.mypy.overrides]]
+ignore_missing_imports = true
+module = "gmsh"
+
+[[tool.mypy.overrides]]
+ignore_missing_imports = true
+module = "gmsh.*"
+
+[[tool.mypy.overrides]]
+ignore_missing_imports = true
+module = "plotly"
+
+[[tool.mypy.overrides]]
+ignore_missing_imports = true
+module = "plotly.*"
+
+[tool.pylsp-mypy]
+enabled = true
+live_mode = true
+strict = true
+
+[tool.pyright]
+exclude = ["tests", "**/__pycache__", "**/.venv"]
+include = ["src"]
+pythonVersion = "3.12"
+reportMissingImports = "none"
+reportMissingTypeStubs = "none"
+
+[tool.pytest.ini_options]
+addopts = '--tb=short'
+norecursedirs = ["scripts"]
+testpaths = ["tests"]
+
+[tool.ruff]
+fix = true
+target-version = "py312"
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint]  # see https://docs.astral.sh/ruff/rules
+ignore = [
+  "ANN",  # flake8-annotations (too noisy for evolving API)
+  "BLE001",  # blind exception (common around optional deps / wrappers)
+  "C408",  # unnecessary-collection-call
+  "C901",  # complex-structure
+  "COM812",  # missing-trailing-comma
+  "D417",  # undocumented-param (google convention is strict here)
+  "D105",  # undocumented-magic-method
+  "EM101",  # exception-must-not-use-string-literal
+  "EM102",  # exception-must-not-use-f-string-literal
+  "E741",  # ambiguous-variable-name
+  "ERA001",  # commented-out-code
+  "FBT",  # boolean-trap (fine for public API, use keywords in docs/examples)
+  "FIX001",  # line-contains-fixme
+  "FIX002",  # line-contains-todo
+  "FIX004",  # line-contains-hack
+  "N803",  # invalid-argument-name
+  "N806",  # non-lowercase-variable-in-function
+  "PLC0414",  # useless-import-alias
+  "PLR",  # pylint refactor (too strict for this codebase right now)
+  "PLR0913",  # too-many-arguments
+  "PLR2004",  # magic-value-comparison
+  "PLW2901",  # redefined-loop-name
+  "PTH123",  # Path.open preferred
+  "S110",  # try-except-pass
+  "RET504",  # unnecessary-assign
+  "S324",  # hashlib-insecure-hash-function
+  "TC001",  # typing-only-first-party-import
+  "TC002",  # typing-only-third-party-import
+  "TC003",  # typing-only-standard-library-import
+  "TC006",  # runtime-cast-value
+  "TD001",  # invalid-todo-tag
+  "TD002",  # missing-todo-author
+  "TD003",  # missing-todo-link
+  "TID252",  # relative-imports
+  "TRY003"  # raise-vanilla-args
+]
+select = ["ALL"]
+
+[tool.ruff.lint.per-file-ignores]
+"*.ipynb" = [
+  "ANN",  # flake8-annotations
+  "ARG001",  # unused-function-argument
+  "D",  # pydocstyle
+  "E402",  # module-import-not-at-top-of-file
+  "E501",  # line-too-long
+  "F821",  # undefined-name
+  "FBT003",  # boolean-positional-value-in-call
+  "N816",  # mixed-case-variable-in-global-scope
+  "NPY",  # numpy (allow legacy RNG calls in notebooks)
+  "PLC2401",  # non-ascii-name
+  "S101",  # assert
+  "SLF001",  # private-member-access
+  "T201"  # print
+]
+"scripts/*.py" = [
+  "ANN",  # flake8-annotations
+  "ARG001",  # unused-function-argument
+  "D",  # pydocstyle
+  "E402",  # module-import-not-at-top-of-file
+  "E501",  # line-too-long
+  "F821",  # undefined-name
+  "FBT003",  # boolean-positional-value-in-call
+  "INP001",  # implicit-namespace-package
+  "N816",  # mixed-case-variable-in-global-scope
+  "PLC2401",  # non-ascii-name
+  "S101",  # assert
+  "SLF001",  # private-member-access
+  "T201"  # print
+]
+"tests/**/*.py" = [
+  "ANN",  # flake8-annotations
+  "D",  # pydocstyle
+  "INP001",  # implicit-namespace-package
+  "PLC0415",  # allow imports inside tests
+  "PT011",  # pytest-raises-too-broad
+  "S101",  # assert
+  "T201"  # print
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.setuptools.packages.find]
+where = ["src"]

gsim-0.0.0/setup.cfg

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

gsim-0.0.0/src/gsim/__init__.py

@@ -0,0 +1,16 @@
+"""GSIM - GDSFactory+ Simulation Tools.
+
+This package provides APIs and client SDKs for accessing simulation tools
+of gdsfactory+.
+
+Currently includes:
+    - palace: Palace EM simulation API
+"""
+
+from __future__ import annotations
+
+__version__ = "0.0.0"
+
+__all__ = [
+    "__version__",
+]

gsim-0.0.0/src/gsim/gcloud.py

@@ -0,0 +1,169 @@
+"""GDSFactory+ cloud simulation interface.
+
+This module provides an interface to run simulations on
+the GDSFactory+ cloud infrastructure.
+
+Usage:
+    from gsim import gcloud
+
+    # Run simulation (uploads, starts, waits, downloads)
+    results = gcloud.run_simulation("./sim", job_type="palace")
+
+    # Or use solver-specific wrappers:
+    from gsim import palace as pa
+    results = pa.run_simulation("./sim")
+"""
+
+from __future__ import annotations
+
+import zipfile
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from gdsfactoryplus import sim  # type: ignore[import-untyped]
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+    from typing import Literal
+
+
+def _get_job_definition(job_type: str):
+    """Get JobDefinition enum value by name."""
+    job_type_upper = job_type.upper()
+    if not hasattr(sim.JobDefinition, job_type_upper):
+        valid = [e.name for e in sim.JobDefinition]
+        raise ValueError(f"Unknown job type '{job_type}'. Valid types: {valid}")
+    return getattr(sim.JobDefinition, job_type_upper)
+
+
+def upload_simulation_dir(input_dir: str | Path, job_type: str):
+    """Zip all files in a directory and upload for simulation.
+
+    Args:
+        input_dir: Directory containing simulation files
+        job_type: Simulation type (e.g., "palace")
+
+    Returns:
+        PreJob object from gdsfactoryplus
+    """
+    input_dir = Path(input_dir)
+    zip_path = Path("_gsim_upload.zip")
+
+    try:
+        with zipfile.ZipFile(zip_path, "w", zipfile.ZIP_STORED) as zf:
+            for file in input_dir.rglob("*"):
+                if file.is_file():
+                    zf.write(file, arcname=file.relative_to(input_dir))
+
+        job_definition = _get_job_definition(job_type)
+        pre_job = sim.upload_simulation(path=zip_path, job_definition=job_definition)
+    finally:
+        if zip_path.exists():
+            zip_path.unlink()
+
+    return pre_job
+
+
+def run_simulation(
+    output_dir: str | Path,
+    job_type: Literal["palace"] = "palace",
+    verbose: bool = True,
+    on_started: Callable | None = None,
+) -> dict[str, Path]:
+    """Run a simulation on GDSFactory+ cloud.
+
+    This function handles the complete workflow:
+    1. Uploads simulation files
+    2. Starts the simulation job
+    3. Waits for completion
+    4. Downloads results
+
+    Args:
+        output_dir: Directory containing the simulation files
+        job_type: Type of simulation (default: "palace")
+        verbose: Print progress messages (default True)
+        on_started: Optional callback called with job object when simulation starts
+
+    Returns:
+        Dict mapping result filename to local Path.
+
+    Raises:
+        RuntimeError: If simulation fails
+
+    Example:
+        >>> results = gcloud.run_simulation("./sim", job_type="palace")
+        Uploading simulation... done
+        Job started: palace-abc123
+        Waiting for completion... done (2m 34s)
+        Downloading results... done
+    """
+    output_dir = Path(output_dir)
+
+    if not output_dir.exists():
+        raise FileNotFoundError(f"Output directory not found: {output_dir}")
+
+    # Upload
+    if verbose:
+        print("Uploading simulation... ", end="", flush=True)  # noqa: T201
+
+    pre_job = upload_simulation_dir(output_dir, job_type)
+
+    if verbose:
+        print("done")  # noqa: T201
+
+    # Start
+    job = sim.start_simulation(pre_job)
+
+    if verbose:
+        print(f"Job started: {job.job_name}")  # noqa: T201
+
+    if on_started:
+        on_started(job)
+
+    # Wait
+    finished_job = sim.wait_for_simulation(job)
+
+    # Check status
+    if finished_job.exit_code != 0:
+        raise RuntimeError(
+            f"Simulation failed with exit code {finished_job.exit_code}. "
+            f"Status: {finished_job.status.value}"
+        )
+
+    # Download
+    results = sim.download_results(finished_job)
+
+    if verbose and results:
+        first_path = next(iter(results.values()))
+        download_dir = first_path.parent
+        print(f"Downloaded {len(results)} files to {download_dir}")  # noqa: T201
+
+    return results
+
+
+def print_job_summary(job) -> None:
+    """Print a formatted summary of a simulation job.
+
+    Args:
+        job: Job object from gdsfactoryplus
+    """
+    if job.started_at and job.finished_at:
+        delta = job.finished_at - job.started_at
+        minutes, seconds = divmod(int(delta.total_seconds()), 60)
+        duration = f"{minutes}m {seconds}s"
+    else:
+        duration = "N/A"
+
+    size_kb = job.output_size_bytes / 1024
+    size_str = f"{size_kb:.1f} KB" if size_kb < 1024 else f"{size_kb / 1024:.2f} MB"
+    files = list(job.download_urls.keys()) if job.download_urls else []
+
+    print(f"{'Job:':<12} {job.job_name}")  # noqa: T201
+    print(f"{'Status:':<12} {job.status.value} (exit {job.exit_code})")  # noqa: T201
+    print(f"{'Duration:':<12} {duration}")  # noqa: T201
+    mem_gb = job.requested_memory_mb // 1024
+    print(f"{'Resources:':<12} {job.requested_cpu} CPU / {mem_gb} GB")  # noqa: T201
+    print(f"{'Output:':<12} {size_str}")  # noqa: T201
+    print(f"{'Files:':<12} {len(files)} files")  # noqa: T201
+    for f in files:
+        print(f"             - {f}")  # noqa: T201