🚧 Automatic compilation of raw efabless PDKs into a gdsfactory-compatible PDK

.github/workflows/release.yml

@@ -10,6 +10,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
       - name: Set up Python
         uses: actions/setup-python@v5
         with:

.github/workflows/test_code.yml

@@ -27,6 +27,8 @@ jobs:
     container: ghcr.io/gdsfactory/gdsfactory:main
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
       - name: Install dependencies
         run: |
           make install

.gitignore

@@ -144,3 +144,4 @@ cython_debug/
 *.DS_Store
 .DS_Store
 *Thumbs.db
+.idea/

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "sky130/src/sky130_fd_pr"]
+	path = sky130/src/sky130_fd_pr
+	url = https://github.com/efabless/skywater-pdk-libs-sky130_fd_pr.git
+[submodule "sky130/src/sky130_fd_sc_hd"]
+	path = sky130/src/sky130_fd_sc_hd
+	url = https://github.com/efabless/skywater-pdk-libs-sky130_fd_sc_hd.git

.python-version

@@ -0,0 +1 @@
+sky130

pyproject.toml

@@ -38,6 +38,11 @@ docs = [
   "jupyter-book==1.0.0"
 ]
 
+[tool.flit.sdist]
+exclude = [
+  "**/.git/**"
+]
+
 [tool.mypy]
 python_version = "3.10"
 strict = true

sky130/compile_components.py

@@ -0,0 +1,119 @@
+import os
+
+# Define the PDK directories
+pdk_directories = ["src/sky130_fd_pr", "src/sky130_fd_sc_hd"]
+
+
+# List to store gds file paths
+
+
+def compile_components(pdk_directories=pdk_directories):
+    gds_files = []
+
+    # Walk through the PDK directories and collect GDS files
+    for pdk_dir in pdk_directories:
+        for subdir, _, files in os.walk(pdk_dir):
+            for file in files:
+                if file.endswith(".gds"):
+                    gds_files.append(os.path.join(subdir, file))
+
+    # Function to create Python code for each gds file
+    def create_code(file_path):
+        file_name = os.path.basename(file_path)
+        raw_cell_name = os.path.splitext(file_name)[0]
+
+        for pdk_dir in pdk_directories:
+            prefix = pdk_dir.split("/")[-1] + "__"
+            if raw_cell_name.startswith(prefix):
+                cell_name = raw_cell_name[len(prefix) :]
+                break
+
+        # For old compatibility:
+        cell_name = raw_cell_name
+
+        code = f"""
+@cell
+def {cell_name}() -> gf.Component:
+    \"\"\"Returns {cell_name} fixed cell.
+
+    .. plot::
+      :include-source:
+
+      import sky130
+
+      c = sky130.components.{cell_name}()
+      c.plot()
+    \"\"\"
+    return import_gds("{file_path}", cellname="{raw_cell_name}")
+"""
+        return code
+
+    # Prelude to add at the top of the file
+    prelude = """from functools import partial
+import gdsfactory as gf
+from gdsfactory.cell import cell
+
+from sky130.config import PATH
+from sky130.layers import LAYER
+
+# add_ports_m1 = gf.partial(
+#     gf.add_ports.add_ports_from_markers_inside,
+#     pin_layer=LAYER.met1pin,
+#     port_layer=LAYER.met1drawing,
+#     port_type="electrical",
+# )
+# add_ports_m2 = gf.partial(
+#     gf.add_ports.add_ports_from_markers_inside,
+#     pin_layer=LAYER.met2pin,
+#     port_layer=LAYER.met2drawing,
+#     port_type="electrical",
+# )
+
+add_ports_m1 = gf.partial(
+    gf.add_ports.add_ports_from_labels,
+    port_layer=LAYER.met1drawing,
+    layer_label=LAYER.met1label,
+    port_type="electrical",
+    port_width=0.2,
+    get_name_from_label=True,
+    guess_port_orientation=False,
+)
+add_ports_m2 = gf.partial(
+    gf.add_ports.add_ports_from_labels,
+    port_layer=LAYER.met2drawing,
+    layer_label=LAYER.met2label,
+    port_type="electrical",
+    port_width=0.2,
+    get_name_from_label=True,
+    guess_port_orientation=False,
+)
+add_ports = gf.compose(add_ports_m1, add_ports_m2)
+
+gdsdir = PATH.module
+import_gds = partial(gf.import_gds, gdsdir=gdsdir, decorator=add_ports)
+"""
+
+    # TODO delete old file automatically
+    # Write the code to a Python file
+    with open("components.py", "w") as f:
+        f.write(prelude)
+        for gds_file in gds_files:
+            print(gds_file)
+            # gds_file = os.path.dirname(str(pathlib.Path(gds_file)))
+            code = create_code(gds_file)
+            f.write(code)
+
+    print("Python file 'components.py' has been created.")
+
+
+if __name__ == "__main__":
+    compile_components()
+#     # gf.write_cells.write_cells(gdspath=PATH.gdshd, dirpath="gds")
+#     # gf.write_cells.write_cells(gdspath=PATH.gdshs, dirpath="gds")
+#     # gf.write_cells.write_cells(gdspath=PATH.gdshvl, dirpath="gds")
+#     # print(gf.write_cells.get_import_gds_script(PATH.gds))
+#     # c = sky130_fd_sc_hvl__xor2_1()
+#     # c = sky130_fd_sc_hd__lpflow_lsbuf_lh_isowell_tap_2()
+#     c = sky130_fd_sc_hd__conb_1()
+#     # c.show(show_ports=True)
+#     c.show()