Merge pull request #66 from ThomasPluck/main

Feature: VLSIR-based Netlisting Support

Author: ThomasPluck

.gitignore

@@ -16,7 +16,7 @@ tests/gds_ref/*.oas
 docs/components.rst
 docs/components_plot.rst
 .vscode/
-
+.claude/
 
 # C extensions
 *.so

.pre-commit-config.yaml

@@ -5,7 +5,9 @@ repos:
       - id: check-yaml
         exclude: ^(conda\.recipe/meta\.yaml|conda_build/templates/.*\.yaml|docs/click/meta\.yaml|conda/meta\.yaml|conda/construct.yaml|.*\.pic\.yml|conda/constructor/Miniforge3/construct.yaml)
       - id: end-of-file-fixer
+        exclude: ^(.*\.lib|.spiceinit)$
       - id: trailing-whitespace
+        exclude: ^(.*\.lib|.spiceinit)$
   - repo: https://github.com/kynan/nbstripout
     rev: 0.8.1
     hooks:
@@ -17,7 +19,8 @@ repos:
       - id: codespell
         additional_dependencies:
           - tomli
-        exclude: ^(pyproject\.toml|ihp/layers\.yaml|ihp/cells2/ihp_pycell/.*|cni/.*)$
+        args: [--ignore-words-list=te, fpr, nd, donot, schem, contnet, Contnet, rady, INOUT]
+        exclude: ^(pyproject\.toml|ihp/models/.*|ihp/layers\.yaml|ihp/cells2/ihp_pycell/.*|cni/.*)$
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: "v0.12.11"
     hooks:

docs/_config.yml

@@ -4,6 +4,7 @@ title: IHP
 author: IHP
 logo: logo.png
 # Force re-execution of notebooks on each build.
+
 # See https://jupyterbook.org/content/execute.html
 execute:
   execute_notebooks: cache
@@ -13,18 +14,21 @@ latex:
   latex_engine: pdflatex # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex'
   use_jupyterbook_latex: true # use sphinx-jupyterbook-latex for pdf builds as default
 # Add a bibtex file so that we can create citations
+
 html:
   home_page_in_navbar: true
   use_edit_page_button: true
   use_repository_button: true
   use_issues_button: true
   baseurl: https://github.com/gdsfactory/ihp
 # Information about where the book exists on the web
+
 repository:
   url: https://github.com/gdsfactory/ihp
   path_to_book: docs # Optional path to your book, relative to the repository root
   branch: main # Which branch of the repository should be used when creating links (optional)
 # launch_buttons:
+
 #   notebook_interface: jupyterlab
 #   colab_url: "https://colab.research.google.com"
 sphinx:

ihp/cells/__init__.py

@@ -7,6 +7,7 @@
 from .fixed import *
 from .inductors import *
 from .passives import *
+from .primitives import *
 from .resistors import *
 from .text import *
 from .transistors import *

ihp/cells/antennas.py

@@ -232,6 +232,16 @@ def dantenna(
             )
         ).move((-diods_over, -diods_over))
 
+    # VLSIR Simulation Metadata
+    c.info["vlsir"] = {
+        "model": "dantenna",
+        "spice_type": "SUBCKT",
+        "spice_lib": "diodes.lib",
+        "port_order": ["1", "2"],
+        "port_map": {},  # No physical ports defined on component
+        "params": {"w": width * 1e-6, "l": length * 1e-6},
+    }
+
     return c
 
 
@@ -342,6 +352,16 @@ def dpantenna(
         )
     ).move((-NW_c, -NW_c))
 
+    # VLSIR Simulation Metadata
+    c.info["vlsir"] = {
+        "model": "dpantenna",
+        "spice_type": "SUBCKT",
+        "spice_lib": "diodes.lib",
+        "port_order": ["1", "2"],
+        "port_map": {},  # No physical ports defined on component
+        "params": {"w": width * 1e-6, "l": length * 1e-6},
+    }
+
     return c
 
 

ihp/cells/bipolar.py

@@ -266,14 +266,24 @@ def npn13G2(
     c.info["m"] = m
     c.info["type"] = "npn"
 
+    # VLSIR Simulation Metadata
+    c.info["vlsir"] = {
+        "model": model,
+        "spice_type": "SUBCKT",
+        "spice_lib": "sg13g2_hbt_mod.lib",
+        "port_order": ["c", "b", "e"],
+        "port_map": {"C": "c", "B": "b", "E": "e"},
+        "params": {"we": emitter_width * 1e-6, "le": emitter_length * 1e-6, "m": m},
+    }
+
     return c
 
 
 @gf.cell
 def npn13G2L(
     emitter_width: float = 0.07,
     emitter_length: float = 1.26,
-    model: str = "npn13G2L",
+    model: str = "npn13G2l",  # Lowercase l to match SPICE
     m: int = 1,
     layer_nwell: LayerSpec = "NWelldrawing",
     layer_pwell: LayerSpec = "PWelldrawing",
@@ -323,7 +333,7 @@ def npn13G2L(
 def npn13G2V(
     emitter_width: float = 0.12,
     emitter_length: float = 0.9,
-    model: str = "npn13G2V",
+    model: str = "npn13G2v",  # lower-case v to match SPICE
     m: int = 1,
     layer_nwell: LayerSpec = "NWelldrawing",
     layer_pwell: LayerSpec = "PWelldrawing",
@@ -575,6 +585,16 @@ def pnpMPA(
     c.info["m"] = m
     c.info["type"] = "pnp"
 
+    # VLSIR Simulation Metadata
+    c.info["vlsir"] = {
+        "model": model,
+        "spice_type": "SUBCKT",
+        "spice_lib": "sg13g2_hbt_mod.lib",
+        "port_order": ["c", "b", "e"],
+        "port_map": {"C": "c", "B": "b", "E": "e"},
+        "params": {"we": emitter_width * 1e-6, "le": emitter_length * 1e-6, "m": m},
+    }
+
     return c
 
 

ihp/cells/bjt_transistors.py

@@ -715,6 +715,22 @@ def npn13G2(
             port_type="electrical",
         )
 
+        # VLSIR Simulation Metadata
+        c.info["vlsir"] = {
+            "model": "npn13G2",
+            "spice_type": "SUBCKT",
+            "spice_lib": "sg13g2_hbt_mod.lib",
+            "port_order": ["c", "b", "e", "bn"],
+            "params": {
+                "Nx": Nx,
+                "Ny": Ny,
+                "we": emitter_width * 1e-6,
+                "le": emitter_length * 1e-6,
+            },
+        }
+
+        # TODO: Extend to handle empoly, bipwin, cmet
+
     return c
 
 
@@ -1265,6 +1281,18 @@ def npn13G2L(
         ),
     )
 
+    # VLSIR Simulation Metadata
+    c.info["vlsir"] = {
+        "model": "npn13G2l",
+        "spice_type": "SUBCKT",
+        "spice_lib": "sg13g2_hbt_mod.lib",
+        "port_order": ["c", "b", "e", "bn"],
+        "params": {
+            "we": emitter_width * 1e-6,
+            "le": emitter_length * 1e-6,
+        },
+    }
+
     return c
 
 
@@ -1836,6 +1864,18 @@ def npn13G2V(
         ),
     )
 
+    # VLSIR Simulation Metadata
+    c.info["vlsir"] = {
+        "model": "npn13G2v",
+        "spice_type": "SUBCKT",
+        "spice_lib": "sg13g2_hbt_mod.lib",
+        "port_order": ["c", "b", "e", "bn"],
+        "params": {
+            "we": emitter_width * 1e-6,
+            "le": emitter_length * 1e-6,
+        },
+    }
+
     return c
 
 
@@ -2371,6 +2411,14 @@ def pnpMPA(length: float = 2, width: float = 0.7) -> gf.Component:
         port_type="electrical",
     )
 
+    c.info["vlsir"] = {
+        "model": "pnpMPA",
+        "spice_type": "SUBCKT",
+        "spice_lib": "sg13g2_hbt_mod.lib",
+        "port_order": ["c", "b", "e"],
+        # TODO: Understand meaning of pnpMPA params
+    }
+
     return c
 
 

ihp/cells/bondpads.py

@@ -100,6 +100,21 @@ def bondpad(
     c.info["shape"] = shape
     c.info["diameter"] = diameter
     c.info["top_metal"] = layer_top_metal
+
+    # VLSIR Simulation Metadata
+    c.info["vlsir"] = {
+        "model": "bondpad",
+        "spice_type": "SUBCKT",
+        "spice_lib": "sg13g2_bondpad.lib",
+        "port_order": ["PAD"],
+        "port_map": {"pad": "PAD"},
+        "params": {
+            "size": diameter * 1e-6,
+            "shape": {"octagon": 0, "square": 1, "circle": 2}[shape],
+            "padtype": 0,  # TODO
+        },
+    }
+
     return c
 
 
@@ -157,6 +172,8 @@ def bondpad_array(
     c.info["pad_pitch"] = pad_pitch
     c.info["pad_diameter"] = pad_diameter
 
+    # TODO: Bondpad array VLSIR Metadata
+
     return c
 
 

ihp/cells/capacitors.py

@@ -510,6 +510,16 @@ def cmim(
     c.info["length"] = length
     c.info["capacitance_fF"] = capacitance
     c.info["area_um2"] = width * length
+
+    # VLSIR simulation metadata
+    c.info["vlsir"] = {
+        "model": "cap_cmim",
+        "spice_type": "SUBCKT",
+        "spice_lib": "capacitors_mod.lib",
+        "port_order": ["PLUS", "MINUS"],
+        "params": {"w": width * 1e-6, "l": length * 1e-6},
+    }
+
     return c
 
 
@@ -681,7 +691,15 @@ def rfcmim(
     c.add_label(text="TIE_LOW", position=(tie.x, tie.y), layer=layer_metal1label)
     c.add_label(text="TIE_LOW", position=(tie.x, tie.y), layer=layer_text)
 
-    c.info["model"] = model
+    # VLSIR simulation metadata
+    c.info["vlsir"] = {
+        "model": "cap_rfcmim",
+        "spice_type": "SUBCKT",
+        "spice_lib": "capacitors_mod.lib",
+        "port_order": ["PLUS", "MINUS", "bn"],
+        "port_map": {"PLUS": "PLUS", "MINUS": "MINUS"},
+        "params": {"l": length * 1e-6, "w": width * 1e-6},
+    }
 
     return c