kpex/FasterCap fixes

klayout_pex/fastercap/fastercap_model_generator.py

@@ -380,13 +380,19 @@ def reset(self):
     def add_in(self, name: str, layer: kdb.Region):
         debug(f"add_in: {name} -> {layer}")
         if name not in self.layers_in:
-            self.layers_in[name] = kdb.Region()
+            # NOTE: Calling kdb.Region([]) with the empty list enforces, that a flat layer is created.
+            #       The following "+=" packs the polynomials into this flat layer and
+            #       does not copy the hierarchical layer from the LayoutToNetlist database.
+            self.layers_in[name] = kdb.Region([])
         self.layers_in[name] += layer
 
     def add_out(self, name: str, layer: kdb.Region):
         debug(f"add_out: {name} -> {layer}")
         if name not in self.layers_out:
-            self.layers_out[name] = kdb.Region()
+            # NOTE: Calling kdb.Region([]) with the empty list enforces, that a flat layer is created.
+            #       The following "+=" packs the polynomials into this flat layer and
+            #       does not copy the hierarchical layer from the LayoutToNetlist database.
+            self.layers_out[name] = kdb.Region([])
         self.layers_out[name] += layer
 
     def finish_z(self):

klayout_pex/klayout/netlist_csv.py

@@ -36,7 +36,7 @@ def write_csv(netlist: kdb.Netlist,
                   top_cell_name: str,
                   output_path: str):
         with open(output_path, 'w') as f:
-            f.write('Device;Net1;Net2;Capacitance [F];Capacitance [fF]\n')
+            f.write('Device;Net1;Net2;Capacitance [fF]\n')
 
             top_circuit: kdb.Circuit = netlist.circuit_by_name(top_cell_name)
 
@@ -56,4 +56,4 @@ def write_csv(netlist: kdb.Netlist,
                     net2 = d.net_for_terminal('B')
                     cap = params['C']
                     cap_femto = round(cap * 1e15, 2)
-                    f.write(f"{dn};{net1.name};{net2.name};{'%.12g' % cap};{cap_femto}f\n")
+                    f.write(f"{dn};{net1.name};{net2.name};{cap_femto}\n")

klayout_pex/kpex_cli.py

@@ -509,6 +509,8 @@ def run_fastercap_extraction(self,
         reduced_netlist.write(reduced_netlist_path, spice_writer)
         info(f"Wrote reduced netlist to: {reduced_netlist_path}")
 
+        self._fastercap_extracted_csv_path = expanded_netlist_csv_path
+
     def run_magic_extraction(self,
                              args: argparse.Namespace):
         if args.input_mode != InputMode.GDS:
@@ -838,6 +840,12 @@ def rcx25_extracted_csv_path(self) -> str:
             raise Exception('rcx25_extracted_csv_path is not initialized, was run_kpex_2_5d_engine called?')
         return self._rcx25_extracted_csv_path
 
+    @property
+    def fastercap_extracted_csv_path(self) -> str:
+        if not hasattr(self, '_fastercap_extracted_csv_path'):
+            raise Exception('fastercap_extracted_csv_path is not initialized, was run_fastercap_extraction called?')
+        return self._fastercap_extracted_csv_path
+
 
 if __name__ == "__main__":
     cli = KpexCLI()

tests/fastercap/fastercap_test.py

@@ -0,0 +1,134 @@
+#
+# --------------------------------------------------------------------------------
+# SPDX-FileCopyrightText: 2024 Martin Jan Köhler and Harald Pretl
+# Johannes Kepler University, Institute for Integrated Circuits.
+#
+# This file is part of KPEX 
+# (see https://github.com/martinjankoehler/klayout-pex).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# SPDX-License-Identifier: GPL-3.0-or-later
+# --------------------------------------------------------------------------------
+#
+from __future__ import annotations
+
+import io
+import json
+import tempfile
+
+import allure
+import csv_diff
+import os
+import pytest
+from typing import *
+
+import klayout.db as kdb
+import klayout.lay as klay
+
+from klayout_pex.kpex_cli import KpexCLI
+
+
+CSVPath = str
+PNGPath = str
+parent_suite = "kpex/FasterCap Extraction Tests"
+tags = ("PEX", "FasterCap", "Maxwell")
+
+
+def _kpex_pdk_dir() -> str:
+    return os.path.realpath(os.path.join(__file__, '..', '..', '..',
+                                         'pdk', 'sky130A', 'libs.tech', 'kpex'))
+
+
+def _sky130a_testdata_dir() -> str:
+    return os.path.realpath(os.path.join(__file__, '..', '..', '..',
+                                         'testdata', 'designs', 'sky130A'))
+
+
+def _gds(*path_components) -> str:
+    return os.path.join(_sky130a_testdata_dir(), *path_components)
+
+
+def _save_layout_preview(gds_path: str,
+                         output_png_path: str):
+    kdb.Technology.clear_technologies()
+    default_lyt_path = os.path.abspath(f"{_kpex_pdk_dir()}/sky130A.lyt")
+    tech = kdb.Technology.create_technology('sky130A')
+    tech.load(default_lyt_path)
+
+    lv = klay.LayoutView()
+    lv.load_layout(gds_path)
+    lv.max_hier()
+    lv.set_config('background-color', '#000000')
+    lv.set_config('bitmap-oversampling', '1')
+    lv.set_config('default-font-size', '4')
+    lv.set_config('default-text-size', '0.1')
+    lv.save_image_with_options(
+        output_png_path,
+        width=4096, height=2160
+        # ,
+        # linewidth=2,
+        # resolution=0.25  # 4x as large fonts
+    )
+
+def _extract_single_cell(*path_components) -> Tuple[CSVPath, PNGPath]:
+    gds_path = _gds(*path_components)
+
+    preview_png_path = tempfile.mktemp(prefix=f"layout_preview_", suffix=".png")
+    _save_layout_preview(gds_path, preview_png_path)
+    output_dir_path = os.path.realpath(os.path.join(__file__, '..', '..', '..', 'output_sky130A'))
+    cli = KpexCLI()
+    cli.main(['main',
+              '--pdk', 'sky130A',
+              '--gds', gds_path,
+              '--out_dir', output_dir_path,
+              '--fastercap', 'y'])
+    assert cli.fastercap_extracted_csv_path is not None
+    return cli.fastercap_extracted_csv_path, preview_png_path
+
+
+def assert_expected_matches_obtained(*path_components,
+                                     expected_csv_content: str):
+    csv, preview_png = _extract_single_cell(*path_components)
+    allure.attach.file(csv, name='pex_obtained.csv', attachment_type=allure.attachment_type.CSV)
+    allure.attach.file(preview_png, name='📸 layout_preview.png', attachment_type=allure.attachment_type.PNG)
+    expected_csv = csv_diff.load_csv(io.StringIO(expected_csv_content), key='Device')
+    with open(csv, 'r') as f:
+        obtained_csv = csv_diff.load_csv(f, key='Device')
+        diff = csv_diff.compare(expected_csv, obtained_csv, show_unchanged=False)
+        human_diff = csv_diff.human_text(
+            diff, current=obtained_csv, extras=(('Net1','{Net1}'),('Net2','{Net2}'))
+        )
+        allure.attach(expected_csv_content, name='pex_expected.csv', attachment_type=allure.attachment_type.CSV)
+        allure.attach(json.dumps(diff, sort_keys=True, indent='    ').encode("utf8"),
+                      name='pex_diff.json', attachment_type=allure.attachment_type.JSON)
+        allure.attach(human_diff.encode("utf8"), name='‼️ pex_diff.txt', attachment_type=allure.attachment_type.TEXT)
+        # assert diff['added'] == []
+        # assert diff['removed'] == []
+        # assert diff['changed'] == []
+        # assert diff['columns_added'] == []
+        # assert diff['columns_removed'] == []
+        assert human_diff == '', 'Diff detected'
+
+
+@allure.parent_suite(parent_suite)
+@allure.tag(*tags)
+@pytest.mark.slow
+def test_single_plate_100um_x_100um_li1_over_substrate():
+    #_______________________________ NOTE: with halo=8µm __________________________________
+    # C0 PLATE VSUBS 0.38618p
+    assert_expected_matches_obtained(
+        'test_patterns', 'single_plate_100um_x_100um_li1_over_substrate.gds.gz',
+        expected_csv_content="""Device;Net1;Net2;Capacitance [fF]
+Cext_0_1;VSUBS;PLATE;386.18"""
+        )