From 62282ab63fbf96e0b1d628295e01a2aeb3817d74 Mon Sep 17 00:00:00 2001
From: daquintero <darioaquintero@gmail.com>
Date: Wed, 29 May 2024 18:16:24 +0200
Subject: [PATCH] added hdl21 netlisting functions, generating yaml

---
 .idea/gplugins.iml                            |   7 +-
 .idea/misc.xml                                |   2 +-
 .idea/workspace.xml                           |  34 +--
 gplugins/hdl21/__init__.py                    |   1 +
 gplugins/hdl21/netlist.py                     |   5 +-
 ...ky130nm_inverter_schematic_to_layout.ipynb | 282 ------------------
 6 files changed, 28 insertions(+), 303 deletions(-)
 delete mode 100644 notebooks/20_sky130nm_inverter_schematic_to_layout.ipynb

diff --git a/.idea/gplugins.iml b/.idea/gplugins.iml
index 184859bd..d3e16142 100644
--- a/.idea/gplugins.iml
+++ b/.idea/gplugins.iml
@@ -1,5 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<module version="4">
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="jdk" jdkName="Python 3.10 (gplugins_spice)" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
   <component name="PyDocumentationSettings">
     <option name="format" value="PLAIN" />
     <option name="myDocStringFormat" value="Plain" />
diff --git a/.idea/misc.xml b/.idea/misc.xml
index 3d16407b..422dcfb2 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -3,5 +3,5 @@
   <component name="Black">
     <option name="sdkName" value="Python 3.10 (spmc) (2)" />
   </component>
-  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.10 (spmc) (2)" project-jdk-type="Python SDK" />
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.10 (gplugins_spice)" project-jdk-type="Python SDK" />
 </project>
\ No newline at end of file
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index fd866dcf..dec9c55a 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -5,13 +5,12 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="5d553873-efb1-4cb1-a426-473adb5931ef" name="Changes" comment="">
-      <change afterPath="$PROJECT_DIR$/gplugins/hdl21/__init__.py" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/gplugins/hdl21/netlist.py" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/.idea/gplugins.iml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/gplugins.iml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/misc.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/misc.xml" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.python-version" beforeDir="false" afterPath="$PROJECT_DIR$/.python-version" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/notebooks/20_sky130nm_inverter_schematic_to_layout.ipynb" beforeDir="false" afterPath="$PROJECT_DIR$/notebooks/20_sky130nm_inverter_schematic_to_layout.ipynb" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/pyproject.toml" beforeDir="false" afterPath="$PROJECT_DIR$/pyproject.toml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/gplugins/hdl21/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/gplugins/hdl21/__init__.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/gplugins/hdl21/netlist.py" beforeDir="false" afterPath="$PROJECT_DIR$/gplugins/hdl21/netlist.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/notebooks/20_sky130nm_inverter_schematic_to_layout.ipynb" beforeDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -30,18 +29,19 @@
     <option name="hideEmptyMiddlePackages" value="true" />
     <option name="showLibraryContents" value="true" />
   </component>
-  <component name="PropertiesComponent">{
-  &quot;keyToString&quot;: {
-    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
-    &quot;git-widget-placeholder&quot;: &quot;demo__spice__layout&quot;,
-    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
-    &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
-    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
-    &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
-    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
-    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "RunOnceActivity.ShowReadmeOnStart": "true",
+    "git-widget-placeholder": "demo__spice__layout",
+    "node.js.detected.package.eslint": "true",
+    "node.js.detected.package.tslint": "true",
+    "node.js.selected.package.eslint": "(autodetect)",
+    "node.js.selected.package.tslint": "(autodetect)",
+    "nodejs_package_manager_path": "npm",
+    "settings.editor.selected.configurable": "com.jetbrains.python.configuration.PyActiveSdkModuleConfigurable",
+    "vue.rearranger.settings.migration": "true"
   }
-}</component>
+}]]></component>
   <component name="SharedIndexes">
     <attachedChunks>
       <set>
@@ -62,7 +62,7 @@
       <workItem from="1716393110315" duration="12987000" />
       <workItem from="1716810498661" duration="94000" />
       <workItem from="1716995548365" duration="593000" />
-      <workItem from="1716996148003" duration="2112000" />
+      <workItem from="1716996148003" duration="3186000" />
     </task>
     <servers />
   </component>
diff --git a/gplugins/hdl21/__init__.py b/gplugins/hdl21/__init__.py
index e69de29b..99e41f0d 100644
--- a/gplugins/hdl21/__init__.py
+++ b/gplugins/hdl21/__init__.py
@@ -0,0 +1 @@
+from .netlist import *
\ No newline at end of file
diff --git a/gplugins/hdl21/netlist.py b/gplugins/hdl21/netlist.py
index e39d30eb..d09bfceb 100644
--- a/gplugins/hdl21/netlist.py
+++ b/gplugins/hdl21/netlist.py
@@ -70,7 +70,7 @@ def parse_connections(proto_dict: ParsedProtoVLSIR) -> dict:
                 target_signal = connection['target'][0]['sig']
                 connection_key = f"{instance_name},{portname}"
                 # Find the target instance and port
-                target_instance_port = find_target_instance_port(data, target_signal, instance_name)
+                target_instance_port = find_target_instance_port(proto_dict, target_signal, instance_name)
                 if target_instance_port:
                     connections[connection_key] = target_instance_port
 
@@ -231,7 +231,8 @@ def generate_raw_netlist_from_module(module: h.module):
 
 def generate_raw_yaml_from_module(module: h.module):
     """
-    Generate a raw netlist yaml from a hdl21 module object.
+    Generate a raw netlist yaml from a hdl21 module object which could be manually edited for specific instances
+    related to the corresponding SPICE.
     """
     raw_netlist = generate_raw_netlist_from_module(module)
     return yaml.dump(raw_netlist, default_flow_style=False)
\ No newline at end of file
diff --git a/notebooks/20_sky130nm_inverter_schematic_to_layout.ipynb b/notebooks/20_sky130nm_inverter_schematic_to_layout.ipynb
deleted file mode 100644
index 27ddd056..00000000
--- a/notebooks/20_sky130nm_inverter_schematic_to_layout.ipynb
+++ /dev/null
@@ -1,282 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "0",
-   "metadata": {},
-   "source": [
-    "# SkyWater Inverter Design using GPlugins\n",
-    "\n",
-    "The goal of this notebook is to demonstrate the integration of the `sky130nm` electronic PDK within a gdsfactory-based schematic driven layout. Broadly, we will explore:\n",
-    "\n",
-    "* A little introduction at setting up the existing open-source electronic EDA development flow with `xschem` using the latest `sky130nm` library\n",
-    "* Exporting that schematic into a SPICE model, which is used to schematic-driven-layout using gdsfactory.\n",
-    "* Example inverter design and layout between the toolsets."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "48a27c54-cf93-4979-87d9-624d87c8b6ef",
-   "metadata": {},
-   "source": [
-    "## Using the `gdsfactory-sky130nm` Repository"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ea5196e7-c9c6-43ee-9acc-c099e76ff58d",
-   "metadata": {},
-   "source": [
-    "The goal of this notebook is to show that analogue simulation and layout can be performed together within a `gdsfactory` environment."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "f67a9184-6c64-4ecb-bbeb-a53ae00004b6",
-   "metadata": {},
-   "source": [
-    "```\n",
-    "pip install gplugins[hdl21,sky130]\n",
-    "```"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "de32447b-b13b-4b96-8642-809af933f9f8",
-   "metadata": {},
-   "outputs": [
-    {
-     "ename": "ModuleNotFoundError",
-     "evalue": "No module named 'sky130'",
-     "output_type": "error",
-     "traceback": [
-      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
-      "\u001b[0;31mModuleNotFoundError\u001b[0m                       Traceback (most recent call last)",
-      "Cell \u001b[0;32mIn[1], line 2\u001b[0m\n\u001b[1;32m      1\u001b[0m \u001b[38;5;28;01mimport\u001b[39;00m \u001b[38;5;21;01mgdsfactory\u001b[39;00m \u001b[38;5;28;01mas\u001b[39;00m \u001b[38;5;21;01mgf\u001b[39;00m\n\u001b[0;32m----> 2\u001b[0m \u001b[38;5;28;01mimport\u001b[39;00m \u001b[38;5;21;01msky130\u001b[39;00m\n\u001b[1;32m      3\u001b[0m \u001b[38;5;28;01mimport\u001b[39;00m \u001b[38;5;21;01msky130_hdl21\u001b[39;00m\n",
-      "\u001b[0;31mModuleNotFoundError\u001b[0m: No module named 'sky130'"
-     ]
-    }
-   ],
-   "source": [
-    "import gdsfactory as gf\n",
-    "import gplugins.hdl21 as gph\n",
-    "import sky130\n",
-    "import sky130_hdl21"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "c74ced51-2ea8-41ab-b776-12a35d8916e3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "@h.module\n",
-    "class SkyInv:\n",
-    "    \"\"\" An inverter, demonstrating using PDK modules \"\"\"\n",
-    "\n",
-    "    # Create some IO\n",
-    "    i, o, VDD, VSS = h.Ports(4)\n",
-    "\n",
-    "    p = sky130_hdl21.Sky130MosParams(w=1,l=1)\n",
-    "\n",
-    "    # And create some transistors!\n",
-    "    ps = sky130_hdl21.primitives.PMOS_1p8V_STD(p)(d=o, g=i, s=VDD, b=VDD)\n",
-    "    ns = sky130_hdl21.primitives.NMOS_1p8V_STD(p)(d=o, g=i, s=VSS, b=VSS)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1c2d2fee-a7df-4e91-bd00-dede08102496",
-   "metadata": {},
-   "source": [
-    "## Setting up the required tools: `xschem`, `volare` and the `sky130nm` PDKs\n",
-    "\n",
-    "I will say early on, you would benefit from working in a UNIX or Debian Linux environment. Most EDA tools either proprietary or open-source only work within these operating systems or a Docker environment of these operating systems.\n",
-    "\n",
-    "There are multiple ways to get started with the environment, you could, for example:\n",
-    "1. Work within a [IIC-OSIC-TOOLS docker environment](https://github.com/iic-jku/IIC-OSIC-TOOLS). There is also a nice [OSIC-multitool project](https://github.com/iic-jku/osic-multitool) specifically for SKY130nm designs.\n",
-    "2. Install these tools natively in your operating system. You could follow one of these tutorials, for example:\n",
-    "    * https://www.engineerwikis.com/wikis/installation-of-xschem\n",
-    "    * https://www.youtube.com/watch?v=jXmmxO8WG8s&t=7s\n",
-    "\n",
-    "This tutorial assumes the tools have already been installed in a local operating system. We will use some design files generated by these toolsets as guided by this [OSIC-Multitool example](https://github.com/iic-jku/osic-multitool/tree/main/example/ana). Note we recommend cloning the `gplugins` repository."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "1",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import pathlib\n",
-    "from gplugins.spice import parse_netlist as spice"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2",
-   "metadata": {},
-   "source": [
-    "Our example files are under the directory of `gplugins/notebooks/data`, let's extract our SPICE declaration:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def read_file(file_path):\n",
-    "    try:\n",
-    "        with open(file_path, 'r') as file:\n",
-    "            text = file.read()\n",
-    "        return text\n",
-    "    except FileNotFoundError:\n",
-    "        print(\"File not found. Please provide a valid file path.\")\n",
-    "        return None"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "4",
-   "metadata": {},
-   "source": [
-    "Let's list the files we're going to be reading into:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "inverter_spice_file = pathlib.Path(\"data\") / \"sky130nm\" / \"inv.sch\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "6",
-   "metadata": {},
-   "source": [
-    "Let's extract our raw spice netlist. An important aspect to understand is that unfortunately, every SPICE tool developed their own file format. So in this sense, netlist parsing function is implemented according to the type of spice toolset that has generated this netlist.\n",
-    "\n",
-    "We aim to support:\n",
-    "\n",
-    "- `xschem`\n",
-    "- `lumerical?`"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "inverter_spice_text = read_file(inverter_spice_file)\n",
-    "inverter_spice_text"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "spice.netlist_text"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "elements, _, _ = spice.parse_netlist_and_extract_elements(netlist_text=spice.netlist_text, spice_type=\"lumerical\")\n",
-    "elements"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "10",
-   "metadata": {},
-   "source": [
-    "So we can use our `netlist` parsing function to convert this to a compatible netlist for gdsfactory plugins into the extracted elements and the extracted connections:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "11",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "inverter_netlist_elements, inverter_netlist_connections, _ = spice.parse_netlist_and_extract_elements(netlist_text=inverter_spice_text, spice_type=\"xschem\")\n",
-    "inverter_netlist_elements, inverter_netlist_connections, _"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "12",
-   "metadata": {},
-   "source": [
-    "### Automated schematic-driven-layout"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "13",
-   "metadata": {},
-   "source": [
-    "We have now extracted our spice elements and our connectivity. Let's explore what we have there:"
-   ]
-  },
-  {
-   "cell_type": "raw",
-   "id": "14",
-   "metadata": {},
-   "source": [
-    "# Current TODOs\n",
-    "\n",
-    "1. Update the extraction function to add xschem compatibility.\n",
-    "2. Create the mapping between the extracted netlist and the corresponding SKY130nm elements."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "15",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.10.13"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}