v0.1.3

Author: lukasc-ubc

contra_directional_couplers/pyproject.toml

@@ -4,10 +4,14 @@ packages = [
   "siepic_contradc",
 ]
 
+[tool.setuptools.dynamic]
+version = {attr = "siepic_contradc.__version__"}
+
 
 [project]
 name = "siepic_contradc"
-version = "0.1.2"
+#version = "0.1.2"
+dynamic = ["version"]
 authors = [
   { name="Mustafa Hammood", email="mustafastation@gmail.com" },
 ]

contra_directional_couplers/siepic_contradc/ContraDC.py

@@ -1,6 +1,6 @@
 #%%
-from modules import *
-from utils import *
+from .modules import *
+from .utils import *
 
 
 class ContraDC():

contra_directional_couplers/siepic_contradc/Tutorial/__init__.py

@@ -0,0 +1 @@
+from . import examples

contra_directional_couplers/siepic_contradc/Tutorial/examples.py

@@ -9,8 +9,10 @@
 os.environ["QT_QPA_PLATFORM"] = "xcb"  # because lumerical's being weird in linux
 
 # import ContraDC module
-from ContraDC import *
+# from ContraDC import *
 
+from ..ContraDC import ContraDC
+from ..modules import *
 
 def examples(num):
     """ Function implements 4 use-case examples """

contra_directional_couplers/siepic_contradc/__init__.py

@@ -1,3 +1,6 @@
-print("Python package: SiEPIC_ContraDC. ")
-#__version__ = "0.2.0"
+__version__ = "0.1.3"
 
+print("Python package: SiEPIC_ContraDC, v%s" % __version__)
+
+
+from . import ContraDC, modules, utils

contra_directional_couplers/siepic_contradc/utils.py

@@ -5,7 +5,7 @@
     jonathan.cauchon.2@ulaval.ca
 """
 
-from modules import *
+from .modules import *
 
 """
     Basic

example.py

@@ -0,0 +1,6 @@
+
+import siepic_contradc
+import siepic_contradc.ContraDC as ContraDC
+from siepic_contradc import Tutorial
+Tutorial.examples.examples(1)
+

examples.py

@@ -0,0 +1,132 @@
+
+import siepic_contradc
+from siepic_contradc.ContraDC import ContraDC
+from siepic_contradc.modules import *
+
+
+def examples(num):
+    """ Function implements 4 use-case examples """
+
+    """ Example 1: regular SOI Contra-DC """
+    if num ==1:
+
+        # instantiate, simulate and show result
+        device = ContraDC().simulate().displayResults()
+
+        # calculate thimpe group delay
+        device.getGroupDelay()
+
+        # plot group delay
+        plt.figure()
+        plt.plot(device.wavelength*1e9, device.group_delay*1e12)
+        plt.xlabel("Wavelength (nm)")
+        plt.ylabel("Tg (ps)")
+
+        plt.show()
+
+
+
+    """ Example 2: Full chirped example.
+        Create a CDC with chirped w1, w2, period, temperature.
+    """
+    if num == 2:
+    
+        # Waveguide chirp
+        w1 = [.56e-6, .56e-6]
+        w2 = [.44e-6, .44e-6]
+        w_chirp_step = .1e-9
+
+        # Period chirp
+        period = [310e-9, 320e-9]
+        
+
+        # apod shape
+        apod_shape = "gaussian"
+
+        N = 10000
+
+        device = ContraDC(N=N, w1=w1, w2=w2, apod_shape=apod_shape, period_chirp_step=1e-9,
+                         w_chirp_step=w_chirp_step, period=period, N_seg=1500,
+                         kappa = 10000, a=0, alpha=1.5, wvl_range=[1500e-9,1600e-9])
+
+        device.simulate().displayResults()
+
+
+
+    """ Example 3: defining custom chirp profiles
+    """
+    if num == 3:
+
+        device = ContraDC(apod_shape="tanh")
+
+        z = np.linspace(0, device.N_seg, device.N_seg)
+        device.w1_profile = device.w1*np.cos(z/600)
+        device.w2_profile = device.w2*np.cos(z/600)
+
+        device.simulate().displayResults()
+
+
+
+    """ Example 4: using custom supermode indices.
+        You might want to use this if you are designing 
+        with silicon nitride, of using other waveguide specs than
+        SOI, 100-nm gap.
+    """
+    if num == 4:
+
+        import os
+        current_dir = os.path.dirname(__file__)
+        polyfit_file_path = os.path.join(current_dir, "SiN_1550_TE_w1_850nm_w2_1150nm_thickness_400nm.txt")
+        device = ContraDC(polyfit_file=polyfit_file_path, period=335e-9)
+        device.simulate().displayResults()
+
+
+
+    """Example 5: Lumerical-assisted flow
+    """
+    if num == 5:
+
+        apod_shape = "tanh"
+        period = 318e-9
+        w1 = 560e-9
+        w2 = 440e-9
+
+        device = ContraDC(w1= w1, w2=w2, apod_shape=apod_shape, period=period)
+
+        device.simulate()
+        plt.plot(device.wavelength*1e9, device.drop)
+        plt.plot(device.wavelength*1e9, device.thru)
+        plt.show()
+
+        # Generate compact model for Lumerical INTERCONNECT
+        device.gen_sparams() # this will create a ContraDC_sparams.dat file to import into INTC
+
+    """Example 6: Complete Lumerical flow - simulate coupling coefficient (not simulating mode profiles)
+    """
+    if num == 6:
+
+        apod_shape = "tanh"
+        period = 318e-9
+        w1 = 560e-9
+        dw1 = 25e-9
+        w2 = 440e-9
+        dw2 = 50e-9
+        gap = 100e-9
+
+        device = ContraDC(w1= w1, dw1=dw1, w2=w2, dw2=dw2, gap=gap, apod_shape=apod_shape, period=period)
+
+        device.simulate_kappa()
+        device.simulate().displayResults()
+        plt.plot(device.wavelength*1e9, device.drop)
+        plt.plot(device.wavelength*1e9, device.thru)
+        plt.show()
+
+        # Generate compact model for Lumerical INTERCONNECT
+        device.gen_sparams() # this will create a ContraDC_sparams.dat file to import into INTC
+
+
+if __name__ == "__main__":
+    examples(3)
+
+
+