Merge pull request #304 from SiEPIC/FaML

FaML unit test

klayout/EBeam/DFT.xml

@@ -13,6 +13,7 @@
 			<GC_TM_1550_8degOxide_BB>0</GC_TM_1550_8degOxide_BB>
 			<ebeam_gc_te1550>0</ebeam_gc_te1550>
 			<ebeam_gc_tm1550>0</ebeam_gc_tm1550>
+			<ebeam_dream_FaML_SiN_1550_BB>0</ebeam_dream_FaML_SiN_1550_BB>
 		</gc-orientation>
 	</grating-couplers>
 	<opt_in>

klayout/EBeam/pymacros/pcells_EBeam_Dream/ebeam_dream_FaML_SiN_1550_BB.py

@@ -24,9 +24,9 @@ def __init__(self):
         TECHNOLOGY = get_technology_by_name(self.technology_name)
 
         # declare the parameters
-        self.param("num_channels", self.TypeInt, "Number of Channels (1 - 16)", default = 1)
+        self.param("num_channels", self.TypeInt, "Number of Channels (0 - 16)", default = 2)
 
-        self.param("ref_wg", self.TypeBoolean, "Include reference waveguide", default=True)
+        self.param("ref_wg", self.TypeBoolean, "Include reference waveguide", default=False)
 
         #declare the layers
         self.param("silayer", self.TypeLayer, "Si Layer", default = TECHNOLOGY['SiN'], hidden=False)
@@ -70,8 +70,8 @@ def produce(self, layout, layers, parameters, cell):
         waveguide_type = 'SiN Strip TE 1550 nm, w=750 nm'
         w_waveguide = 750 # nm
 
-        if num_channels < 1:
-            num_channels = 1
+        if num_channels < 0:
+            num_channels = 0
         if num_channels > 16:
             num_channels = 16
 
@@ -107,6 +107,7 @@ def circle(x,y,r):
 
         ##########################################################################################################################################################################
         #draw N tapers
+        x = offset + l_taper + Lw3
         for n_ch in range(int(num_channels)):
 
             #draw the taper
@@ -116,7 +117,6 @@ def circle(x,y,r):
             shapes(LayerBBN).insert(pya.Polygon(taper_pts))
 
             #draw and place pin on the waveguide:
-            x = offset + l_taper + Lw3
             t = pya.Trans(pya.Trans.R0, x, pitch*n_ch)
             pin = pya.Path([pya.Point(-pin_length/2,0),pya.Point(pin_length/2,0)], w_waveguide)
             pin_t = pin.transformed(t)
@@ -132,6 +132,7 @@ def circle(x,y,r):
             shapes(LayerFbrTgtN).insert(pya.Polygon(align_circle))
 
         #draw devrec box
+        n_ch = (num_channels-1)
         if self.ref_wg:
             devrec_pts = [pya.Point(0,pitch*n_ch+30/dbu),pya.Point(x,pitch*n_ch+30/dbu),pya.Point(x,-pitch*2-30/dbu),pya.Point(0,-pitch*2-30/dbu)]
         else:

klayout/EBeam/pymacros/tests/test_FaML.py

@@ -0,0 +1,122 @@
+"""
+Test for FaML
+
+by Lukas Chrostowski 2024
+
+"""
+
+def test_FaML_two():
+    '''
+    --- Simple MZI, tested using Facet-Attached Micro Lenses (FaML) ---
+    
+    by Lukas Chrostowski, 2024
+    
+    Example simple script to
+    - choose the fabrication technology provided by Applied Nanotools,  using silicon nitride (SiN) waveguides
+    - use the SiEPIC-EBeam-PDK technology
+    - using KLayout and SiEPIC-Tools, with function including connect_pins_with_waveguide and connect_cell
+    - create a new layout with a top cell, limited a design area of 1000 microns wide by 410 microns high.
+    - create two Mach-Zehnder Interferometer (MZI) circuits, and one loopback for calibration
+    One Mach-Zehnder has a small path length difference, while the other uses a very long spiral.
+    - export to OASIS for submission to fabrication
+    - display the layout in KLayout using KLive
+    
+    Test plan
+    - count lenses from the bottom up (bottom is 1, top is 6, in this design)
+    - laser input on bottom lens (1), detector on second (2), for alignment
+    - MZI1: laser on 3, detector on 4, sweep
+    - MZI2: laser on 5, detector on 6, sweep
+    
+
+    Use instructions:
+
+    Run in Python, e.g., VSCode
+
+    pip install required packages:
+    - klayout, SiEPIC, siepic_ebeam_pdk, numpy
+
+    '''
+
+    designer_name = 'LukasChrostowski'
+    top_cell_name = 'EBeam_%s_MZI2_FaML' % designer_name
+    export_type = 'static'  # static: for fabrication, PCell: include PCells in file
+    #export_type = 'PCell'  # static: for fabrication, PCell: include PCells in file
+
+    import pya
+
+    import SiEPIC
+    from SiEPIC._globals import Python_Env
+    from SiEPIC.scripts import connect_cell, connect_pins_with_waveguide, zoom_out, export_layout
+    from SiEPIC.utils.layout import new_layout, floorplan, FaML_two
+    from SiEPIC.extend import to_itype
+    from SiEPIC.verification import layout_check
+
+    import os
+
+    if Python_Env == 'Script':
+        # For external Python mode, when installed using pip install siepic_ebeam_pdk
+        import siepic_ebeam_pdk
+
+    print('EBeam_LukasChrostowski_MZI2 layout script')
+
+    tech_name = 'EBeam'
+
+    from packaging import version
+    if version.parse(SiEPIC.__version__) < version.parse("0.5.4"):
+        raise Exception("Errors", "This example requires SiEPIC-Tools version 0.5.4 or greater.")
+
+    '''
+    Create a new layout using the EBeam technology,
+    with a top cell
+    and Draw the floor plan
+    '''    
+    cell, ly = new_layout(tech_name, top_cell_name, GUI=True, overwrite = True)
+    floorplan(cell, 1000e3, 244e3)
+
+    waveguide_type1='SiN Strip TE 1550 nm, w=750 nm'
+    waveguide_type_delay='SiN routing TE 1550 nm (compound waveguide)'
+
+    # Load cells from library
+    cell_ebeam_y = ly.create_cell('ANT_MMI_1x2_te1550_3dB_BB',  'EBeam-SiN')
+    cell_ebeam_delay = ly.create_cell('spiral_paperclip', 'EBeam_Beta',
+                                    {'waveguide_type':waveguide_type_delay,
+                                    'length':319,
+                                    'loops':8,
+                                    'flatten':True})
+
+    #######################
+    # Circuit #2 – MZI, with a very long delay line
+    #######################
+    # draw two edge couplers for facet-attached micro-lenses
+    inst_faml = FaML_two(cell, 
+            label = "opt_in_TE_1550_FaML_mzi2_%s" % designer_name,
+            )    
+    # Y branches:
+    instY2 = connect_cell(inst_faml[0], 'opt1', cell_ebeam_y, 'pin1')
+    instY1 = connect_cell(inst_faml[1], 'opt1', cell_ebeam_y, 'pin1')
+    # Spiral:
+    instSpiral = connect_cell(instY2, 'pin2', cell_ebeam_delay, 'optA')
+    instSpiral.transform(pya.Trans(110e3,50e3))
+    # Waveguides:
+    connect_pins_with_waveguide(instY1, 'pin2', instY2, 'pin3', waveguide_type=waveguide_type1)
+    connect_pins_with_waveguide(instY2, 'pin2', instSpiral, 'optA', waveguide_type=waveguide_type1)
+    connect_pins_with_waveguide(instY1, 'pin3', instSpiral, 'optB', waveguide_type=waveguide_type1,turtle_A=[50,90])
+
+    # Export for fabrication, removing PCells
+    path = os.path.dirname(os.path.realpath(__file__))
+    filename, extension = os.path.splitext(os.path.basename(__file__))
+    if export_type == 'static':
+        file_out = export_layout(cell, path, filename, relative_path = '..', format='oas', screenshot=True)
+    else:
+        file_out = os.path.join(path,'..',filename+'.oas')
+        ly.write(file_out)
+
+    # Verify
+    file_lyrdb = os.path.join(path,filename+'.lyrdb')
+    num_errors = layout_check(cell = cell, verbose=False, GUI=True, file_rdb=file_lyrdb)
+    print('Number of errors: %s' % num_errors)
+    if num_errors > 0:
+        raise Exception ('Errors found in test_FaML_two')
+
+if __name__ == "__main__":
+    test_FaML_two()