Merge pull request #334 from chetanya-goyal/main

refactor folder structure in blocks directory

.github/scripts/test_glayout_ci.py

@@ -3,11 +3,11 @@
     __import__('glayout')
 except ImportError:
     sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))) 
-from glayout.flow.blocks.opamp import opamp 
-from glayout.flow.blocks.diff_pair  import diff_pair
+from glayout.flow.blocks.composite.opamp import opamp 
+from glayout.flow.blocks.elementary.diff_pair  import diff_pair
 from glayout.flow.primitives.fet import nmos, pmos
 from glayout.flow.pdk.sky130_mapped import sky130_mapped_pdk 
-from glayout.flow.blocks.current_mirror import current_mirror
+from glayout.flow.blocks.elementary.current_mirror import current_mirror
 import json
 import numpy as np
 import shutil

docs/source/notebooks/glayout/GLayout_Cells.ipynb

@@ -409,7 +409,7 @@
       },
       "outputs": [],
       "source": [
-        "from glayout.flow.blocks.diff_pair import diff_pair\n",
+        "from glayout.flow.blocks.elementary.diff_pair import diff_pair\n",
         "# Used to display the results in a grid (notebook only)\n",
         "left = widgets.Output()\n",
         "leftSPICE = widgets.Output()\n",
@@ -455,7 +455,7 @@
       },
       "outputs": [],
       "source": [
-        "from glayout.flow.blocks.differential_to_single_ended_converter import differential_to_single_ended_converter\n",
+        "from glayout.flow.blocks.composite.differential_to_single_ended_converter import differential_to_single_ended_converter\n",
         "# Used to display the results in a grid (notebook only)\n",
         "left = widgets.Output()\n",
         "leftSPICE = widgets.Output()\n",
@@ -532,7 +532,7 @@
       },
       "outputs": [],
       "source": [
-        "from glayout.flow.blocks.opamp import opamp\n",
+        "from glayout.flow.blocks.composite.opamp import opamp\n",
         "\n",
         "# Select which PDK to use\n",
         "pdk = sky130\n",

docs/source/notebooks/glayout/glayout_opamp.ipynb

@@ -487,7 +487,7 @@
       },
       "outputs": [],
       "source": [
-        "from glayout.flow.blocks.opamp import opamp\n",
+        "from glayout.flow.blocks.composite.opamp import opamp\n",
         "\n",
         "# Select which PDK to use\n",
         "pdk = sky130\n",

openfasoc/generators/glayout/glayout/flow/blocks/__init__.py

@@ -0,0 +1,2 @@
+from glayout.flow.blocks.composite import *
+from glayout.flow.blocks.elementary import *

openfasoc/generators/glayout/glayout/flow/blocks/cross_coupled_inverter/CrossCoupledInverters_cell.py → openfasoc/generators/glayout/glayout/flow/blocks/composite/cross_coupled_inverter/CrossCoupledInverters_cell.py

@@ -19,7 +19,7 @@
 from glayout.flow.placement.two_transistor_interdigitized import two_nfet_interdigitized
 from glayout.flow.placement.four_transistor_interdigitized import generic_4T_interdigitzed
 from glayout.flow.placement.two_transistor_interdigitized import two_pfet_interdigitized
-from glayout.flow.blocks.diff_pair import diff_pair_generic
+from glayout.flow.blocks.elementary.diff_pair import diff_pair_generic
 from glayout.flow.routing.smart_route import smart_route
 from glayout.flow.routing.L_route import L_route
 from glayout.flow.routing.c_route import c_route

openfasoc/generators/glayout/glayout/flow/blocks/composite/differential_to_single_ended_converter/__init__.py

@@ -0,0 +1 @@
+from .differential_to_single_ended_converter import differential_to_single_ended_converter, differential_to_single_ended_converter_netlist

openfasoc/generators/glayout/glayout/flow/blocks/differential_to_single_ended_converter/differential_to_single_ended_converter.py → openfasoc/generators/glayout/glayout/flow/blocks/composite/differential_to_single_ended_converter/differential_to_single_ended_converter.py

@@ -4,7 +4,7 @@
 from gdsfactory.components.rectangle import rectangle
 from glayout.flow.pdk.mappedpdk import MappedPDK
 from typing import Optional, Union
-from glayout.flow.blocks.diff_pair import diff_pair
+from glayout.flow.blocks.elementary.diff_pair.diff_pair import diff_pair
 from glayout.flow.primitives.fet import nmos, pmos, multiplier
 from glayout.flow.primitives.guardring import tapring
 from glayout.flow.primitives.mimcap import mimcap_array, mimcap

openfasoc/generators/glayout/glayout/flow/blocks/composite/diffpair_cmirror_bias/__init__.py

@@ -0,0 +1 @@
+from .diff_pair_cmirrorbias import diff_pair_ibias, diff_pair_ibias_netlist

openfasoc/generators/glayout/glayout/flow/blocks/diffpair_cmirror_bias/diff_pair_cmirrorbias.py → openfasoc/generators/glayout/glayout/flow/blocks/composite/diffpair_cmirror_bias/diff_pair_cmirrorbias.py

@@ -4,7 +4,7 @@
 from gdsfactory.components.rectangle import rectangle
 from glayout.flow.pdk.mappedpdk import MappedPDK
 from typing import Optional, Union
-from glayout.flow.blocks.diff_pair import diff_pair
+from glayout.flow.blocks.elementary.diff_pair import diff_pair
 from glayout.flow.primitives.fet import nmos, pmos, multiplier
 from glayout.flow.primitives.guardring import tapring
 from glayout.flow.primitives.mimcap import mimcap_array, mimcap
@@ -36,7 +36,7 @@
 from pydantic import validate_arguments
 from glayout.flow.placement.two_transistor_interdigitized import two_nfet_interdigitized
 from glayout.flow.spice import Netlist
-from glayout.flow.blocks.current_mirror import current_mirror_netlist
+from glayout.flow.blocks.elementary.current_mirror import current_mirror_netlist
 
 def diff_pair_ibias_netlist(center_diffpair: Component, current_mirror: Component, antenna_diode: Optional[Component] = None) -> Netlist:
     netlist = Netlist(

openfasoc/generators/glayout/glayout/flow/blocks/composite/opamp/__init__.py

@@ -0,0 +1,2 @@
+from glayout.flow.blocks.composite.opamp.opamp import opamp, opamp_netlist
+from glayout.flow.blocks.composite.opamp.diff_pair_stackedcmirror import diff_pair_stackedcmirror

openfasoc/generators/glayout/glayout/flow/blocks/opamp/diff_pair_stackedcmirror.py → openfasoc/generators/glayout/glayout/flow/blocks/composite/opamp/diff_pair_stackedcmirror.py

@@ -4,7 +4,7 @@
 from gdsfactory.components.rectangle import rectangle
 from glayout.flow.pdk.mappedpdk import MappedPDK
 from typing import Optional, Union
-from glayout.flow.blocks.diff_pair import diff_pair
+from glayout.flow.blocks.elementary.diff_pair import diff_pair
 from glayout.flow.primitives.fet import nmos, pmos, multiplier
 from glayout.flow.primitives.guardring import tapring
 from glayout.flow.primitives.mimcap import mimcap_array, mimcap
@@ -19,10 +19,10 @@
 from pydantic import validate_arguments
 from glayout.flow.placement.two_transistor_interdigitized import two_nfet_interdigitized
 
-from glayout.flow.blocks.diffpair_cmirror_bias import diff_pair_ibias
-from glayout.flow.blocks.stacked_current_mirror import stacked_nfet_current_mirror
-from glayout.flow.blocks.differential_to_single_ended_converter import differential_to_single_ended_converter
-from glayout.flow.blocks.opamp.row_csamplifier_diff_to_single_ended_converter import row_csamplifier_diff_to_single_ended_converter
+from glayout.flow.blocks.composite.diffpair_cmirror_bias import diff_pair_ibias
+from glayout.flow.blocks.composite.stacked_current_mirror import stacked_nfet_current_mirror
+from glayout.flow.blocks.composite.differential_to_single_ended_converter import differential_to_single_ended_converter
+from glayout.flow.blocks.composite.opamp.row_csamplifier_diff_to_single_ended_converter import row_csamplifier_diff_to_single_ended_converter
 
 
 @validate_arguments

openfasoc/generators/glayout/glayout/flow/blocks/opamp/opamp.py → openfasoc/generators/glayout/glayout/flow/blocks/composite/opamp/opamp.py

@@ -5,7 +5,7 @@
 from glayout.flow.pdk.mappedpdk import MappedPDK
 from typing import Optional, Union
 from glayout.flow.primitives.fet import nmos, pmos, multiplier
-from glayout.flow.blocks.diff_pair import diff_pair
+from glayout.flow.blocks.elementary.diff_pair import diff_pair
 from glayout.flow.primitives.guardring import tapring
 from glayout.flow.primitives.mimcap import mimcap_array, mimcap
 from glayout.flow.routing.L_route import L_route
@@ -20,8 +20,8 @@
 from glayout.flow.placement.two_transistor_interdigitized import two_nfet_interdigitized
 from glayout.flow.spice import Netlist
 
-from glayout.flow.blocks.opamp.opamp_twostage import opamp_twostage
-from glayout.flow.blocks.current_mirror import current_mirror_netlist
+from glayout.flow.blocks.composite.opamp.opamp_twostage import opamp_twostage
+from glayout.flow.blocks.elementary.current_mirror import current_mirror_netlist
 
 def opamp_output_stage_netlist(pdk: MappedPDK, output_amp_fet_ref: ComponentReference, biasParams: list) -> Netlist:
     bias_netlist = current_mirror_netlist(pdk, biasParams[0], biasParams[1], biasParams[2])

openfasoc/generators/glayout/glayout/flow/blocks/opamp/opamp_twostage.py → openfasoc/generators/glayout/glayout/flow/blocks/composite/opamp/opamp_twostage.py

@@ -5,7 +5,7 @@
 from glayout.flow.pdk.mappedpdk import MappedPDK
 from typing import Optional, Union
 from glayout.flow.primitives.fet import nmos, pmos, multiplier
-from glayout.flow.blocks.diff_pair import diff_pair
+from glayout.flow.blocks.elementary.diff_pair import diff_pair
 from glayout.flow.primitives.guardring import tapring
 from glayout.flow.primitives.mimcap import mimcap_array, mimcap
 from glayout.flow.routing.L_route import L_route
@@ -19,13 +19,13 @@
 from pydantic import validate_arguments
 from glayout.flow.placement.two_transistor_interdigitized import two_nfet_interdigitized
 
-from glayout.flow.blocks.diffpair_cmirror_bias import diff_pair_ibias
-from glayout.flow.blocks.stacked_current_mirror import stacked_nfet_current_mirror
-from glayout.flow.blocks.differential_to_single_ended_converter import differential_to_single_ended_converter
-from glayout.flow.blocks.opamp.row_csamplifier_diff_to_single_ended_converter import row_csamplifier_diff_to_single_ended_converter
-from glayout.flow.blocks.opamp.diff_pair_stackedcmirror import diff_pair_stackedcmirror
+from glayout.flow.blocks.composite.diffpair_cmirror_bias import diff_pair_ibias
+from glayout.flow.blocks.composite.stacked_current_mirror import stacked_nfet_current_mirror
+from glayout.flow.blocks.composite.differential_to_single_ended_converter import differential_to_single_ended_converter
+from glayout.flow.blocks.composite.opamp.row_csamplifier_diff_to_single_ended_converter import row_csamplifier_diff_to_single_ended_converter
+from glayout.flow.blocks.composite.opamp.diff_pair_stackedcmirror import diff_pair_stackedcmirror
 from glayout.flow.spice import Netlist
-from glayout.flow.blocks.current_mirror import current_mirror_netlist
+from glayout.flow.blocks.elementary.current_mirror import current_mirror_netlist
 
 @validate_arguments
 def __create_and_route_pins(

openfasoc/generators/glayout/glayout/flow/blocks/opamp/row_csamplifier_diff_to_single_ended_converter.py → openfasoc/generators/glayout/glayout/flow/blocks/composite/opamp/row_csamplifier_diff_to_single_ended_converter.py

@@ -5,7 +5,7 @@
 from glayout.flow.pdk.mappedpdk import MappedPDK
 from typing import Optional, Union
 from glayout.flow.primitives.fet import nmos, pmos, multiplier
-from glayout.flow.blocks.diff_pair import diff_pair
+from glayout.flow.blocks.elementary.diff_pair import diff_pair
 from glayout.flow.primitives.guardring import tapring
 from glayout.flow.primitives.mimcap import mimcap_array, mimcap
 from glayout.flow.routing.L_route import L_route

openfasoc/generators/glayout/glayout/flow/blocks/composite/stacked_current_mirror/__init__.py

@@ -0,0 +1 @@
+from .stacked_current_mirror import stacked_nfet_current_mirror 

openfasoc/generators/glayout/glayout/flow/blocks/stacked_current_mirror/stacked_current_mirror.py → openfasoc/generators/glayout/glayout/flow/blocks/composite/stacked_current_mirror/stacked_current_mirror.py

@@ -5,7 +5,7 @@
 from glayout.flow.pdk.mappedpdk import MappedPDK
 from typing import Optional, Union
 from glayout.flow.primitives.fet import nmos, pmos, multiplier
-from glayout.flow.blocks.diff_pair import diff_pair
+from glayout.flow.blocks.elementary.diff_pair import diff_pair
 from glayout.flow.primitives.guardring import tapring
 from glayout.flow.primitives.mimcap import mimcap_array, mimcap
 from glayout.flow.routing.L_route import L_route

openfasoc/generators/glayout/glayout/flow/blocks/elementary/current_mirror/__init__.py

@@ -0,0 +1 @@
+from glayout.flow.blocks.elementary.current_mirror.current_mirror import current_mirror, current_mirror_netlist

openfasoc/generators/glayout/glayout/flow/blocks/elementary/diff_pair/__init__.py

@@ -0,0 +1 @@
+from glayout.flow.blocks.elementary.diff_pair.diff_pair import diff_pair, diff_pair_generic, diff_pair_netlist

openfasoc/generators/glayout/glayout/syntaxer/nltk_init_deps.py

@@ -17,3 +17,4 @@ def check_and_download_nltk_data(data_name):
 
 
 check_and_download_nltk_data("punkt")
+check_and_download_nltk_data("punkt_tab")

openfasoc/generators/glayout/glayout/syntaxer/relational.py

@@ -716,7 +716,7 @@ def __init__(self, toplvl_name: str):
         two_pfet_interdigitized_aliases = list_cartesian_product(["interdigitized","interdigitated"],["pmos","pfet"],True)
         self.update_import_table(two_pfet_interdigitized_aliases,"two_pfet_interdigitized","glayout.flow.placement.two_transistor_interdigitized")
         self.update_import_table(["common centroid"],"common_centroid_ab_ba","glayout.flow.placement.common_centroid_ab_ba")
-        self.update_import_table(["diff pair","diff_pair","differential pair","differential pairs","differential transistor"],"diff_pair_generic","glayout.flow.blocks.diff_pair")
+        self.update_import_table(["diff pair","diff_pair","differential pair","differential pairs","differential transistor"],"diff_pair_generic","glayout.flow.blocks.elementary.diff_pair")
         # import routing funcs
         self.update_import_table(["smart route","smart","smart_route"],"smart_route","glayout.flow.routing.smart_route")
         self.update_import_table(["L route","L_route","l route","l_route"],"L_route","glayout.flow.routing.L_route")

openfasoc/generators/glayout/tapeout/tapeout_and_RL/sky130_nist_tapeout.py

@@ -9,7 +9,7 @@
 from glayout.flow.pdk.util.port_utils import add_ports_perimeter, print_ports
 from gdsfactory.component import Component
 from glayout.flow.pdk.mappedpdk import MappedPDK
-from glayout.flow.blocks.opamp import opamp
+from glayout.flow.blocks.composite.opamp import opamp
 from glayout.flow.routing.L_route import L_route
 from glayout.flow.routing.straight_route import straight_route
 from glayout.flow.routing.c_route import c_route