diff --git a/.gitea/workflows/build_relase.yaml b/.gitea/workflows/build_relase.yaml new file mode 100644 index 0000000..bf55f88 --- /dev/null +++ b/.gitea/workflows/build_relase.yaml @@ -0,0 +1,67 @@ +name: Build and Release mxPIC Wheels + +# This tells GitHub to ONLY run this pipeline when you push a version tag (e.g., v1.0.0) +on: + release: + types: [published] + +jobs: + # --- JOB 1: THE COMPILER --- + build-wheels: + name: Build on ${{ matrix.os }} + # The matrix allows us to build for Windows and Linux simultaneously! + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ubuntu-latest, windows-latest] + python-version: ['3.10'] + + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + + - name: Install Build Dependencies + # Install the tools required by our custom build_wheel.py script + run: | + python -m pip install --upgrade pip + pip install build wheel mypy Cython setuptools + + - name: Run Auto-Builder (Compiles C-extensions & Injects .pyi) + run: python build_wheel.py + + - name: Temporarily Store the Built Wheel + uses: actions/upload-artifact@v4 + with: + name: mxpic-wheels-${{ matrix.os }} + path: dist/*.whl + retention-days: 1 + + # --- JOB 2: THE RELEASER --- + create-release: + name: Publish to GitHub Releases + needs: build-wheels # Waits for both Windows and Linux to finish + runs-on: ubuntu-latest + permissions: + contents: write # Required to allow the bot to create a release page + + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Download all OS Wheels + uses: actions/download-artifact@v4 + with: + pattern: mxpic-wheels-* + path: dist + merge-multiple: true + + - name: Upload Assets to Gitea Release + uses: softprops/action-gh-release@v1 + with: + files: "dist/*.whl" + api_key: ${{ secrets.GITEA_TOKEN }} \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..7adfd3b --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +recursive-include mxpic *.pyi \ No newline at end of file diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/basic.cp39-win_amd64.exp b/build/temp.win-amd64-cpython-39/Release/mxpic/basic.cp39-win_amd64.exp deleted file mode 100644 index 8a90129..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/basic.cp39-win_amd64.exp and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/basic.cp39-win_amd64.lib b/build/temp.win-amd64-cpython-39/Release/mxpic/basic.cp39-win_amd64.lib deleted file mode 100644 index 84a4998..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/basic.cp39-win_amd64.lib and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/basic.obj b/build/temp.win-amd64-cpython-39/Release/mxpic/basic.obj deleted file mode 100644 index 8228b3e..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/basic.obj and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/directional_couplers/directional_couplers.cp39-win_amd64.exp b/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/directional_couplers/directional_couplers.cp39-win_amd64.exp deleted file mode 100644 index 396c5fa..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/directional_couplers/directional_couplers.cp39-win_amd64.exp and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/directional_couplers/directional_couplers.cp39-win_amd64.lib b/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/directional_couplers/directional_couplers.cp39-win_amd64.lib deleted file mode 100644 index a47fa35..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/directional_couplers/directional_couplers.cp39-win_amd64.lib and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/directional_couplers/directional_couplers.obj b/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/directional_couplers/directional_couplers.obj deleted file mode 100644 index 6f812b5..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/directional_couplers/directional_couplers.obj and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.cp39-win_amd64.exp b/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.cp39-win_amd64.exp deleted file mode 100644 index 2e28ff4..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.cp39-win_amd64.exp and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.cp39-win_amd64.lib b/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.cp39-win_amd64.lib deleted file mode 100644 index 4c74f0e..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.cp39-win_amd64.lib and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.obj b/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.obj deleted file mode 100644 index 3ce4bbe..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.obj and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/grating_couplers/grating_couplers.cp39-win_amd64.exp b/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/grating_couplers/grating_couplers.cp39-win_amd64.exp deleted file mode 100644 index e665c88..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/grating_couplers/grating_couplers.cp39-win_amd64.exp and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/grating_couplers/grating_couplers.cp39-win_amd64.lib b/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/grating_couplers/grating_couplers.cp39-win_amd64.lib deleted file mode 100644 index 9ac0e24..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/grating_couplers/grating_couplers.cp39-win_amd64.lib and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/grating_couplers/grating_couplers.obj b/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/grating_couplers/grating_couplers.obj deleted file mode 100644 index b2b1cf0..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/components/primitives/grating_couplers/grating_couplers.obj and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/core/generate_license.cp39-win_amd64.exp b/build/temp.win-amd64-cpython-39/Release/mxpic/core/generate_license.cp39-win_amd64.exp deleted file mode 100644 index a8d8b78..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/core/generate_license.cp39-win_amd64.exp and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/core/generate_license.cp39-win_amd64.lib b/build/temp.win-amd64-cpython-39/Release/mxpic/core/generate_license.cp39-win_amd64.lib deleted file mode 100644 index 2a554f8..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/core/generate_license.cp39-win_amd64.lib and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/core/generate_license.obj b/build/temp.win-amd64-cpython-39/Release/mxpic/core/generate_license.obj deleted file mode 100644 index abcb628..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/core/generate_license.obj and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/core/license_check.cp39-win_amd64.exp b/build/temp.win-amd64-cpython-39/Release/mxpic/core/license_check.cp39-win_amd64.exp deleted file mode 100644 index d2821e7..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/core/license_check.cp39-win_amd64.exp and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/core/license_check.cp39-win_amd64.lib b/build/temp.win-amd64-cpython-39/Release/mxpic/core/license_check.cp39-win_amd64.lib deleted file mode 100644 index c692579..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/core/license_check.cp39-win_amd64.lib and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/core/license_check.obj b/build/temp.win-amd64-cpython-39/Release/mxpic/core/license_check.obj deleted file mode 100644 index 2869689..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/core/license_check.obj and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/AMF.cp39-win_amd64.exp b/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/AMF.cp39-win_amd64.exp deleted file mode 100644 index eb1a690..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/AMF.cp39-win_amd64.exp and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/AMF.cp39-win_amd64.lib b/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/AMF.cp39-win_amd64.lib deleted file mode 100644 index 4a56a97..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/AMF.cp39-win_amd64.lib and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/AMF.obj b/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/AMF.obj deleted file mode 100644 index fb14f43..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/AMF.obj and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/Silterra.cp39-win_amd64.exp b/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/Silterra.cp39-win_amd64.exp deleted file mode 100644 index 8dd3fe6..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/Silterra.cp39-win_amd64.exp and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/Silterra.cp39-win_amd64.lib b/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/Silterra.cp39-win_amd64.lib deleted file mode 100644 index 4dd3394..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/Silterra.cp39-win_amd64.lib and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/Silterra.obj b/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/Silterra.obj deleted file mode 100644 index 5584395..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/foundries/Silterra.obj and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/routing/routing.cp39-win_amd64.exp b/build/temp.win-amd64-cpython-39/Release/mxpic/routing/routing.cp39-win_amd64.exp deleted file mode 100644 index bb7abc4..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/routing/routing.cp39-win_amd64.exp and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/routing/routing.cp39-win_amd64.lib b/build/temp.win-amd64-cpython-39/Release/mxpic/routing/routing.cp39-win_amd64.lib deleted file mode 100644 index bdc1455..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/routing/routing.cp39-win_amd64.lib and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/routing/routing.obj b/build/temp.win-amd64-cpython-39/Release/mxpic/routing/routing.obj deleted file mode 100644 index 4bb2547..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/routing/routing.obj and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/structures.cp39-win_amd64.exp b/build/temp.win-amd64-cpython-39/Release/mxpic/structures.cp39-win_amd64.exp deleted file mode 100644 index cf773ae..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/structures.cp39-win_amd64.exp and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/structures.cp39-win_amd64.lib b/build/temp.win-amd64-cpython-39/Release/mxpic/structures.cp39-win_amd64.lib deleted file mode 100644 index 824be02..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/structures.cp39-win_amd64.lib and /dev/null differ diff --git a/build/temp.win-amd64-cpython-39/Release/mxpic/structures.obj b/build/temp.win-amd64-cpython-39/Release/mxpic/structures.obj deleted file mode 100644 index b45efa5..0000000 Binary files a/build/temp.win-amd64-cpython-39/Release/mxpic/structures.obj and /dev/null differ diff --git a/build_release.py b/build_release.py index 08e0b05..475d0e6 100644 --- a/build_release.py +++ b/build_release.py @@ -6,7 +6,20 @@ from pathlib import Path def build_and_harvest(): src_dir = Path("mxpic") release_dir = Path("mxpic_release/mxpic") + + print("🧠 Generating IDE Stub Files (.pyi)...") + # 1. Run stubgen on the mxpic directory + # -o . outputs the files directly next to their .py counterparts + try: + subprocess.run(["stubgen", "./mxpic", "-o", "."], check=True) + print("✅ Stubs generated successfully.") + except subprocess.CalledProcessError: + print("❌ Failed to generate stubs. Is mypy installed?") + return + + print("🚀 Starting Wheel Build Process...") + print("🧹 Cleaning old builds...") if release_dir.parent.exists(): shutil.rmtree(release_dir.parent) @@ -35,12 +48,12 @@ def build_and_harvest(): file_path = current_root / file # Copy compiled binaries (.so for Linux/WSL, .pyd for Windows) - if file.endswith((".so", ".pyd")): + if file.endswith((".so", ".pyd", ".pyi")): shutil.move(file_path, target_dir / file) # Copy __init__.py files so Python recognizes the packages - elif file == "__init__.py": - shutil.copy2(file_path, target_dir / file) + # elif file == "__init__.py": + # shutil.copy2(file_path, target_dir / file) # (Optional) Copy non-code assets like config files or templates elif file.endswith((".json", ".yaml", ".yml")): diff --git a/build_wheel.py b/build_wheel.py new file mode 100644 index 0000000..ca2ce04 --- /dev/null +++ b/build_wheel.py @@ -0,0 +1,64 @@ +import os +import shutil +import subprocess +import zipfile # <-- Add this import at the top +from pathlib import Path + +def build_and_clean(): + print("🧠 Generating IDE Stub Files (.pyi)...") + try: + subprocess.run(["stubgen", "--parse-only", "./mxpic", "-o", "."], check=True) + print("✅ Stubs generated successfully.") + except subprocess.CalledProcessError: + print("❌ Failed to generate stubs.") + return + + print("🚀 Starting Wheel Build Process...") + try: + subprocess.run(["python", "-m", "build", "--wheel"], check=True) + print("✅ Base Wheel built successfully.") + except subprocess.CalledProcessError: + print("❌ Build failed. Stopping cleanup.") + return + + # --- THE SURGICAL INJECTION --- + print("💉 Injecting .pyi stubs directly into the Wheel...") + wheel_files = list(Path("dist").glob("*.whl")) + + if wheel_files: + target_wheel = wheel_files[0] + # Open the wheel file in 'append' mode + with zipfile.ZipFile(target_wheel, 'a', compression=zipfile.ZIP_DEFLATED) as wheel_zip: + injected_count = 0 + for pyi_file in Path("mxpic").rglob("*.pyi"): + # Inject the file, preserving the 'mxpic/...' folder structure + wheel_zip.write(pyi_file, arcname=pyi_file) + injected_count += 1 + print(f"✅ Successfully injected {injected_count} stub files into {target_wheel.name}") + else: + print("❌ Could not find the .whl file in the dist/ directory.") + + # --- THE CLEANUP --- + print("\n🧹 Commencing Workspace Cleanup...") + + src_path = Path("mxpic") + if src_path.exists(): + # Now it is safe to delete the stubs from the source folder! + for pyi_file in src_path.rglob("*.pyi"): + pyi_file.unlink() + + # Clean Cython artifacts + for c_file in src_path.rglob("*.c"): + c_file.unlink() + + # Delete the bulky build directories + folders_to_remove = ["build", "mxpic.egg-info"] + for folder in folders_to_remove: + folder_path = Path(folder) + if folder_path.exists() and folder_path.is_dir(): + shutil.rmtree(folder_path) + + print("\n✨ Workspace is clean. Your ultimate .whl is ready in dist/!") + +if __name__ == "__main__": + build_and_clean() \ No newline at end of file diff --git a/mxpic.lic b/mxpic.lic deleted file mode 100644 index 0c2eb0e..0000000 --- a/mxpic.lic +++ /dev/null @@ -1,5 +0,0 @@ -{ - "mac_address": "D4:54:8B:F1:46:49", - "expiration": "2027-05-07", - "signature": "844002ba44b83a6bc5ddb9889db72fc614b1232ed980cc7e13dd02c2f8de25f2" -} \ No newline at end of file diff --git a/mxpic/__init__.py b/mxpic/__init__.py index a991874..364733a 100644 --- a/mxpic/__init__.py +++ b/mxpic/__init__.py @@ -6,7 +6,6 @@ from .core.license_check import verify_license verify_license() # If the check passes, the rest of the library loads -from .components import EC_dual_layer_px3 +from .components import EC_dual_layer_px3,DC,DC_bend,DC_pX_3sg from .routing import Route -from .components.primitives import * \ No newline at end of file diff --git a/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.py b/mxpic/components/primitives/EC_dual_layer_px3.py similarity index 100% rename from mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.py rename to mxpic/components/primitives/EC_dual_layer_px3.py diff --git a/mxpic/components/primitives/__init__.py b/mxpic/components/primitives/__init__.py index c7dc1c3..2b61251 100644 --- a/mxpic/components/primitives/__init__.py +++ b/mxpic/components/primitives/__init__.py @@ -1,2 +1,6 @@ -from .directional_couplers.directional_couplers import * -from .edge_couplers.EC_dual_layer_px3 import * \ No newline at end of file +from .directional_couplers import * +from .EC_dual_layer_px3 import * +from .directional_couplers import * +from .beam_splitters import * +from .multimode_interferometers import * +from .spiral import * \ No newline at end of file diff --git a/mxpic/components/primitives/beam_splitters.py b/mxpic/components/primitives/beam_splitters.py new file mode 100644 index 0000000..1ae0765 --- /dev/null +++ b/mxpic/components/primitives/beam_splitters.py @@ -0,0 +1,250 @@ +import nazca as nd +import numpy as np +from scipy.interpolate import CubicSpline + +from ...routing import Route + +from ...structures import * +from ...foundries import * + +import pandas as pd +from ...structures import _my_polygon +from ...basic import __cell_arg__ + +class YBranch: + """ + Broadband spline-shaped Y-branch with two bent output ports. + + Parameters + ---------- + name : str or None, optional + Nazca cell name. ``None`` keeps the cell uninstantiated (default is None). + xs : str, optional + Cross-section key used for both the taper body and attachments (default is "strip"). + w : Sequence[float], optional + Width control points (µm) used by the cubic spline along the taper axis. + Length must be >= 2. Default is ``[1.2, 1.0, 1.8, 1.2, 1.0, 1.2, 1.2]``. + L : float, optional + Total spline length in microns (default is 6). + R_att : float, optional + Bend radius of each attachment waveguide in microns (default is 10). + A_att : float, optional + Bend angle (degrees) per attachment arc (default is 10). + w_port : float, optional + Output port width in microns (default is 0.45). + show_pins : bool, optional + Draw Nazca stub markers when True (default is False). + sharp_patch : bool, optional + Add chamfer helpers inside polygons when True (default is True). + res : float, optional + Longitudinal sampling pitch (µm) for polygon discretization (default is 0.1). + """ + def __init__(self, + name : str = None, + xs : str = 'strip', + w : 'list|np.ndarray' = [1.2,1.0,1.8,1.2,1.0,1.2,1.2], + L : float = 6, + R_att : float = 10, + A_att : float = 10, + w_port : float = 0.45, + show_pins : bool = False, + sharp_patch : bool = True, + + res : float = 0.1, + ) -> None: + + self.name = name + + if (name!=None): + self.instantiate = True + else : + self.instantiate = False + + self.w = w + self.L = L + self.res = res + self.R_att = R_att + self.A_att = A_att + self.w_port = w_port + self.xs = xs + + self.cell = self.generate_gds(show_pins=show_pins,sharp_patch=sharp_patch) + + def generate_gds(self,show_pins=False,sharp_patch=True): + with nd.Cell(name=self.name,instantiate=self.instantiate) as C: + + w = np.r_[self.w] + + n_sects = len(self.w)-1 + res = self.L/n_sects + n_points = int(self.L/self.res)+1 + L = np.linspace(0,self.L,n_sects+1) + L_act = np.linspace(0,self.L,n_points) + + f = CubicSpline(L,w) ## cubic spline interpolant + + w_act = f(L_act) + + + for layers,growx,growy,acc in nd.layeriter(xs=self.xs): + (a1,b1), (a2,b2),c1,c2 = growx + + w_cur = w_act*(a1-a2) + (b1-b2) + if (b1!=0 and b2!=0): + w_cur = max(w_cur)*np.ones(np.shape(w_cur)) + vtx_x = np.r_[L_act,np.flip(L_act,0)] + vtx_y = np.r_[w_cur/2,-np.flip(w_cur/2,0)] + vtx = np.c_[vtx_x,vtx_y] + _my_polygon(layer_wg=layers,vtx=vtx).put(0,0,0) + + temp = circle(xs=self.xs,radius=self.R_att,theta_start=0,theta_stop=self.A_att,width=self.w_port).cell.put('a1',self.L,self.w[-1]/2 - self.w_port/2,0) + temp = circle(xs=self.xs,radius=self.R_att,theta_start=-self.A_att,theta_stop=0,width=self.w_port).cell.put('a1',temp.pin['b1'],flip=1) + nd.Pin(name='b1',width=self.w_port).put(temp.pin['b1']) + + temp = circle(xs=self.xs,radius=self.R_att,theta_start=0,theta_stop=self.A_att,width=self.w_port).cell.put('a1',self.L,-self.w[-1]/2 + self.w_port/2,0,flip=1) + temp = circle(xs=self.xs,radius=self.R_att,theta_start=-self.A_att,theta_stop=0,width=self.w_port).cell.put('a1',temp.pin['b1'],flip=0) + nd.Pin(name='b2',width=self.w_port).put(temp.pin['b1']) + + nd.Pin(name='a1',width=self.w[0]).put(0,0,180) + + if (show_pins): + nd.put_stub() + + return C + + +class Ybranch_3wg: + """ + Initialization of a symmetric tapered coupler for 3dB coupling + + Parameters + ---------- + name : str or None, optional + Nazca cell name (default is None). + + 1. taper part + w0 : float, optional + Width (µm) of the center arm at the coupling region entrance (default is 0.4). + w1 : float, optional + Width (µm) of the outer arms at the coupling region exit (default is 0.2). + gap : float, optional + Vertical spacing (µm) between adjacent arms inside the coupler (default is 0.18). + Lcp : float, optional + Length (µm) of each taper section forming the coupler (default is 20). + xs : str, optional + Cross-section key for all segments (default is "strip"). + + 2. attachment part + w_wg : float, optional + External IO waveguide width in microns (default is 0.45). + R0 : float, optional + Bend radius (µm) used for both output waveguides (default is 10). + angle : float, optional + Bend deflection angle in degrees (default is 20). + L_attach : float, optional + Length (µm) of straight sections appended after the output tapers (default is 3). + L_in_tp : float, optional + Taper length (µm) that links the IO waveguide to width ``w0`` (default is 3). + + sharp_patch : bool, optional + Insert chamfer helpers when True (default is True). + """ + def __init__(self, + name = None, + w0:float=0.4, + w1:float=0.2, + gap:float=0.18, + Lcp:float=20, + xs:str='strip', + w_wg:float=0.45, + R0:float=10, + angle:float=20, + L_attach:float=3, + L_in_tp:float=3, + sharp_patch:bool=True): + + self.name = name + if (self.name==None): + self.instantiate = False + else : + self.instantiate = True + + self.w0 = w0 + self.w1 = w1 + self.gap = gap + self.Lcp = Lcp + self.xs = xs + self.w_wg = w_wg + self.R0 = R0 + self.angle = angle + self.L_attach = L_attach + self.L_in_tp = L_in_tp + + self.cell = self.generate_gds(sharp_patch=sharp_patch) + self.L = np.abs(self.cell.pin['a1'].x - self.cell.pin['b1'].x) + + def generate_gds(self,sharp_patch,err_asy=0): + with nd.Cell(instantiate=self.instantiate,name=self.name) as C: + + w0 = self.w0 + w1 = self.w1 + Lcp = self.Lcp + gap = self.gap + xs = self.xs + w_wg = self.w_wg + L_attach = self.L_attach + L_in_tp = self.L_in_tp + angle = self.angle + R0 = self.R0 + + t_mid = nd.taper(width1=w0,width2=w1,length=Lcp,xs=xs).put(0,0,0) + t_u = nd.taper(width2=w0,width1=w1,length=Lcp,xs=xs).put(0,w1/2+w0/2+gap,0) + t_d = nd.taper(width2=w0,width1=w1,length=Lcp,xs=xs).put(0,-(w1/2+w0/2+gap),0) + t_in = nd.taper(width1=w_wg,width2=w0,length=L_in_tp,xs=xs).put(-L_in_tp,0,0) + t_in = nd.strt(width=w_wg,length=L_attach,xs=xs).put(t_in.pin['a0'],flip=0) + nd.Pin(name='a1',pin=t_in.pin['b0']).put() + + au = nd.bend(radius=R0,angle=angle,xs=xs,width=w0).put(t_u.pin['b0'],flip=0) + au = nd.bend(radius=R0,angle=angle,xs=xs,width=w0).put(au.pin['b0'],flip=1) + au = nd.taper(width1=w0,width2=w_wg,length=L_in_tp,xs=xs).put(au.pin['b0'],flip=0) + au = nd.strt(width=w_wg,length=L_attach,xs=xs).put(au.pin['b0'],flip=0) + nd.Pin(name='b1',pin=au.pin['b0']).put() + + ad = nd.bend(radius=R0,angle=angle,xs=xs,width=w0).put(t_d.pin['b0'],flip=1) + ad = nd.bend(radius=R0,angle=angle,xs=xs,width=w0).put(ad.pin['b0'],flip=0) + ad = nd.taper(width1=w0,width2=w_wg,length=L_in_tp,xs=xs).put(ad.pin['b0'],flip=0) + ad = nd.strt(width=w_wg,length=L_attach,xs=xs).put(ad.pin['b0'],flip=0) + nd.Pin(name='b2',pin=ad.pin['b0']).put() + + + if (sharp_patch==True): + dY = np.abs(ad.pin['b0'].y-au.pin['b0'].y)+w_wg + for layers,growx,growy,acc in nd.layeriter(xs=xs): + (a1,b1), (a2,b2),c1,c2 = growx + if (b1!=0 and b2!=0): + L_patch = dY*(a1-a2)+(b1-b2) + W_patch = dY*(a1-a2)+(b1-b2) + nd.strt(length=W_patch,width=L_patch,layer=layers).put(ad.pin['b0'].x,0,0) + return C + + def generate_test_gds(self,gc,dX_gc2gc=400,dY_gc2gc=80,sharp_patch = True,Rbend=15): + with nd.Cell(instantiate=False) as C: + + + gc_cell = __cell_arg__(arg=gc,arg_name="gc",func_name="mxpic::Ybranch_3wg::generate_test_gds") + + inst = self.cell.put('a1',-self.L/2,0,0) + + gc_In = gc_cell.put('g1',-dX_gc2gc/2,0,180) + gc_O1 = gc_cell.put('g1',dX_gc2gc/2, dY_gc2gc/2,0) + gc_O2 = gc_cell.put('g1',dX_gc2gc/2,-dY_gc2gc/2,0) + pic_strip = Route(radius=Rbend,width=self.w_wg,xs=self.xs) + + pic_strip.taper(pin=gc_O1.pin['g1'],width1=gc_O1.pin['g1'].width,width2=self.w_wg,length=5,arrow=False) + pic_strip.sbend_p2p(original_function=not sharp_patch, pin2=inst.pin['b1'],arrow=False).put() + + pic_strip.taper(pin=gc_O2.pin['g1'],width1=gc_O2.pin['g1'].width,width2=self.w_wg,length=5,arrow=False) + pic_strip.sbend_p2p(original_function=not sharp_patch, pin2=inst.pin['b2'],arrow=False).put() + pic_strip.taper_p2p(pin1=gc_In.pin['g1'],pin2=inst.pin['a1'],arrow=False).put() + + return C \ No newline at end of file diff --git a/mxpic/components/primitives/directional_couplers/directional_couplers.py b/mxpic/components/primitives/directional_couplers.py similarity index 99% rename from mxpic/components/primitives/directional_couplers/directional_couplers.py rename to mxpic/components/primitives/directional_couplers.py index 3247dbd..50bdfed 100644 --- a/mxpic/components/primitives/directional_couplers/directional_couplers.py +++ b/mxpic/components/primitives/directional_couplers.py @@ -3,9 +3,9 @@ import nazca as nd import numpy as np from numpy import pi -from ....routing import Route -from ....structures import _my_polygon,circle,Clothoid -from ....basic import __cell_arg__ +from ...routing import Route +from ...structures import _my_polygon,circle,Clothoid +from ...basic import __cell_arg__ class ring_bus_wg: ## two types: diff --git a/mxpic/components/primitives/directional_couplers/__init__.py b/mxpic/components/primitives/directional_couplers/__init__.py deleted file mode 100644 index 88513f7..0000000 --- a/mxpic/components/primitives/directional_couplers/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from .directional_couplers import * \ No newline at end of file diff --git a/mxpic/components/primitives/grating_couplers/grating_couplers.py b/mxpic/components/primitives/grating_couplers.py similarity index 99% rename from mxpic/components/primitives/grating_couplers/grating_couplers.py rename to mxpic/components/primitives/grating_couplers.py index ecfc2f8..e2ec1a8 100644 --- a/mxpic/components/primitives/grating_couplers/grating_couplers.py +++ b/mxpic/components/primitives/grating_couplers.py @@ -3,9 +3,9 @@ import numpy as np import math import pandas as pd -from ....routing import Route -from ....structures import _my_polygon,circle,Clothoid,hole -from ....basic import __cell_arg__ +from ...routing import Route +from ...structures import _my_polygon,circle,Clothoid,hole +from ...basic import __cell_arg__ ''' Class for nanoantenna ''' diff --git a/mxpic/components/primitives/multimode_interferometers.py b/mxpic/components/primitives/multimode_interferometers.py new file mode 100644 index 0000000..6884441 --- /dev/null +++ b/mxpic/components/primitives/multimode_interferometers.py @@ -0,0 +1,260 @@ +from turtle import shape +import nazca as nd +import numpy as np +import math + +from ...routing import Route + +from ...structures import * + +from ...structures import _my_polygon,Conchoid + +""" Mono layer MMI """ +class MMI_ML: + """ + Multi-layer (mono-layer) multimode interference (MMI) device generator. + + Parameters + ---------- + name : str or None, optional + Nazca cell name. ``None`` keeps the cell uninstantiated (default is None). + L_arm : Sequence[float], optional + Segment lengths (µm) of each arm taper section (default is ``[10]``). + w_arm : Sequence[float], optional + Corresponding arm widths (µm). Length must be ``len(L_arm) + 1`` (default is ``[0.45, 1.35]``). + xs : str, optional + Nazca cross-section key used for both arm and MMI regions (default is "strip"). + arm_sine_width : bool, optional + If True, arm width follows a cosine taper instead of linear interpolation (default is False). + L_mmi : Sequence[float], optional + Segment lengths (µm) within the central MMI body (default is ``[10]``). + w_mmi : Sequence[float], optional + MMI widths (µm). Length must be ``len(L_mmi) + 1`` (default is ``[5, 5]``). + mmi_sine_width : bool, optional + If True, MMI width transition uses cosine instead of linear interpolation (default is False). + sharp_patch : bool, optional + Insert chamfer polygons at acute corners when ``True`` (default is True). + show_pins : bool, optional + Draw Nazca stub markers for debugging when ``True`` (default is False). + res : float, optional + Longitudinal sampling resolution (µm) for polygon generation (default is 0.01). + N_out : int, optional + Number of output ports (default is 3). + N_in : int, optional + Number of input ports (default is 1). + Dp_out : float, optional + Vertical pitch (µm) between adjacent output ports (default is 1.5). + Dp_in : float, optional + Vertical pitch (µm) between adjacent input ports (default is 1.5). + """ + def __init__(self, + name=None, + L_arm=[10], + w_arm=[0.45,1.35], + xs = 'strip', + arm_sine_width=False, + L_mmi = [10], + w_mmi = [5,5], + + mmi_sine_width=False, + + sharp_patch=True, + show_pins = False, + + res = 0.01, + N_out = 3, + N_in = 1, + Dp_out = 1.5, + Dp_in = 1.5, + ) -> None: + + self.name = name + if (self.name==None): + self.instantiate = False + else : + self.instantiate = True + + self.L_arm = L_arm + self.xs = xs + self.w_arm = w_arm + self.arm_sine_width = arm_sine_width + self.L_mmi = L_mmi + self.w_mmi = w_mmi + self.res = res + self.N_out = N_out + self.N_in = N_in + self.Dp_out = Dp_out + self.Dp_in = Dp_in + self.mmi_sine_width = mmi_sine_width + + self.cell = self.generate_gds(sharp_patch=sharp_patch,show_pins=show_pins) + + self.L = np.sum(self.L_arm)*2+np.sum(self.L_mmi) + + def generate_gds(self,sharp_patch,show_pins): + + with nd.Cell(instantiate=self.instantiate,name=self.name) as C: + L = 0 + Lsg = [] + Wsg = [] + for idx in range(0,len(self.L_arm)): + n_points = round(self.L_arm[idx]/self.res)+1 + L_sect = np.linspace(L,L+self.L_arm[idx],n_points) + Lsg = np.r_[Lsg,L_sect] + if (self.arm_sine_width): + dw = self.w_arm[idx+1]-self.w_arm[idx] + w_sect = -np.cos(L_sect/self.L_arm[idx]*pi)*dw + (self.w_arm[idx+1]-self.w_arm[idx])/2 + else: + w_sect = np.linspace(self.w_arm[idx],self.w_arm[idx+1],n_points) + Wsg = np.r_[Wsg,w_sect] + + L = L + self.L_arm[idx] + + with nd.Cell(instantiate=False) as Arm: + for layers,growx,growy,acc in nd.layeriter(xs=self.xs): + (a1,b1), (a2,b2),c1,c2 = growx + + vtx_y = np.r_[Wsg*a1+b1, np.flip(Wsg,0)*a2+b2] + vtx_x = np.r_[Lsg, np.flip(Lsg,0)] + vtx = np.c_[vtx_x,vtx_y] + _my_polygon(layer_wg=layers,vtx=vtx).put(0,0,0) + + + nd.Pin(name='a1',width=Wsg[0]).put(0,0,180) + nd.Pin(name='b1',width=Wsg[-1]).put(L,0,0) + + """ For central MMI """ + L_mmi = 0 + Lsg_mmi = [] + Wsg_mmi = [] + for idx in range(0,len(self.L_mmi)): + n_points = round(self.L_mmi[idx]/self.res)+1 + L_sect = np.linspace(L_mmi,L_mmi+self.L_mmi[idx],n_points) + Lsg_mmi = np.r_[Lsg_mmi,L_sect] + if (self.arm_sine_width): + dw = self.w_mmi[idx+1]-self.w_mmi[idx] + w_sect = -np.cos(L_sect/self.L_mmi[idx]*pi)*dw + (self.w_mmi[idx+1]-self.w_mmi[idx])/2 + else: + w_sect = np.linspace(self.w_mmi[idx],self.w_mmi[idx+1],n_points) + Wsg_mmi = np.r_[Wsg_mmi,w_sect] + + L_mmi = L_mmi + self.L_mmi[idx] + + with nd.Cell(instantiate=False) as MMI: + for layers,growx,growy,acc in nd.layeriter(xs=self.xs): + (a1,b1), (a2,b2),c1,c2 = growx + + vtx_y = np.r_[Wsg_mmi*a1+b1, np.flip(Wsg_mmi,0)*a2+b2] + vtx_x = np.r_[Lsg_mmi, np.flip(Lsg_mmi,0)] + vtx = np.c_[vtx_x,vtx_y] + if (b1==0 and b2==0): + _my_polygon(layer_wg=layers,vtx=vtx).put(0,0,0) + else : + w = max(Wsg_mmi)+b1*2 + L = max(Lsg_mmi)+b1*2 + nd.strt(length=L,layer=layers,width=w).put(-b1,0,0) + + nd.Pin(name='a1',width=Wsg_mmi[0]).put(0,0,180) + nd.Pin(name='b1',width=Wsg_mmi[-1]).put(L_mmi,0,0) + + for idx_in in range(0,self.N_in): + Arm_inst = Arm.put('b1',0,self.Dp_in*(-idx_in+(self.N_in-1)/2),180) + nd.Pin(name='a'+str(round(idx_in+1)),pin=Arm_inst.pin['a1']).put() + + for idx_in in range(0,self.N_out): + Arm_inst = Arm.put('b1',L_mmi,self.Dp_out*(-idx_in+(self.N_out-1)/2),0) + nd.Pin(name='b'+str(round(idx_in+1)),pin=Arm_inst.pin['a1']).put() + MMI.put('a1',0,0,0) + + if (show_pins): + nd.put_stub() + + return C + + def generate_test_gds(self,gc,dX_gc2gc,dY_gc2gc,R_bend=10,Xout_offset=50): + if (isinstance(gc,nd.Cell)): + gc_cell =gc + elif (hasattr(gc,'cell')): + gc_cell = gc.cell + else : + raise Exception("ERROR: In , is not recongized as a cell") + + with nd.Cell(instantiate=False) as C: + + INST = self.cell.put(-self.L/2,0,0) + pic_strip = Route(width=self.w_arm[0],radius=R_bend,xs=self.xs) + for idx_in in range(0,self.N_in): + GC = gc_cell.put('g1',-dX_gc2gc/2,dY_gc2gc*(-idx_in + (self.N_in-1)/2),180) + pic_strip.sbend_p2p(pin1=GC.pin['g1'],pin2=INST.pin['a'+str(idx_in+1)],Lstart=dX_gc2gc/10).put() + + for idx_in in range(0,self.N_out): + toggle = np.mod(idx_in,2)-0.5 + GC = gc_cell.put('g1', dX_gc2gc/2+Xout_offset*toggle,dY_gc2gc*(-idx_in + (self.N_out-1)/2),0) + pic_strip.sbend_p2p(pin1=GC.pin['g1'],pin2=INST.pin['b'+str(idx_in+1)],Lstart=dX_gc2gc/10).put() + + return C + + +class MMI_STD(MMI_ML): + """ + Convenience wrapper for standard MMIs with equal-length arms and uniform MMI body. + + Parameters + ---------- + name : str or None, optional + Nazca cell name (default is None). + N_out : int, optional + Number of output ports (default is 3). + N_in : int, optional + Number of input ports (default is 1). + L_arm : float, optional + Single arm length in microns (default is 10). + w_wg : float, optional + Input/output waveguide width in microns (default is 0.45). + w_port : float, optional + Width at the transition between the taper and MMI (default is 1.2). + xs : str, optional + Cross-section key for all regions (default is "strip"). + L_mmi : float, optional + Central MMI length in microns (default is 10). + w_mmi : float, optional + Central MMI width in microns (default is 5). + sharp_patch : bool, optional + Add chamfer helpers when True (default is True). + show_pins : bool, optional + Draw Nazca stub markers when True (default is False). + Dp_out : float, optional + Output port pitch in microns (default is 1.5). + Dp_in : float, optional + Input port pitch in microns (default is 1.5). + """ + def __init__(self, + name=None, + N_out=3, + N_in=1, + L_arm=10, + w_wg=0.45, + w_port = 1.2, + xs='strip', + L_mmi=10, + w_mmi=5, + sharp_patch=True, + show_pins=False, + Dp_out=1.5, + Dp_in=1.5) -> None: + + super().__init__(name=name, + L_arm=[L_arm], + w_arm=[w_wg,w_port], + xs=xs, + arm_sine_width=False, + L_mmi=[L_mmi], + w_mmi=[w_mmi,w_mmi], + mmi_sine_width=False, + sharp_patch=sharp_patch, + show_pins=show_pins, + res=min([L_mmi,L_arm]), ## taper resolution + N_out=N_out, + N_in=N_in, + Dp_out=Dp_out, + Dp_in=Dp_in) \ No newline at end of file diff --git a/mxpic/components/primitives/spiral.py b/mxpic/components/primitives/spiral.py new file mode 100644 index 0000000..dfc2bbf --- /dev/null +++ b/mxpic/components/primitives/spiral.py @@ -0,0 +1,1186 @@ +from turtle import shape +import nazca as nd +import numpy as np +import math + +from ...routing import Route + +from ...structures import * +from ...foundries import * + +from ...structures import _my_polygon,Conchoid,_my_poly_spiral + +from scipy import optimize + +class spiral: + """ + Parametric waveguide spiral supporting circular or rectangular footprints. + + Parameters + ---------- + name : str, optional + Nazca cell name (default is None). + shape : str, optional + Footprint style used for the spiral path, circular or rectangular (default is "circle"). + Dmin : float, optional + Minimum inner diameter in microns; sets the first loop radius (default is 50). + R_bend : float, optional + Bend radius in microns for rectangular implementations (default is 10). + Rmin_euler : float, optional + Minimum radius inside Euler bends when ``Euler_bend`` is True (default is 10). + Lmin : float, optional + Straight length in microns used by the innermost rectangular loop (default is 50). + width : float, optional + Nominal waveguide width inside the spiral body (default is 2). + w_port : float, optional + Output-port width in microns. ``None`` inherits ``width`` (default is 0.45). + w_bend_center : float, optional + Waveguide width used in the central attachment bends (default is 1). + Rmin_bend_center : float, optional + Minimum radius for the attachment bends (default is 10). + gap : float, optional + Spacing between adjacent turns in microns (default is 1). + cycles : float, optional + Number of half-turns (π radians) laid out in the spiral (default is 20). + xs : str, optional + Cross-section key for the entire structure (default is "strip"). + layer : str, optional + Override layer for polygons; ``None`` derives from ``xs`` (default is None). + w_bend_port : float or None, optional + Width inside the outermost bends; ``None`` inherits ``width`` (default is None). + Ltp_port : float, optional + Length of straight tapers that adapt ``width`` to ``w_port`` (default is 10). + res : float, optional + Arc-length sampling step (µm) used for polygon tessellation (default is 0.5). + cell_transition : nazca.Cell, optional + Insert XS transitions cell to strip when connecting ports (default is None). + port_angle : float, optional + Output-port deflection angle in degrees, measured from +x (default is 180). + Euler_bend : bool, optional + Use Euler/Clothoid bends at the center instead of circular bends (default is False). + show_pins : bool, optional + Draw Nazca stub markers when True (default is False). + sharp_patch : bool, optional + Add chamfer helper polygons when True (default is True). + """ + def __init__(self, + name: str = None, + shape: str = 'circle', + Dmin: float = 50, + R_bend: float = 10, + Rmin_euler: float = 10, + Lmin: float = 50, + width: float = 2, + w_port: float = 0.45, ## not used at this moment + w_bend_center: float = 1, + Rmin_bend_center: float = 10, + gap: float = 1, + cycles: float = 20, + xs: str = 'strip', + layer: str = None, + w_bend_port=None, + Ltp_port = 10, + + res : float = 0.5, ## added in 2023.1.4, the length resolution + cell_transition : nd.Cell = None, + + port_angle: float = 180, + Euler_bend: bool = False, + show_pins: bool = False, + sharp_patch:bool = True +): + + self.Dmin = Dmin + self.Lmin = Lmin + self.R_bend = R_bend + self.shape = shape + self.cycles = cycles + self.width = width + self.w_port = w_port + self.gap = gap + self.xs = xs + self.layer = layer + + self.name=name + if (self.name==None): + self.instantiate = False + else : + self.instantiate = True + + + self.port_angle=port_angle + self.w_bend_center= w_bend_center + self.Rmin_bend_center= Rmin_bend_center + self.Euler_bend= Euler_bend + self.Rmin_euler= Rmin_euler + self.sharp_patch= sharp_patch + + self.w_bend_port = w_bend_port + self.Ltp_port = Ltp_port + + self.cell_transition = cell_transition + + self.res = res + + self.cell = self.generate_gds(show_pins=show_pins) + + def __strt_with_taper__(self,width1,width2,xs,length,Ltp=15,Lstart=2): + with nd.Cell(instantiate=False) as C: + + L_mm = length-Ltp*2-Lstart*2 + + if (L_mm>0): + + instr_a1 = nd.strt(length=Lstart,width=width1,xs=xs).put(0,0,0) + nd.taper(length=Ltp,width1=width1,width2=width2,xs=xs).put() + nd.strt(length=L_mm,width=width2,xs=xs).put() + nd.taper(length=Ltp,width1=width2,width2=width1,xs=xs).put() + instr_b1 = nd.strt(length=Lstart,width=width1,xs=xs).put() + + else : + instr_a1 = nd.strt(length=length/2,width=width1,xs=xs).put(0,0,0) + instr_b1 = nd.strt(length=length/2,width=width1,xs=xs).put() + + nd.Pin(name='a0',pin=instr_a1.pin['a0']).put() + nd.Pin(name='b0',pin=instr_b1.pin['b0']).put() + + return C + + def generate_gds(self,show_pins): + + if (self.w_port==None): + self.w_port = self.width + if (self.w_bend_port==None): + self.w_bend_port = self.width + + + """ Circular Spiral """ + if (self.shape=='circle'): + with nd.Cell(instantiate=self.instantiate,name=self.name) as C: + if (self.layer==None): + pitch = (self.width+self.gap)*2 ## a bi-twsited circle + + Dmin = self.Dmin + R0 = Dmin/2 + kR = pitch/(np.pi*2) + + K_att = (np.power(R0,2)+2*np.power(kR,2))/np.power((np.power(R0,2)+np.power(kR,2)),1.5) + R_att = 1/K_att + + + for layers,growx,growy,acc in nd.layeriter(xs=self.xs): + (a1,b1), (a2,b2),c1,c2 = growx + + """ Generating Central Euler bend """ + if (self.Euler_bend == True): + """ Modified in 2023.07.31, Clothoid simplified into the simple attachment of Clothoid and Conchoid + No Angle compensation were build due to no significant improvement + """ + # spr_bend = Clothoid(xs=self.xs,R=[R_att/1.5,R_att/2.4,R_att], + spr_bend = Clothoid(xs=self.xs,R=[R_att,R_att/2.5001,R_att], + w=[self.w_bend_center,self.w_bend_port],A=[0,90,180],dL_wg=self.res,width_type='dual_sine') + + else : + """ Genreating Circular bend for center """ + spr_bend = Clothoid(xs=self.xs,R=[R0/2,R0/2,R0/2], + w=[self.w_bend_port,self.w_bend_port],A=[0,90,180],dL_wg=self.res,width_type='dual_sine') + + w_cur = self.width*(a1-a2)+(b1-b2) + if (w_cur, Dmin too small") + D_port = self.Dmin - bend_sz[1]*2 + + with nd.Cell(instantiate=False) as wg_mid_cell: + wg = self.__strt_with_taper__(length=self.Lmin-bend_sz[0]*2,width2=self.width,width1=bend_cell.pin['a0'].width,xs=self.xs,Ltp=self.Ltp_port).put(-self.Lmin/2+bend_sz[0]*2,0,0) + bend_cell.put(wg.pin['a0'],flip=1) + self.__strt_with_taper__(length=D_port,width2=self.width,width1=bend_cell.pin['a0'].width,xs=self.xs,Ltp=self.Ltp_port).put() + bd = bend_cell.put(flip=0) + nd.Pin(name='a0',pin=bd.pin['b0']).put() + nd.Pin(name='b0',pin=wg.pin['b0']).put() + + wg_mid = wg_mid_cell.put(-self.Lmin/2,self.Dmin/2,0) + + pin_U_pre = wg_mid.pin['b0'] + pin_D_pre = wg_mid.pin['a0'] + + bend_U = bend_cell.put(pin_U_pre) + wg_U = self.__strt_with_taper__(length=pitch/2+D_port, + width2=self.width,width1=bend_U.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_U.pin['b0']) + bend_U2 = bend_cell.put(wg_U.pin['b0']) + wg_U = self.__strt_with_taper__(length=self.Lmin+pitch/2, + width2=self.width,width1=bend_U2.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_U2.pin['b0']) + pin_U_pre = wg_U.pin['b0'] + + bend_D = bend_cell.put(pin_D_pre) + wg_D = self.__strt_with_taper__(length=pitch/2+D_port, + width2=self.width,width1=bend_D.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_D.pin['b0']) + bend_D2 = bend_cell.put(wg_D.pin['b0']) + wg_D = self.__strt_with_taper__(length=self.Lmin+pitch/2, + width2=self.width,width1=bend_D2.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_D2.pin['b0']) + pin_D_pre = wg_D.pin['b0'] + + L = self.Lmin*3+pitch+L_bend + _cycle_ = 1 + for _cycle_ in range(1,self.cycles-1): + bend_U = bend_cell.put(pin_U_pre) + wg_U = self.__strt_with_taper__(length=_cycle_*pitch+pitch/2+D_port, + width2=self.width,width1=bend_U.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_U.pin['b0']) + bend_U2 = bend_cell.put(wg_U.pin['b0']) + wg_U = self.__strt_with_taper__(length=self.Lmin+_cycle_*pitch+pitch/2, + width2=self.width,width1=bend_U2.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_U2.pin['b0']) + pin_U_pre = wg_U.pin['b0'] + + bend_D = bend_cell.put(pin_D_pre) + wg_D = self.__strt_with_taper__(length=_cycle_*pitch+pitch/2+D_port, + width2=self.width,width1=bend_D.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_D.pin['b0']) + bend_D2 = bend_cell.put(wg_D.pin['b0']) + wg_D = self.__strt_with_taper__(length=self.Lmin+_cycle_*pitch+pitch/2, + width2=self.width,width1=bend_D2.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_D2.pin['b0']) + pin_D_pre = wg_D.pin['b0'] + + L = L+(_cycle_*pitch-pitch/2+D_port+self.Lmin+_cycle_*pitch+pitch/2)*2+L_bend*4 + + + """ 2023.03.19 REVISED, the spiral will end at the same Y level with begining """ + bend_D = bend_cell.put(pin_D_pre) + + + ## adding bend connection to outside + if(self.port_angle==90 or self.port_angle==270 or self.port_angle==-90): + wg_D = self.__strt_with_taper__(length=(_cycle_+1)*pitch+D_port, + width2=self.width,width1=bend_D.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_D.pin['b0']) + pin_D_pre = wg_D.pin['b0'] + + elif(self.port_angle==180) : + wg_D = self.__strt_with_taper__(length=(_cycle_+1)*pitch+D_port, + width2=self.width,width1=bend_D.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_D.pin['b0']) + + bend_D2 = bend_cell.put(wg_D.pin['b0'],flip=1) + pin_D_pre = bend_D2.pin['b0'] + elif(self.port_angle==0 or self.port_angle==360) : + + wg_D = self.__strt_with_taper__(length=(_cycle_+1.5)*pitch+D_port, + width2=self.width,width1=bend_D.pin['b0'].width,xs=self.xs,Ltp=self.Ltp_port).put(bend_D.pin['b0']) + + bend_D2 = bend_cell.put(wg_D.pin['b0'],flip=0) + pin_D_pre = bend_D2.pin['b0'] + + if (self.cell_transition is not None): + taper = self.cell_transition.put(pin_D_pre) + pin_D_pre = taper.pin['b0'] + taper = self.cell_transition.cell.put(pin_U_pre) + pin_U_pre = taper.pin['b0'] + + + """ 2023.03.19 REVISED, the begining will not be influenced by the rotation angle """ + if (self.w_port !=self.width) : + if (self.rib2strip): + nd.taper(length=self.Ltp_port,width1=self.width,width2=self.w_port,xs='strip').put(pin_D_pre) + nd.Pin(name='b1',width=self.w_bend_port).put() + + nd.taper(length=self.Ltp_port,width1=self.width,width2=self.w_port,xs='strip').put(pin_U_pre) + nd.Pin(name='a1',width=self.w_bend_port).put() + else : + nd.taper(length=self.Ltp_port,width1=self.width,width2=self.w_port,xs=self.xs).put(pin_D_pre) + nd.Pin(name='b1',width=self.w_bend_port).put() + + nd.taper(length=self.Ltp_port,width1=self.width,width2=self.w_port,xs=self.xs).put(pin_U_pre) + nd.Pin(name='a1',width=self.w_bend_port).put() + else: + nd.Pin(name='b1',width=self.w_bend_port).put(pin_D_pre) + nd.Pin(name='a1',width=self.w_bend_port).put(pin_U_pre) + + self.L = L + + ## revise 2022.08.18 + if (show_pins): + nd.put_stub() + + return C + +class spiral_rectangle: + """ + Rectangular spiral with optional cross-section transitions and alignment control. + + Parameters + ---------- + name : str or None, optional + Nazca cell name (default is None). + Dmin : float, optional + Minimum vertical separation between the first pair of bends (default is 50). + Rmax_bend : float, optional + Maximum radius used inside Clothoid bends (default is 10). + Rmin_bend : float, optional + Minimum radius reached inside Clothoid bends (default is 10). + wmin_bend : float, optional + Minimum waveguide width inside bends (default is 10). + Lmin : float, optional + Straight length of the innermost segment (default is 50). + width : float, optional + Nominal waveguide width along the spiral (default is 2). + w_port : float, optional + IO waveguide width after the final taper (default is 0.45). + gap : float, optional + Spacing between successive turns (default is 1). + cycles : float, optional + Number of rectangular loops (default is 20). + xs : str, optional + Cross-section key (default is "strip"). + layer : str, optional + Override polygon layer (default is None). + w_bend_port : float or None, optional + Bend waveguide width; inherits ``width`` when None (default is None). + Lport : float, optional + Length of straight sections appended at each port (default is 10). + Ltp : float, optional + Taper length that converts bend width to ``width`` (default is 10). + res : float, optional + Arc-length sampling resolution (default is 0.5). + cell_xs_transition : nd.Cell or object, optional + Pre-built cell that performs cross-section transitions after the ports (default is None). + port_angle : float, optional + Output bend angle in degrees (default is 180). + show_pins : bool, optional + Draw Nazca stub markers when True (default is False). + sharp_patch : bool, optional + Insert chamfer helpers when True (default is True). + in_out_align : bool, optional + If True, align input/output along the same axis when ``port_angle=180`` (default is True). + Lpatch : float, optional + Small straight length inserted before/after bends to ease Boolean ops (default is 0.05). + """ + def __init__(self, + name: str = None, + Dmin: float = 50, + Rmax_bend: float = 10, + Rmin_bend: float = 10, + wmin_bend: float = 10, + Lmin: float = 50, + width: float = 2, + w_port: float = 0.45, ## not used at this moment + gap: float = 1, + cycles: float = 20, + xs: str = 'strip', + layer: str = None, + w_bend_port=None, + Lport = 10, + Ltp = 10, + + # Tres: int = 256,## resolution for one cycle, these two parameters aborted in 2023.1.4 + # Bres: int = 64, ## resolution for bends, these two parameters aborted in 2023.1.4 + + res : float = 0.5, ## added in 2023.1.4, the length resolution + cell_xs_transition=None, + + port_angle: float = 180, + show_pins: bool = False, + sharp_patch:bool = True, + in_out_align = True, + Lpatch = 0.05, +): + + self.Dmin = Dmin + self.Lmin = Lmin + self.Rmax_bend = Rmax_bend + self.Rmin_bend = Rmin_bend + self.wmin_bend = wmin_bend + self.cycles = cycles + self.width = width + self.w_port = w_port + self.gap = gap + self.xs = xs + self.layer = layer + + self.Ltp = Ltp + self.Lpatch = Lpatch + self.name=name + if (self.name==None): + self.instantiate = False + else : + self.instantiate = True + + + self.port_angle=port_angle + self.sharp_patch= sharp_patch + + self.w_bend_port = w_bend_port + self.Lport = Lport + + if (hasattr(cell_xs_transition,'cell')): + self.cell_xs_transition = cell_xs_transition.cell + elif (isinstance(cell_xs_transition,nd.Cell)): + self.cell_xs_transition = cell_xs_transition + else : + self.cell_xs_transition = None + + self.res = res + + self.in_out_align = in_out_align + + self.cell = self.generate_gds(show_pins=show_pins) + + def __strt_with_taper__(self,width1,width2,xs,length,Ltp=15,Lstart=2): + with nd.Cell(instantiate=False) as C: + + L_mm = length-Ltp*2-Lstart*2 + + if (L_mm>0): + + instr_a1 = nd.strt(length=Lstart,width=width1,xs=xs).put(0,0,0) + nd.taper(length=Ltp,width1=width1,width2=width2,xs=xs).put() + nd.strt(length=L_mm,width=width2,xs=xs).put() + nd.taper(length=Ltp,width1=width2,width2=width1,xs=xs).put() + instr_b1 = nd.strt(length=Lstart,width=width1,xs=xs).put() + + else : + instr_a1 = nd.strt(length=length/2,width=width1,xs=xs).put(0,0,0) + instr_b1 = nd.strt(length=length/2,width=width1,xs=xs).put() + + nd.Pin(name='a0',pin=instr_a1.pin['a0']).put() + nd.Pin(name='b0',pin=instr_b1.pin['b0']).put() + + return C + + def generate_gds(self,show_pins): + + if (self.w_port==None): + self.w_port = self.width + if (self.w_bend_port==None): + self.w_bend_port = self.width + + """ Rectangluar Spiral """ + with nd.Cell(instantiate=self.instantiate,name=self.name) as C: + pitch = (self.width+self.gap)*2 ## a bi-twsited circle + + bend_rt = Clothoid(xs=self.xs,R=[self.Rmax_bend,self.Rmin_bend,self.Rmax_bend], + w=[self.w_bend_port,self.wmin_bend,self.w_bend_port], + A=[0,45,90], + dL_wg=self.res, + end_patch=False, + sharp_patch=self.sharp_patch) + + bend_rt_anti = Clothoid(xs=self.xs,R=[self.Rmax_bend,self.Rmin_bend,self.Rmax_bend], + w=[self.w_bend_port,self.wmin_bend,self.w_bend_port], + A=[0,-45,-90], + dL_wg=self.res, + end_patch=False, + sharp_patch=self.sharp_patch) + + """ Adding small patch to the bending connection """ + with nd.Cell(instantiate=False) as bend_cell: + inst = bend_rt.cell.put(0,0,0) + nd.strt(xs=self.xs,width=self.w_bend_port,length=self.Lpatch).put(inst.pin['a0'].move(-self.Lpatch/2,0,0),flip=1) + nd.strt(xs=self.xs,width=self.w_bend_port,length=self.Lpatch).put(inst.pin['b0'].move(-self.Lpatch/2,0,0)) + inst.raise_pins() + + with nd.Cell(instantiate=False) as bend_cell_anti: + inst = bend_rt_anti.cell.put(0,0,0) + nd.strt(xs=self.xs,width=self.w_bend_port,length=self.Lpatch).put(inst.pin['a0'].move(-self.Lpatch/2,0,0),flip=1) + nd.strt(xs=self.xs,width=self.w_bend_port,length=self.Lpatch).put(inst.pin['b0'].move(-self.Lpatch/2,0,0)) + inst.raise_pins() + + # bend_cell = bend_rt.cell + # bend_cell_anti = bend_rt_anti.cell + bend_sz = bend_rt.sz + L_bend = bend_rt.L0 + + self.bend_cell = bend_cell + if (self.Dmin < bend_sz[1]*2): + self.Dmin = bend_sz[1]*2 + print("WARNING: In , Dmin too small") + D_port = self.Dmin - bend_sz[1]*2 + + with nd.Cell(instantiate=True,name="wg_mid_cell"+self.name) as wg_mid_cell: + + wg = self.__strt_with_taper__(length=self.Lmin-bend_sz[0]*2-bend_sz[0],width2=self.width,width1=bend_cell.pin['a0']. + width,xs=self.xs,Ltp=self.Ltp).put(-self.Lmin/2+bend_sz[0]*2+bend_sz[0],0,0,flip=1) + bend_cell_anti.put(wg.pin['a0'],flip=0) + self.__strt_with_taper__(length=D_port,width2=self.width,width1=bend_cell.pin['a0'].width,xs=self.xs,Ltp=self.Ltp).put() + # bd = bend_cell.put(flip=0) + bd = bend_cell.put() + bd = self.__strt_with_taper__(length=bend_sz[0], + width2=bend_cell.pin['a0'].width, + width1=bend_cell.pin['a0'].width,xs=self.xs,Ltp=self.Ltp).put() + nd.Pin(name='a0',pin=bd.pin['b0']).put() + nd.Pin(name='b0',pin=wg.pin['b0']).put() + + wg_mid = wg_mid_cell.put(-self.Lmin/2,self.Dmin/2,0) + L = self.Lmin-bend_sz[0]*2 + D_port + L_bend*2 + + pin_U_pre = wg_mid.pin['b0'] + pin_D_pre = wg_mid.pin['a0'] + + bend_U = bend_cell_anti.put(pin_U_pre,flip=1) + wg_U = self.__strt_with_taper__(length=pitch/2+D_port, + width2=self.width,width1=bend_U.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_U.pin['b0'],flip=1) + L = L + pitch/2+D_port + L_bend + + bend_U2 = bend_cell_anti.put(wg_U.pin['b0'],flip=1) + wg_U = self.__strt_with_taper__(length=self.Lmin+pitch/2, + width2=self.width,width1=bend_U2.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_U2.pin['b0'],flip=1) + pin_U_pre = wg_U.pin['b0'] + L = L + self.Lmin+pitch/2 + L_bend + + bend_D = bend_cell.put(pin_D_pre) + wg_D = self.__strt_with_taper__(length=pitch/2+D_port, + width2=self.width,width1=bend_D.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_D.pin['b0']) + L = L + pitch/2+D_port + L_bend + + bend_D2 = bend_cell.put(wg_D.pin['b0']) + wg_D = self.__strt_with_taper__(length=self.Lmin+pitch/2, + width2=self.width,width1=bend_D2.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_D2.pin['b0']) + pin_D_pre = wg_D.pin['b0'] + L = L + self.Lmin+pitch/2 + L_bend + + # L = self.Lmin*3+pitch+L_bend + _cycle_ = 1 + + + for _cycle_ in range(1,self.cycles-1): + bend_U = bend_cell_anti.put(pin_U_pre,flip=1) + wg_U = self.__strt_with_taper__(length=_cycle_*pitch+pitch/2+D_port, + width2=self.width,width1=bend_U.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_U.pin['b0'],flip=1) + + L = L+_cycle_*pitch+pitch/2+D_port+L_bend + + bend_U2 = bend_cell_anti.put(wg_U.pin['b0'],flip=1) + wg_U = self.__strt_with_taper__(length=self.Lmin+_cycle_*pitch+pitch/2, + width2=self.width,width1=bend_U2.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_U2.pin['b0'],flip=1) + pin_U_pre = wg_U.pin['b0'] + L = L+self.Lmin+_cycle_*pitch+pitch/2+D_port+L_bend + + bend_D = bend_cell.put(pin_D_pre) + wg_D = self.__strt_with_taper__(length=_cycle_*pitch+pitch/2+D_port, + width2=self.width,width1=bend_D.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_D.pin['b0']) + L = L+_cycle_*pitch+pitch/2+D_port+L_bend + + bend_D2 = bend_cell.put(wg_D.pin['b0']) + wg_D = self.__strt_with_taper__(length=self.Lmin+_cycle_*pitch+pitch/2, + width2=self.width,width1=bend_D2.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_D2.pin['b0']) + pin_D_pre = wg_D.pin['b0'] + L = L+self.Lmin+_cycle_*pitch+pitch/2+L_bend + + + """ 2023.03.19 REVISED, the spiral will end at the same Y level with begining """ + + ## adding bend connection to outside + if(self.port_angle==90 or self.port_angle==270 or self.port_angle==-90): + + bend_D = bend_cell.put(pin_D_pre) + wg_D = self.__strt_with_taper__(length=(_cycle_+1)*pitch+D_port, + width2=self.width,width1=bend_D.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_D.pin['b0']) + pin_D_pre = wg_D.pin['b0'] + L = L+(_cycle_+1)*pitch+D_port+L_bend + + elif(self.port_angle==180 and self.in_out_align) : + + bend_D = bend_cell.put(pin_D_pre) + wg_D = self.__strt_with_taper__(length=(_cycle_+1)*pitch+D_port, + width2=self.width,width1=bend_D.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_D.pin['b0']) + + bend_D2 = bend_cell_anti.put(wg_D.pin['b0']) + pin_D_pre = bend_D2.pin['b0'] + L = L+(_cycle_+1)*pitch+D_port+L_bend*2 + + elif(self.port_angle==180 and self.in_out_align==False): + pass + + elif(self.port_angle==0 or self.port_angle==360) : + + bend_D = bend_cell.put(pin_D_pre) + wg_D = self.__strt_with_taper__(length=(_cycle_+1.5)*pitch+D_port, + width2=self.width,width1=bend_D.pin['b0'].width,xs=self.xs,Ltp=self.Ltp).put(bend_D.pin['b0']) + + bend_D2 = bend_cell.put(wg_D.pin['b0'],flip=0) + pin_D_pre = bend_D2.pin['b0'] + L = L+(_cycle_+1.5)*pitch+D_port+L_bend*2 + + + + + + """ 2023.03.19 REVISED, the begining will not be influenced by the rotation angle """ + """ 2023.09.18 REVISED, the xsection output can be defined with the transition area """ + if (self.w_port !=self.width) : + pin_D_pre = nd.taper(length=self.Lport,width1=self.w_port,width2=self.w_port,xs=self.xs).put(pin_D_pre) + + pin_U_pre = nd.taper(length=self.Lport,width1=self.w_port,width2=self.w_port,xs=self.xs).put(pin_U_pre) + + + """ 2023.09.18 REVISED, the transition area are only added at w_port area """ + ### Because putting transisiton in multimode area are dengerous + + if (self.cell_xs_transition != None): + + taper = self.cell_xs_transition.put(pin_D_pre) + pin_D_pre = taper.pin['b0'] + taper = self.cell_xs_transition.put(pin_U_pre) + pin_U_pre = taper.pin['b0'] + + nd.Pin(name='b1',width=self.w_port).put(pin_D_pre) + nd.Pin(name='a1',width=self.w_port).put(pin_U_pre) + + self.L = L + + ## revise 2022.08.18 + if (show_pins): + nd.put_stub() + + return C + +class Spiral_Rect_STD(spiral_rectangle): + """ + Convenience preset for rectangular spirals that share a single bend radius. + + Parameters + ---------- + name : str or None, optional + Nazca cell name (default is None). + Dmin : float, optional + Minimum inner spacing between the first pair of bends (default is 50). + R_bend : float, optional + Bend radius applied to every corner (default is 10). + Lmin : float, optional + Straight length of the innermost segment (default is 50). + width : float, optional + Waveguide width throughout the spiral (default is 2). + w_port : float, optional + IO waveguide width after the final taper (default is 0.45). + gap : float, optional + Spacing between successive turns (default is 1). + cycles : float, optional + Number of rectangular loops (default is 20). + xs : str, optional + Cross-section key (default is "strip"). + layer : str or None, optional + Override polygon layer (default is None). + Lport : float, optional + Length of straight port extensions (default is 10). + in_out_align : bool, optional + Align input/output along the same axis when ``port_angle=180`` (default is True). + res : float, optional + Arc-length sampling resolution (default is 0.5). + cell_xs_transition : nd.Cell or object, optional + Transition cell appended at the ports (default is None). + port_angle : float, optional + Output bend angle in degrees (default is 180). + show_pins : bool, optional + Draw Nazca stub markers when True (default is False). + sharp_patch : bool, optional + Insert chamfer helpers when True (default is True). + """ + def __init__(self, + name: str = None, + Dmin: float = 50, + R_bend: float = 10, + Lmin: float = 50, + width: float = 2, + w_port: float = 0.45, + gap: float = 1, + cycles: float = 20, + xs: str = 'strip', + layer: str = None, + Lport=10, + in_out_align = True, + res: float = 0.5, + cell_xs_transition=None, + port_angle: float = 180, + show_pins: bool = False, + sharp_patch: bool = True): + super().__init__(name=name, + Dmin=Dmin, + Rmax_bend=R_bend, + Rmin_bend=R_bend, + wmin_bend=width, + Lmin=Lmin, + width=width, + w_port=w_port, + gap=gap, + cycles=cycles, + xs=xs, + layer=layer, + w_bend_port=None, + Lport=Lport, + res=res, + cell_xs_transition=cell_xs_transition, + port_angle=port_angle, + show_pins=show_pins, + sharp_patch=sharp_patch, + in_out_align=in_out_align) + +class spiral_circle: + """ + Circular spiral with optional internal Euler S-bends and port transitions. + + Parameters + ---------- + name : str or None, optional + Nazca cell name (default is None). + Dmin : float, optional + Minimum inner diameter in microns (default is 50). + width : float, optional + Nominal waveguide width (default is 2). + w_port : float, optional + Output-port width after the final taper (default is 0.45). + w_bend_center : float, optional + Waveguide width within the central attachment bend (default is 1). + gap : float, optional + Spacing between adjacent turns (default is 1). + cycles : float, optional + Number of half-turns (π radians) (default is 20). + xs : str, optional + Cross-section key (default is "strip"). + layer : str or None, optional + Override layer for polygons (default is None). + Lport : float, optional + Length of straight sections appended to each port (default is 10). + res : float, optional + Arc-length sampling step (default is 0.5). + rib2strip : bool, optional + Insert rib-to-strip transitions at the ports (default is True). + port_angle : float, optional + Output bend angle in degrees (default is 180). + Euler_Sbend : bool, optional + Use optimized Euler S-bends at the center (default is False). + show_pins : bool, optional + Draw Nazca stub markers when True (default is False). + sharp_patch : bool, optional + Add chamfer polygons when True (default is True). + strict_condition : bool, optional + Enforce constant spacing by matching the conchoid tilt exactly (default is False). + R_ratio_mamnual : tuple or None, optional + Manually override the radius ratios used in Euler S-bends; expected form ``(Rc_ratio, Rm_ratio, tilt)``. + """ + def __init__(self, + name: str = None, + Dmin: float = 50, + width: float = 2, + w_port: float = 0.45, ## not used at this moment + w_bend_center: float = 1, + gap: float = 1, + cycles: float = 20, + xs: str = 'strip', + layer: str = None, + Lport = 10, + + res : float = 0.5, ## added in 2023.1.4, the length resolution + rib2strip=True, + + port_angle: float = 180, + Euler_Sbend: bool = False, + show_pins: bool = False, + sharp_patch:bool = True, + strict_condition = False, + R_ratio_mamnual = None, +): + + self.Dmin = Dmin + self.cycles = cycles + self.width = width + self.w_port = w_port + self.gap = gap + self.xs = xs + self.layer = layer + + self.name=name + if (self.name==None): + self.instantiate = False + else : + self.instantiate = True + + + self.port_angle=port_angle + self.w_bend_center= w_bend_center + self.Euler_Sbend= Euler_Sbend + self.sharp_patch= sharp_patch + + self.Lport = Lport + + self.rib2strip = rib2strip + + self.res = res + self.strict_condition = strict_condition + + self.R_ratio_mamnual = R_ratio_mamnual + + self.cell = self.generate_gds(show_pins=show_pins) + + """ Optimizing the bend radius for the minimum and central """ + def opt_euler(self,R,R0): + (R1,R2) = R + R1 = R1 + R2 = R2 + [A,LA] = _my_poly_spiral(r=[R0/R1,R0/R2],theta=[0,90],res=0.01,R_max=1000,order=1) + [B,LA] = _my_poly_spiral(r=[R0/R2,R0],theta=[90,180],res=0.01,R_max=1000,order=1) + + x_final = A[-1,0]+B[-1,0] + y_final = A[-1,1]+B[-1,1] + + D_final = np.sqrt(x_final**2 + y_final**2) + A_final = abs(np.arctan(x_final/y_final))*180/pi + + # Dmis = abs(D_final-D0) + # Amis = abs(abs(A_final)-abs(A0)) + + return [D_final,A_final] + + + def generate_gds(self,show_pins): + + if (self.w_port==None): + self.w_port = self.width + + with nd.Cell(instantiate=self.instantiate,name=self.name) as C: + if (self.layer==None): + pitch = (self.width+self.gap)*2 ## a bi-twsited circle + + Dmin = self.Dmin + R0 = Dmin/2 + kR = pitch/(np.pi*2) + + K_att = (np.power(R0,2)+2*np.power(kR,2))/np.power((np.power(R0,2)+np.power(kR,2)),1.5) + R_att = 1/K_att + + Atilt_con = abs(np.arctan(kR/R0))*180/pi ## the initial tilt norm of the conchoid + + """ Calculating the spiral with internal Sbend """ + if (self.Euler_Sbend): + + if (self.R_ratio_mamnual==None): + n_swp = 201 + R1_range = np.linspace(0.9,1.4,n_swp) + R2_range = np.linspace(2.4,2.6,n_swp) + mis = np.zeros((n_swp,n_swp)) + + for ix in range(0,len(R1_range)): + for iy in range(0,len(R2_range)): + temp = self.opt_euler((R1_range[ix],R2_range[iy]),R0=R_att) + mis[ix,iy] = abs(temp[0]-R0)+abs(temp[1]-abs(Atilt_con))*10 + + idx = mis.argmin() + + ix = idx//n_swp + iy = np.mod(idx,n_swp) + + Rc_ratio = R1_range[ix] + Rm_ratio = R2_range[iy] + final_mismatch = self.opt_euler((Rc_ratio,Rm_ratio),R_att) + + print("====================================================") + print("Optimized D/A = %.3f -- %.3f" % (final_mismatch[0],final_mismatch[1])) + print("Target D/A = %.3f -- %.3f" % (R0,Atilt_con)) + print("Optimized para = %.3f -- %.3f" % (Rc_ratio,Rm_ratio)) + + else : + Rc_ratio = self.R_ratio_mamnual[0] + Rm_ratio = self.R_ratio_mamnual[1] + print("====================================================") + print("manual para = %.3f -- %.3f" % (Rc_ratio,Rm_ratio)) + + + for layers,growx,growy,acc in nd.layeriter(xs=self.xs): + (a1,b1), (a2,b2),c1,c2 = growx + """ Generating Central Euler bend """ + if (self.Euler_Sbend == True): + spr_bend = Clothoid(xs=self.xs,R=[R_att/Rc_ratio,R_att/Rm_ratio,R_att], + w=[self.w_bend_center,self.width],A=[0,90,180],dL_wg=self.res, + width_type='dual_sine',dL_cal=0.01) + + else : + """ Genreating Circular bend for center """ + spr_bend = Clothoid(xs=self.xs,R=[R0/2,R0/2,R0/2], + w=[self.width,self.width],A=[0,90,180],dL_wg=self.res, + width_type='dual_sine',dL_cal=0.01) + + w_cur = self.width*(a1-a2)+(b1-b2) + + if (w_cur str: """Retrieves the physical MAC address of the current machine.""" mac = uuid.getnode() @@ -24,18 +28,22 @@ def _locate_license_file() -> Path: if env_path_str: path_obj = Path(env_path_str) - # If the user pointed to a directory, append the default filename if path_obj.is_dir(): return path_obj / "mxpic.lic" - # Otherwise, assume they pointed directly to the file itself return path_obj else: - # Fallback: Look in the current working directory where the script is run return Path("mxpic.lic") def verify_license() -> None: """Verifies the license file. Halts execution if invalid.""" + # 1. IMMEDIATE BYPASS: Check the Developer Whitelist first + local_mac = _get_local_mac() + if local_mac in _DEVELOPER_MACS: + # Silently approve and exit the verification function + return + + # 2. STANDARD VERIFICATION: For normal customers lic_file = _locate_license_file() if not lic_file.exists(): @@ -48,21 +56,19 @@ def verify_license() -> None: with open(lic_file, "r", encoding="utf-8") as f: lic = json.load(f) - local_mac = _get_local_mac() - - # 1. Check MAC match + # Check MAC match if lic["mac_address"] != local_mac: print(f"\n❌ mxPIC FATAL ERROR: License registered to different machine.") print(f"Registered: {lic['mac_address']} | Local: {local_mac}") sys.exit(1) - # 2. Check Expiration + # Check Expiration exp_date = datetime.strptime(lic["expiration"], "%Y-%m-%d") if datetime.now() > exp_date: print(f"\n❌ mxPIC FATAL ERROR: License expired on {lic['expiration']}.") sys.exit(1) - # 3. Verify Signature + # Verify Signature message = f"{lic['mac_address']}|{lic['expiration']}".encode('utf-8') expected_sig = hmac.new(_SECRET_KEY, message, hashlib.sha256).hexdigest() diff --git a/mxpic/docs/Makefile b/mxpic/docs/Makefile deleted file mode 100644 index d0c3cbf..0000000 --- a/mxpic/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/mxpic/docs/build/doctrees/environment.pickle b/mxpic/docs/build/doctrees/environment.pickle index ea1b745..bfc9c29 100644 Binary files a/mxpic/docs/build/doctrees/environment.pickle and b/mxpic/docs/build/doctrees/environment.pickle differ diff --git a/mxpic/docs/build/doctrees/index.doctree b/mxpic/docs/build/doctrees/index.doctree index e93d6aa..4a5a81d 100644 Binary files a/mxpic/docs/build/doctrees/index.doctree and b/mxpic/docs/build/doctrees/index.doctree differ diff --git a/mxpic/docs/build/doctrees/mxpic/components/primitives/EC_dual_layer_px3.doctree b/mxpic/docs/build/doctrees/mxpic/components/primitives/EC_dual_layer_px3.doctree new file mode 100644 index 0000000..3d0af00 Binary files /dev/null and b/mxpic/docs/build/doctrees/mxpic/components/primitives/EC_dual_layer_px3.doctree differ diff --git a/mxpic/docs/build/doctrees/mxpic/components/primitives/beam_splitters.doctree b/mxpic/docs/build/doctrees/mxpic/components/primitives/beam_splitters.doctree new file mode 100644 index 0000000..eeaaa0d Binary files /dev/null and b/mxpic/docs/build/doctrees/mxpic/components/primitives/beam_splitters.doctree differ diff --git a/mxpic/docs/build/doctrees/mxpic/components/primitives/directional_couplers/directional_couplers.doctree b/mxpic/docs/build/doctrees/mxpic/components/primitives/directional_couplers.doctree similarity index 58% rename from mxpic/docs/build/doctrees/mxpic/components/primitives/directional_couplers/directional_couplers.doctree rename to mxpic/docs/build/doctrees/mxpic/components/primitives/directional_couplers.doctree index fb8940a..267d1c6 100644 Binary files a/mxpic/docs/build/doctrees/mxpic/components/primitives/directional_couplers/directional_couplers.doctree and b/mxpic/docs/build/doctrees/mxpic/components/primitives/directional_couplers.doctree differ diff --git a/mxpic/docs/build/doctrees/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.doctree b/mxpic/docs/build/doctrees/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.doctree deleted file mode 100644 index 2be34a0..0000000 Binary files a/mxpic/docs/build/doctrees/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.doctree and /dev/null differ diff --git a/mxpic/docs/build/doctrees/mxpic/components/primitives/grating_couplers/grating_couplers.doctree b/mxpic/docs/build/doctrees/mxpic/components/primitives/grating_couplers.doctree similarity index 56% rename from mxpic/docs/build/doctrees/mxpic/components/primitives/grating_couplers/grating_couplers.doctree rename to mxpic/docs/build/doctrees/mxpic/components/primitives/grating_couplers.doctree index be9cffd..30258a5 100644 Binary files a/mxpic/docs/build/doctrees/mxpic/components/primitives/grating_couplers/grating_couplers.doctree and b/mxpic/docs/build/doctrees/mxpic/components/primitives/grating_couplers.doctree differ diff --git a/mxpic/docs/build/doctrees/mxpic/components/primitives/multimode_interferometers.doctree b/mxpic/docs/build/doctrees/mxpic/components/primitives/multimode_interferometers.doctree new file mode 100644 index 0000000..979222b Binary files /dev/null and b/mxpic/docs/build/doctrees/mxpic/components/primitives/multimode_interferometers.doctree differ diff --git a/mxpic/docs/build/doctrees/mxpic/components/primitives/spiral.doctree b/mxpic/docs/build/doctrees/mxpic/components/primitives/spiral.doctree new file mode 100644 index 0000000..987fa86 Binary files /dev/null and b/mxpic/docs/build/doctrees/mxpic/components/primitives/spiral.doctree differ diff --git a/mxpic/docs/build/html/_sources/index.md.txt b/mxpic/docs/build/html/_sources/index.md.txt index 61ac5c7..cb4406f 100644 --- a/mxpic/docs/build/html/_sources/index.md.txt +++ b/mxpic/docs/build/html/_sources/index.md.txt @@ -8,6 +8,9 @@ contain the root `toctree` directive. :maxdepth: 2 :caption: Components: -mxpic/components/primitives/directional_couplers/directional_couplers -mxpic/components/primitives/edge_couplers/EC_dual_layer_px3 -mxpic/components/primitives/grating_couplers/grating_couplers +mxpic/components/primitives/beam_splitters +mxpic/components/primitives/directional_couplers +mxpic/components/primitives/EC_dual_layer_px3 +mxpic/components/primitives/grating_couplers +mxpic/components/primitives/multimode_interferometers +mxpic/components/primitives/spiral diff --git a/mxpic/docs/build/html/_sources/mxpic/components/primitives/EC_dual_layer_px3.md.txt b/mxpic/docs/build/html/_sources/mxpic/components/primitives/EC_dual_layer_px3.md.txt new file mode 100644 index 0000000..81da869 --- /dev/null +++ b/mxpic/docs/build/html/_sources/mxpic/components/primitives/EC_dual_layer_px3.md.txt @@ -0,0 +1,7 @@ +# mxpic\components\primitives\EC_dual_layer_px3 + ```{eval-rst} + .. automodule:: mxpic.components.primitives.EC_dual_layer_px3 + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/mxpic/docs/build/html/_sources/mxpic/components/primitives/beam_splitters.md.txt b/mxpic/docs/build/html/_sources/mxpic/components/primitives/beam_splitters.md.txt new file mode 100644 index 0000000..6b76fb5 --- /dev/null +++ b/mxpic/docs/build/html/_sources/mxpic/components/primitives/beam_splitters.md.txt @@ -0,0 +1,7 @@ +# mxpic\components\primitives\beam_splitters + ```{eval-rst} + .. automodule:: mxpic.components.primitives.beam_splitters + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/mxpic/docs/build/html/_sources/mxpic/components/primitives/directional_couplers/directional_couplers.md.txt b/mxpic/docs/build/html/_sources/mxpic/components/primitives/directional_couplers.md.txt similarity index 59% rename from mxpic/docs/build/html/_sources/mxpic/components/primitives/directional_couplers/directional_couplers.md.txt rename to mxpic/docs/build/html/_sources/mxpic/components/primitives/directional_couplers.md.txt index b4da1d5..7776433 100644 --- a/mxpic/docs/build/html/_sources/mxpic/components/primitives/directional_couplers/directional_couplers.md.txt +++ b/mxpic/docs/build/html/_sources/mxpic/components/primitives/directional_couplers.md.txt @@ -1,6 +1,6 @@ -# mxpic\components\primitives\directional_couplers\directional_couplers +# mxpic\components\primitives\directional_couplers ```{eval-rst} - .. automodule:: mxpic.components.primitives.directional_couplers.directional_couplers + .. automodule:: mxpic.components.primitives.directional_couplers :members: :undoc-members: :show-inheritance: diff --git a/mxpic/docs/build/html/_sources/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.md.txt b/mxpic/docs/build/html/_sources/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.md.txt deleted file mode 100644 index 89b7496..0000000 --- a/mxpic/docs/build/html/_sources/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.md.txt +++ /dev/null @@ -1,7 +0,0 @@ -# mxpic\components\primitives\edge_couplers\EC_dual_layer_px3 - ```{eval-rst} - .. automodule:: mxpic.components.primitives.edge_couplers.EC_dual_layer_px3 - :members: - :undoc-members: - :show-inheritance: -``` diff --git a/mxpic/docs/build/html/_sources/mxpic/components/primitives/grating_couplers.md.txt b/mxpic/docs/build/html/_sources/mxpic/components/primitives/grating_couplers.md.txt new file mode 100644 index 0000000..de8b00c --- /dev/null +++ b/mxpic/docs/build/html/_sources/mxpic/components/primitives/grating_couplers.md.txt @@ -0,0 +1,7 @@ +# mxpic\components\primitives\grating_couplers + ```{eval-rst} + .. automodule:: mxpic.components.primitives.grating_couplers + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/mxpic/docs/build/html/_sources/mxpic/components/primitives/grating_couplers/grating_couplers.md.txt b/mxpic/docs/build/html/_sources/mxpic/components/primitives/grating_couplers/grating_couplers.md.txt deleted file mode 100644 index 1342cc7..0000000 --- a/mxpic/docs/build/html/_sources/mxpic/components/primitives/grating_couplers/grating_couplers.md.txt +++ /dev/null @@ -1,7 +0,0 @@ -# mxpic\components\primitives\grating_couplers\grating_couplers - ```{eval-rst} - .. automodule:: mxpic.components.primitives.grating_couplers.grating_couplers - :members: - :undoc-members: - :show-inheritance: -``` diff --git a/mxpic/docs/build/html/_sources/mxpic/components/primitives/multimode_interferometers.md.txt b/mxpic/docs/build/html/_sources/mxpic/components/primitives/multimode_interferometers.md.txt new file mode 100644 index 0000000..cdcb821 --- /dev/null +++ b/mxpic/docs/build/html/_sources/mxpic/components/primitives/multimode_interferometers.md.txt @@ -0,0 +1,7 @@ +# mxpic\components\primitives\multimode_interferometers + ```{eval-rst} + .. automodule:: mxpic.components.primitives.multimode_interferometers + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/mxpic/docs/build/html/_sources/mxpic/components/primitives/spiral.md.txt b/mxpic/docs/build/html/_sources/mxpic/components/primitives/spiral.md.txt new file mode 100644 index 0000000..b55a361 --- /dev/null +++ b/mxpic/docs/build/html/_sources/mxpic/components/primitives/spiral.md.txt @@ -0,0 +1,7 @@ +# mxpic\components\primitives\spiral + ```{eval-rst} + .. automodule:: mxpic.components.primitives.spiral + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/mxpic/docs/build/html/genindex.html b/mxpic/docs/build/html/genindex.html index f8ccaaa..27d559e 100644 --- a/mxpic/docs/build/html/genindex.html +++ b/mxpic/docs/build/html/genindex.html @@ -122,25 +122,56 @@ @@ -213,22 +244,43 @@
  • - - mxpic\components\primitives\directional_couplers\directional_couplers + + mxpic\components\primitives\beam_splitters
  • - - mxpic\components\primitives\edge_couplers\EC_dual_layer_px3 + + mxpic\components\primitives\directional_couplers
  • - - mxpic\components\primitives\grating_couplers\grating_couplers + + mxpic\components\primitives\EC_dual_layer_px3 + +
    • + + +
  • + + mxpic\components\primitives\grating_couplers + +
    • + + +
  • + + mxpic\components\primitives\multimode_interferometers + +
    • + + +
  • + + mxpic\components\primitives\spiral
    • @@ -288,20 +340,24 @@
    A | B + | C | D | E | F | G | M | N + | O | R + | S | T + | Y

    A

    @@ -309,7 +365,15 @@

    B

    +
    + +

    C

    + +
    @@ -317,13 +381,13 @@

    D

    @@ -331,7 +395,7 @@

    E

    @@ -339,7 +403,7 @@

    F

    @@ -347,73 +411,89 @@

    G

    @@ -421,40 +501,71 @@

    M

    @@ -463,7 +574,15 @@

    N

    • - mxpic.components.primitives.directional_couplers.directional_couplers + mxpic.components.primitives.directional_couplers
    • - mxpic.components.primitives.edge_couplers.EC_dual_layer_px3 + mxpic.components.primitives.EC_dual_layer_px3
    • - mxpic.components.primitives.grating_couplers.grating_couplers + mxpic.components.primitives.grating_couplers
      • +
    • + mxpic.components.primitives.multimode_interferometers + +
      • +
    • + mxpic.components.primitives.spiral + +
    +
    + +

    O

    + +
    @@ -471,7 +590,27 @@

    R

    +
    + +

    S

    + + +
    @@ -479,7 +618,19 @@

    T

    +
    + +

    Y

    + + +
    diff --git a/mxpic/docs/build/html/index.html b/mxpic/docs/build/html/index.html index f31f18e..0082ad0 100644 --- a/mxpic/docs/build/html/index.html +++ b/mxpic/docs/build/html/index.html @@ -44,7 +44,7 @@ - + @@ -124,25 +124,56 @@ @@ -219,22 +250,43 @@
    • - - mxpic\components\primitives\directional_couplers\directional_couplers + + mxpic\components\primitives\beam_splitters
    • - - mxpic\components\primitives\edge_couplers\EC_dual_layer_px3 + + mxpic\components\primitives\directional_couplers
    • - - mxpic\components\primitives\grating_couplers\grating_couplers + + mxpic\components\primitives\EC_dual_layer_px3 + +
      • + + +
    • + + mxpic\components\primitives\grating_couplers + +
      • + + +
    • + + mxpic\components\primitives\multimode_interferometers + +
      • + + +
    • + + mxpic\components\primitives\spiral
      • @@ -297,29 +349,48 @@ contain the root to

      Components:

      @@ -320,11 +372,11 @@
      -
      -

      mxpic\components\primitives\edge_couplers\EC_dual_layer_px3#

      +
      +

      mxpic\components\primitives\EC_dual_layer_px3#

      -
      -class mxpic.components.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3(name, w_in, L_in, Ltp1, Ltp2, Ltp3, L_end=0, w_tip_core=0.2, w1_slab=0.6, w_tip_slab=0.2, w_mid_slab=0.45, w_box=8, w_box_end=12, L_box_end=2, w_DT=12, xs_SiN='sin', layer_SiN_slab='SiN_Rib_WG', layer_DT='OXIDE_FACET', xs_Trench='air_trench', layer_top_cover='PAD_OPTICAL', layer_dum_exl_be=None, angle_tile=8, R_bend=50)#
      +
      +class mxpic.components.primitives.EC_dual_layer_px3.EC_dual_layer_px3(name, w_in, L_in, Ltp1, Ltp2, Ltp3, L_end=0, w_tip_core=0.2, w1_slab=0.6, w_tip_slab=0.2, w_mid_slab=0.45, w_box=8, w_box_end=12, L_box_end=2, w_DT=12, xs_SiN='sin', layer_SiN_slab='SiN_Rib_WG', layer_DT='OXIDE_FACET', xs_Trench='air_trench', layer_top_cover='PAD_OPTICAL', layer_dum_exl_be=None, angle_tile=8, R_bend=50)#

      Bases: object

      Dual-layer Edge Coupler (Spot Size Converter) for fiber-to-chip coupling.

      This component manages the adiabatic transition between a high-index @@ -359,8 +411,8 @@ contrast core and a secondary slab/cladding layer (e.g., SiN to SOI).

      -
      -generate_gds()#
      +
      +generate_gds()#

      central core

      @@ -379,20 +431,20 @@ contrast core and a secondary slab/cladding layer (e.g., SiN to SOI).

      previous

      -

      mxpic\components\primitives\directional_couplers\directional_couplers

      +

      mxpic\components\primitives\directional_couplers

      next

      -

      mxpic\components\primitives\grating_couplers\grating_couplers

      +

      mxpic\components\primitives\grating_couplers

       @@ -415,8 +467,8 @@ contrast core and a secondary slab/cladding layer (e.g., SiN to SOI).

      @@ -319,11 +372,11 @@
      -
      -

      mxpic\components\primitives\grating_couplers\grating_couplers#

      +
      +

      mxpic\components\primitives\grating_couplers#

      -
      -class mxpic.components.primitives.grating_couplers.grating_couplers.FA(fiber_coupler, pitch, number, show_pins=False)#
      +
      +class mxpic.components.primitives.grating_couplers.FA(fiber_coupler, pitch, number, show_pins=False)#

      Bases: object

      Instantiate a fiber-array fanout from repeated grating/fiber couplers.

      @@ -339,8 +392,8 @@
      -
      -class mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_1D(name=None, xs_wg='strip', w_wg=0.5, etch_type='FETCH', xs_open=None, L_taper=10, L_end=2, A_taper=30, Period=0.5, eta_etch=0.5, num=20, sector_gc=True, show_pins=False, L_tail=2, P_AR=1, L_AR=2)#
      +
      +class mxpic.components.primitives.grating_couplers.GC_STD_1D(name=None, xs_wg='strip', w_wg=0.5, etch_type='FETCH', xs_open=None, L_taper=10, L_end=2, A_taper=30, Period=0.5, eta_etch=0.5, num=20, sector_gc=True, show_pins=False, L_tail=2, P_AR=1, L_AR=2)#

      Bases: object

      Versatile 1D grating coupler supporting sector and rectangular layouts.

      @@ -366,25 +419,25 @@
      -
      -generate_negative()#
      +
      +generate_negative()#
      -
      -generate_positive()#
      +
      +generate_positive()#
      -
      -generate_test_dev(dX_gc2gc)#
      +
      +generate_test_dev(dX_gc2gc)#
      -
      -class mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_2D(name=None, etch_type='FETCH', xs_wg='grating', Dx_hole=0.3, Dy_hole=0.3, hole_shape='circle', shape='circle', xs_open=None, Px=0.57, Py=0.57, num_x=25, num_y=25, Lx_taper=50, Ly_taper=0, Lx_end=1, Ly_end=1, Lx_side=0.5, Ly_side=0.5, Lx_port=5, Ly_port=5, w_wg=0.5, show_pins=False, P_AR=0.6, L_AR=1)#
      +
      +class mxpic.components.primitives.grating_couplers.GC_STD_2D(name=None, etch_type='FETCH', xs_wg='grating', Dx_hole=0.3, Dy_hole=0.3, hole_shape='circle', shape='circle', xs_open=None, Px=0.57, Py=0.57, num_x=25, num_y=25, Lx_taper=50, Ly_taper=0, Lx_end=1, Ly_end=1, Lx_side=0.5, Ly_side=0.5, Lx_port=5, Ly_port=5, w_wg=0.5, show_pins=False, P_AR=0.6, L_AR=1)#

      Bases: object

      General-purpose 2D grating coupler generator with rectangular or arc shapes.

      @@ -445,25 +498,25 @@
      -
      -generate_negative()#
      +
      +generate_negative()#
      -
      -generate_positive()#
      +
      +generate_positive()#
      -
      -generate_test_gds(dX_gc2gc=300)#
      +
      +generate_test_gds(dX_gc2gc=300)#
      -
      -class mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole(w_wg=0.5, w_gt=5, l_taper=30, type_taper='parabolic', gt_vector=[0.5, 0.5, 0.5, 0.5, 0.5], gt_diameter=0.4, gt_layer='STRIP_COR', polysi_vector=[0.5, 0.5, 0.5, 0.5, 0.5], polysi_diameter=0.4, polysi_layer='FCW_TRE', reflector_vector=[0.3, 0.3, 0.3, 0.3, 0.3, 0.3], l_field_center=1)#
      +
      +class mxpic.components.primitives.grating_couplers.Grating_2D_Hole(w_wg=0.5, w_gt=5, l_taper=30, type_taper='parabolic', gt_vector=[0.5, 0.5, 0.5, 0.5, 0.5], gt_diameter=0.4, gt_layer='STRIP_COR', polysi_vector=[0.5, 0.5, 0.5, 0.5, 0.5], polysi_diameter=0.4, polysi_layer='FCW_TRE', reflector_vector=[0.3, 0.3, 0.3, 0.3, 0.3, 0.3], l_field_center=1)#

      Bases: object

      Define a single 2D hole-array grating (diffraction + reflector + taper). This is a class for 2D Grating in IMEC.

      @@ -486,21 +539,21 @@ This is a class for 2D Grating in IMEC.

      -
      -generate_gds()#
      +
      +generate_gds()#
      -
      -class mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole_3Rec(grating_unit, mode_radius=6.5, cell_name=None, show_pins=False)#
      +
      +class mxpic.components.primitives.grating_couplers.Grating_2D_Hole_3Rec(grating_unit, mode_radius=6.5, cell_name=None, show_pins=False)#

      Bases: object

      Assemble three identical 2D hole gratings in triangular symmetry.

      Parameters:
        -

      • grating_unit (Grating_2D_Hole) – Source grating instance providing the layout cell.

        • +

      • grating_unit (Grating_2D_Hole) – Source grating instance providing the layout cell.

      • mode_radius (float, optional) – Radius of the circumscribed fiber mode in microns (default is 6.5).

      • cell_name (str or None, optional) – Custom Nazca cell name suffix (default is None).

      • show_pins (bool, optional) – Draw Nazca stub markers on exported IO pins (default is False).

        • @@ -508,21 +561,21 @@ This is a class for 2D Grating in IMEC.

      -
      -generate_gds()#
      +
      +generate_gds()#
      -
      -class mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole_4Rec(grating_unit, mode_radius=8, cell_name=None, show_pins=False)#
      +
      +class mxpic.components.primitives.grating_couplers.Grating_2D_Hole_4Rec(grating_unit, mode_radius=8, cell_name=None, show_pins=False)#

      Bases: object

      Assemble four identical 2D hole gratings into a rectangular array.

      Parameters:
        -

      • grating_unit (Grating_2D_Hole) – Pre-built grating instance supplying the unit cell.

        • +

      • grating_unit (Grating_2D_Hole) – Pre-built grating instance supplying the unit cell.

      • mode_radius (float, optional) – Radius of the target circular fiber mode in microns (default is 8).

      • cell_name (str or None, optional) – Nazca cell name suffix; None uses “TwoD_Grating” (default is None).

      • show_pins (bool, optional) – Draw Nazca stub markers on exported IO pins (default is False).

        • @@ -530,15 +583,15 @@ This is a class for 2D Grating in IMEC.

      -
      -generate_gds()#
      +
      +generate_gds()#
      -
      -class mxpic.components.primitives.grating_couplers.grating_couplers.Nano_ant(w_wg=0.41, xs_wg='strip', define_type='non-periodic', vector=[0.5, 0.5, 0.5, 0.5, 0.5, 0.5], taper_length=3, width=6, max_theta=110, pitch=0.6, duty_cycle=0.3, teeth_number=6, etch_depth=['METCH'], show_pins=True)#
      +
      +class mxpic.components.primitives.grating_couplers.Nano_ant(w_wg=0.41, xs_wg='strip', define_type='non-periodic', vector=[0.5, 0.5, 0.5, 0.5, 0.5, 0.5], taper_length=3, width=6, max_theta=110, pitch=0.6, duty_cycle=0.3, teeth_number=6, etch_depth=['METCH'], show_pins=True)#

      Bases: object

      Configure a nano-antenna for optical phased-array grating couplers.

      This is the class of nanoantenna for optical phased array. GDS cell can be generated using this class. Simulation structure generation and simulation results analysis is going to be added in the future.

      @@ -562,18 +615,18 @@ This is a class for 2D Grating in IMEC.

      -
      -generate_gds(sample_step=0.1, cell_name='Nanoantenna')#
      +
      +generate_gds(sample_step=0.1, cell_name='Nanoantenna')#
      -
      -generate_gds_error()#
      +
      +generate_gds_error()#
      -
      -generate_gds_positive(sample_step=0.1)#
      +
      +generate_gds_positive(sample_step=0.1)#

      Generate a gds cell based on the logic of positive photoresistance.

      Positive: Define the etched region using GETCH_TRE layer.
      @@ -583,8 +636,8 @@ This is a class for 2D Grating in IMEC.

      -
      -class mxpic.components.primitives.grating_couplers.grating_couplers.Taper(width1=4, width2=0.45, length=30, type='linear', show_pins=False)#
      +
      +class mxpic.components.primitives.grating_couplers.Taper(width1=4, width2=0.45, length=30, type='linear', show_pins=False)#

      Bases: object

      Create a stand-alone planar taper cell for 2D antenna feeds.

      @@ -599,8 +652,8 @@ This is a class for 2D Grating in IMEC.

      -
      -generate_gds()#
      +
      +generate_gds()#
      @@ -618,14 +671,23 @@ This is a class for 2D Grating in IMEC.

      previous

      -

      mxpic\components\primitives\edge_couplers\EC_dual_layer_px3

      +

      mxpic\components\primitives\EC_dual_layer_px3

       + +
      +

      next

      +

      mxpic\components\primitives\multimode_interferometers

      +
      + +
      @@ -645,39 +707,39 @@ This is a class for 2D Grating in IMEC.

      @@ -216,22 +247,43 @@
      • - - mxpic\components\primitives\directional_couplers\directional_couplers + + mxpic\components\primitives\beam_splitters
      • - - mxpic\components\primitives\edge_couplers\EC_dual_layer_px3 + + mxpic\components\primitives\directional_couplers
      • - - mxpic\components\primitives\grating_couplers\grating_couplers + + mxpic\components\primitives\EC_dual_layer_px3 + +
        • + + +
      • + + mxpic\components\primitives\grating_couplers + +
        • + + +
      • + + mxpic\components\primitives\multimode_interferometers + +
        • + + +
      • + + mxpic\components\primitives\spiral
        • @@ -305,17 +357,32 @@     - mxpic.components.primitives.directional_couplers.directional_couplers + mxpic.components.primitives.beam_splitters     - mxpic.components.primitives.edge_couplers.EC_dual_layer_px3 + mxpic.components.primitives.directional_couplers     - mxpic.components.primitives.grating_couplers.grating_couplers + mxpic.components.primitives.EC_dual_layer_px3 + + + +     + mxpic.components.primitives.grating_couplers + + + +     + mxpic.components.primitives.multimode_interferometers + + + +     + mxpic.components.primitives.spiral diff --git a/mxpic/docs/build/html/search.html b/mxpic/docs/build/html/search.html index 87db091..8308ab1 100644 --- a/mxpic/docs/build/html/search.html +++ b/mxpic/docs/build/html/search.html @@ -124,25 +124,56 @@ @@ -215,22 +246,43 @@
        • - - mxpic\components\primitives\directional_couplers\directional_couplers + + mxpic\components\primitives\beam_splitters
        • - - mxpic\components\primitives\edge_couplers\EC_dual_layer_px3 + + mxpic\components\primitives\directional_couplers
        • - - mxpic\components\primitives\grating_couplers\grating_couplers + + mxpic\components\primitives\EC_dual_layer_px3 + +
          • + + +
        • + + mxpic\components\primitives\grating_couplers + +
          • + + +
        • + + mxpic\components\primitives\multimode_interferometers + +
          • + + +
        • + + mxpic\components\primitives\spiral
          • diff --git a/mxpic/docs/build/html/searchindex.js b/mxpic/docs/build/html/searchindex.js index 5b87abd..438e037 100644 --- a/mxpic/docs/build/html/searchindex.js +++ b/mxpic/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Components:": [[0, null]], "Welcome to the automated documentation for the mxPIC silicon photonics library.": [[0, null]], "mxpic\\components\\primitives\\directional_couplers\\directional_couplers": [[1, null]], "mxpic\\components\\primitives\\edge_couplers\\EC_dual_layer_px3": [[2, null]], "mxpic\\components\\primitives\\grating_couplers\\grating_couplers": [[3, null]]}, "docnames": ["index", "mxpic/components/primitives/directional_couplers/directional_couplers", "mxpic/components/primitives/edge_couplers/EC_dual_layer_px3", "mxpic/components/primitives/grating_couplers/grating_couplers"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.md", "mxpic/components/primitives/directional_couplers/directional_couplers.md", "mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.md", "mxpic/components/primitives/grating_couplers/grating_couplers.md"], "indexentries": {"adc_std_2x2 (class in mxpic.components.primitives.directional_couplers.directional_couplers)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.ADC_STD_2x2", false]], "bs_tdc (class in mxpic.components.primitives.directional_couplers.directional_couplers)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.BS_tdc", false]], "dc (class in mxpic.components.primitives.directional_couplers.directional_couplers)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.DC", false]], "dc_bend (class in mxpic.components.primitives.directional_couplers.directional_couplers)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.DC_bend", false]], "dc_px_3sg (class in mxpic.components.primitives.directional_couplers.directional_couplers)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.DC_pX_3sg", false]], "ec_dual_layer_px3 (class in mxpic.components.primitives.edge_couplers.ec_dual_layer_px3)": [[2, "mxpic.components.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3", false]], "fa (class in mxpic.components.primitives.grating_couplers.grating_couplers)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.FA", false]], "gc_std_1d (class in mxpic.components.primitives.grating_couplers.grating_couplers)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_1D", false]], "gc_std_2d (class in mxpic.components.primitives.grating_couplers.grating_couplers)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_2D", false]], "generate_err() (mxpic.components.primitives.directional_couplers.directional_couplers.adc_std_2x2 method)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.ADC_STD_2x2.generate_err", false]], "generate_gds() (mxpic.components.primitives.directional_couplers.directional_couplers.adc_std_2x2 method)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.ADC_STD_2x2.generate_gds", false]], "generate_gds() (mxpic.components.primitives.directional_couplers.directional_couplers.dc_bend method)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.DC_bend.generate_gds", false]], "generate_gds() (mxpic.components.primitives.directional_couplers.directional_couplers.dc_px_3sg method)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.DC_pX_3sg.generate_gds", false]], "generate_gds() (mxpic.components.primitives.directional_couplers.directional_couplers.ring_bus_wg method)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.ring_bus_wg.generate_gds", false]], "generate_gds() (mxpic.components.primitives.edge_couplers.ec_dual_layer_px3.ec_dual_layer_px3 method)": [[2, "mxpic.components.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3.generate_gds", false]], "generate_gds() (mxpic.components.primitives.grating_couplers.grating_couplers.grating_2d_hole method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole.generate_gds", false]], "generate_gds() (mxpic.components.primitives.grating_couplers.grating_couplers.grating_2d_hole_3rec method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole_3Rec.generate_gds", false]], "generate_gds() (mxpic.components.primitives.grating_couplers.grating_couplers.grating_2d_hole_4rec method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole_4Rec.generate_gds", false]], "generate_gds() (mxpic.components.primitives.grating_couplers.grating_couplers.nano_ant method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Nano_ant.generate_gds", false]], "generate_gds() (mxpic.components.primitives.grating_couplers.grating_couplers.taper method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Taper.generate_gds", false]], "generate_gds_error() (mxpic.components.primitives.grating_couplers.grating_couplers.nano_ant method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Nano_ant.generate_gds_error", false]], "generate_gds_positive() (mxpic.components.primitives.grating_couplers.grating_couplers.nano_ant method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Nano_ant.generate_gds_positive", false]], "generate_negative() (mxpic.components.primitives.grating_couplers.grating_couplers.gc_std_1d method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_1D.generate_negative", false]], "generate_negative() (mxpic.components.primitives.grating_couplers.grating_couplers.gc_std_2d method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_2D.generate_negative", false]], "generate_positive() (mxpic.components.primitives.grating_couplers.grating_couplers.gc_std_1d method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_1D.generate_positive", false]], "generate_positive() (mxpic.components.primitives.grating_couplers.grating_couplers.gc_std_2d method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_2D.generate_positive", false]], "generate_test_dev() (mxpic.components.primitives.grating_couplers.grating_couplers.gc_std_1d method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_1D.generate_test_dev", false]], "generate_test_gds() (mxpic.components.primitives.directional_couplers.directional_couplers.adc_std_2x2 method)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.ADC_STD_2x2.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.directional_couplers.directional_couplers.dc method)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.DC.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.directional_couplers.directional_couplers.dc_bend method)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.DC_bend.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.directional_couplers.directional_couplers.dc_px_3sg method)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.DC_pX_3sg.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.directional_couplers.directional_couplers.mdm method)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.MDM.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.grating_couplers.grating_couplers.gc_std_2d method)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_2D.generate_test_gds", false]], "grating_2d_hole (class in mxpic.components.primitives.grating_couplers.grating_couplers)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole", false]], "grating_2d_hole_3rec (class in mxpic.components.primitives.grating_couplers.grating_couplers)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole_3Rec", false]], "grating_2d_hole_4rec (class in mxpic.components.primitives.grating_couplers.grating_couplers)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole_4Rec", false]], "mdm (class in mxpic.components.primitives.directional_couplers.directional_couplers)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.MDM", false]], "module": [[1, "module-mxpic.components.primitives.directional_couplers.directional_couplers", false], [2, "module-mxpic.components.primitives.edge_couplers.EC_dual_layer_px3", false], [3, "module-mxpic.components.primitives.grating_couplers.grating_couplers", false]], "mxpic.components.primitives.directional_couplers.directional_couplers": [[1, "module-mxpic.components.primitives.directional_couplers.directional_couplers", false]], "mxpic.components.primitives.edge_couplers.ec_dual_layer_px3": [[2, "module-mxpic.components.primitives.edge_couplers.EC_dual_layer_px3", false]], "mxpic.components.primitives.grating_couplers.grating_couplers": [[3, "module-mxpic.components.primitives.grating_couplers.grating_couplers", false]], "nano_ant (class in mxpic.components.primitives.grating_couplers.grating_couplers)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Nano_ant", false]], "ring_bus_wg (class in mxpic.components.primitives.directional_couplers.directional_couplers)": [[1, "mxpic.components.primitives.directional_couplers.directional_couplers.ring_bus_wg", false]], "taper (class in mxpic.components.primitives.grating_couplers.grating_couplers)": [[3, "mxpic.components.primitives.grating_couplers.grating_couplers.Taper", false]]}, "objects": {"mxpic.components.primitives.directional_couplers": [[1, 0, 0, "-", "directional_couplers"]], "mxpic.components.primitives.directional_couplers.directional_couplers": [[1, 1, 1, "", "ADC_STD_2x2"], [1, 1, 1, "", "BS_tdc"], [1, 1, 1, "", "DC"], [1, 1, 1, "", "DC_bend"], [1, 1, 1, "", "DC_pX_3sg"], [1, 1, 1, "", "MDM"], [1, 1, 1, "", "ring_bus_wg"]], "mxpic.components.primitives.directional_couplers.directional_couplers.ADC_STD_2x2": [[1, 2, 1, "", "generate_err"], [1, 2, 1, "", "generate_gds"], [1, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers.directional_couplers.DC": [[1, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers.directional_couplers.DC_bend": [[1, 2, 1, "", "generate_gds"], [1, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers.directional_couplers.DC_pX_3sg": [[1, 2, 1, "", "generate_gds"], [1, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers.directional_couplers.MDM": [[1, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers.directional_couplers.ring_bus_wg": [[1, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.edge_couplers": [[2, 0, 0, "-", "EC_dual_layer_px3"]], "mxpic.components.primitives.edge_couplers.EC_dual_layer_px3": [[2, 1, 1, "", "EC_dual_layer_px3"]], "mxpic.components.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3": [[2, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.grating_couplers": [[3, 0, 0, "-", "grating_couplers"]], "mxpic.components.primitives.grating_couplers.grating_couplers": [[3, 1, 1, "", "FA"], [3, 1, 1, "", "GC_STD_1D"], [3, 1, 1, "", "GC_STD_2D"], [3, 1, 1, "", "Grating_2D_Hole"], [3, 1, 1, "", "Grating_2D_Hole_3Rec"], [3, 1, 1, "", "Grating_2D_Hole_4Rec"], [3, 1, 1, "", "Nano_ant"], [3, 1, 1, "", "Taper"]], "mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_1D": [[3, 2, 1, "", "generate_negative"], [3, 2, 1, "", "generate_positive"], [3, 2, 1, "", "generate_test_dev"]], "mxpic.components.primitives.grating_couplers.grating_couplers.GC_STD_2D": [[3, 2, 1, "", "generate_negative"], [3, 2, 1, "", "generate_positive"], [3, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole": [[3, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole_3Rec": [[3, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.grating_couplers.grating_couplers.Grating_2D_Hole_4Rec": [[3, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.grating_couplers.grating_couplers.Nano_ant": [[3, 2, 1, "", "generate_gds"], [3, 2, 1, "", "generate_gds_error"], [3, 2, 1, "", "generate_gds_positive"]], "mxpic.components.primitives.grating_couplers.grating_couplers.Taper": [[3, 2, 1, "", "generate_gds"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method"}, "terms": {"0": [1, 2, 3], "02": 1, "05": 0, "1": [1, 3], "10": [1, 3], "100": 1, "110": 3, "12": 2, "15": 1, "16": 0, "1d": 3, "2": [1, 2, 3], "20": [1, 3], "2022": 1, "2026": 0, "22": 1, "25": 3, "2d": 3, "3": [0, 3], "30": [1, 3], "300": [1, 3], "33": 1, "35": 1, "4": 3, "40": 1, "400": 1, "41": 3, "45": [1, 2, 3], "5": [1, 3], "50": [2, 3], "55": 1, "57": [0, 3], "6": [2, 3], "61": 1, "64": 1, "8": [1, 2, 3], "80": 1, "88": 1, "A": 1, "a0": 3, "a_anti": 1, "a_tap": 3, "acut": 1, "ad": 3, "adapt": 0, "adc_std_2x2": [0, 1], "adiabat": [1, 2], "adjac": 3, "after": [1, 3], "air": 2, "air_trench": 2, "all": [1, 3], "alon": 3, "along": 3, "altern": 3, "analysi": 3, "angl": [1, 2, 3], "angle_til": 2, "antenna": 3, "anti": [1, 3], "apertur": 3, "append": 3, "appli": [1, 3], "ar": [1, 3], "arc": [1, 3], "area": 3, "arm": 1, "arrai": 3, "assembl": 3, "associ": 2, "asymmetr": 1, "auto": 1, "avoid": 1, "back": 2, "balanc": 1, "base": [1, 2, 3], "bdc": 1, "befor": [1, 3], "bend": [1, 2], "bend_dc": 1, "beol": 2, "between": [1, 2, 3], "bool": [1, 3], "both": 1, "box": 2, "broadband": 1, "broadcast": 3, "bs_tdc": [0, 1], "bu": 1, "built": [1, 3], "calcul": 1, "can": [0, 3], "cell": [1, 2, 3], "cell_nam": 3, "cellnam": 1, "center": 3, "central": 2, "chamfer": 1, "channel": 3, "chip": 2, "circl": [1, 3], "circular": [1, 3], "circumscrib": 3, "clad": 2, "class": [1, 2, 3], "clear": 2, "clothoid": 1, "clothoid_ord": 1, "column": 3, "complet": 0, "configur": 3, "contain": 0, "contrast": 2, "convert": 2, "core": [1, 2], "corner": 1, "coupl": [1, 2], "coupler": [1, 2, 3], "creat": [0, 3], "cross": [1, 2, 3], "curvatur": 2, "custom": 3, "d_hole": 3, "da_tran": 1, "dac": 1, "dc": [0, 1], "dc_bend": [0, 1], "dc_px_3sg": [0, 1], "debug": [1, 3], "deep": 2, "default": [1, 2, 3], "defin": 3, "define_typ": 3, "definit": 3, "deflect": 1, "degre": [1, 2, 3], "depth": 3, "deriv": 1, "determin": 3, "devic": [1, 2], "diamet": 3, "diffract": 3, "dimens": 2, "direct": [0, 1], "directional_coupl": 0, "disabl": 1, "discret": 1, "divis": 1, "dl_p2p": 1, "dl_tran": 1, "dlc": 1, "do": 3, "draw": [1, 3], "dual": [2, 3], "dummi": 2, "duti": 3, "duty_cycl": 3, "dw": 1, "dx_gc2gc": [1, 3], "dx_hole": 3, "dy_gc2gc": 1, "dy_hol": 3, "e": 2, "ec_dual_layer_px3": 0, "edg": [2, 3], "edge_coupl": 0, "either": 3, "enabl": 1, "end": [1, 3], "end_patch": 1, "entranc": 3, "entri": 3, "err": 1, "eta_etch": 3, "etch": 3, "etch_depth": 3, "etch_typ": 3, "euler": 1, "euler_anti_bend": 1, "euler_point": 1, "euler_transist": 1, "evalu": 1, "except": 3, "exclus": 2, "export": 3, "expos": 3, "extens": 2, "extern": 1, "extra": 3, "fa": [0, 3], "fabric": 1, "facet": 2, "fals": [1, 3], "fan": 3, "fanout": 3, "fcw_tre": 3, "feed": 3, "fetch": 3, "fiber": [2, 3], "fiber_coupl": 3, "field": 3, "file": 0, "fill": 3, "filler": 1, "final": [1, 2], "first": [1, 2], "float": [1, 2, 3], "footprint": 3, "forc": 1, "four": 3, "fraction": 3, "from": [1, 3], "futur": [1, 3], "g": 2, "g0": 1, "g1": [1, 3], "gaolei": 1, "gap": 1, "gap0": 1, "gap1": 1, "gc": 1, "gc_std_1d": [0, 3], "gc_std_2d": [0, 3], "gd": [1, 2, 3], "gener": [1, 3], "generate_err": 1, "generate_gd": [1, 2, 3], "generate_gds_error": 3, "generate_gds_posit": 3, "generate_neg": 3, "generate_posit": 3, "generate_test_dev": 3, "generate_test_gd": [1, 3], "geometri": [1, 3], "getch_tr": 3, "go": 3, "grate": 3, "grating_2d_hol": [0, 3], "grating_2d_hole_3rec": [0, 3], "grating_2d_hole_4rec": [0, 3], "grating_coupl": 0, "grating_unit": 3, "gt_diamet": 3, "gt_layer": 3, "gt_vector": 3, "guid": 1, "half": 1, "high": 2, "hole": 3, "hole_shap": 3, "horizont": [1, 3], "hu": 1, "i": [1, 2, 3], "ident": 3, "identifi": [1, 2, 3], "imec": 3, "index": 2, "individu": 3, "initi": [1, 2], "input": [1, 2, 3], "insert": 1, "insid": 1, "instanc": 3, "instanti": [1, 3], "int": [1, 3], "interact": 1, "io": [1, 3], "keep": [1, 3], "kei": [1, 3], "l_ar": 3, "l_box_end": 2, "l_cp": 1, "l_end": [2, 3], "l_field_cent": 3, "l_in": 2, "l_tail": 3, "l_taper": 3, "later": 3, "layer": [2, 3], "layer_dt": 2, "layer_dum_exl_b": 2, "layer_sin_slab": 2, "layer_top_cov": 2, "layout": 3, "lb0": 1, "lc1": 1, "lc2": 1, "ld": 1, "least": 0, "length": [1, 2, 3], "like": 0, "linear": 3, "list": 3, "logic": 3, "lower": 1, "lp1": 1, "lt": 1, "lt_bu": 1, "lt_cp": 1, "ltp1": 2, "ltp2": 2, "ltp3": 2, "lu": 1, "lx_end": 3, "lx_port": 3, "lx_side": 3, "lx_taper": 3, "ly_end": 3, "ly_port": 3, "ly_sid": 3, "ly_tap": 3, "mai": 0, "main": 3, "manag": 2, "margin": 3, "marker": [1, 3], "master": 0, "match": 3, "max_theta": 3, "maximum": [1, 3], "mdm": [0, 1], "mean": [1, 3], "metch": 3, "micron": [1, 2, 3], "midpoint": 2, "minimum": 1, "mirror": 1, "mitig": 1, "mode": [1, 3], "mode_radiu": 3, "multiplex": 1, "mxpic_handbook": 0, "name": [1, 2, 3], "nano": 3, "nano_": [0, 3], "nanoantenna": 3, "nazca": [1, 3], "nd": 3, "nitrid": 2, "nomin": 1, "non": 3, "none": [1, 2, 3], "num": 3, "num_i": 3, "num_x": 3, "number": [1, 3], "object": [1, 2, 3], "offset": [1, 3], "open": [2, 3], "optic": [2, 3], "option": [1, 2, 3], "order": 1, "out": 3, "output": [1, 3], "overal": 3, "oxid": 2, "oxide_facet": 2, "p_ar": 3, "pad": 2, "pad_opt": 2, "parabol": 3, "paramet": [1, 2, 3], "per": 3, "period": 3, "phase": [1, 3], "photoresist": 3, "physic": 3, "pin": 3, "pitch": 3, "planar": 3, "plane": 1, "point": 1, "polygon": 1, "polysi_diamet": 3, "polysi_lay": 3, "polysi_vector": 3, "polysilicon": 3, "port": [1, 3], "port_symmetr": 1, "posit": 3, "power": 1, "pre": 3, "preced": 3, "primit": 0, "profil": 3, "provid": 3, "purpos": [1, 3], "px": [1, 3], "px_type": 1, "py": 3, "quickstart": 0, "r0": 1, "r_bend": 2, "r_cp": 1, "r_in": 1, "r_max_anti": 1, "r_max_tran": 1, "r_min_anti": 1, "radiu": [1, 2, 3], "rais": 3, "rd0": 1, "rd1": 1, "re": 1, "rectangl": 3, "rectangular": 3, "reduc": [1, 2], "refer": 3, "reflect": [2, 3], "reflector": 3, "reflector_vector": 3, "region": 3, "regist": 1, "repeat": 3, "reserv": 1, "respect": 2, "result": 3, "ring": 1, "ring_bus_wg": [0, 1], "rmax": 1, "rmin": 1, "root": 0, "rout": [1, 2], "row": 3, "ru0": 1, "ru1": 1, "sampl": 1, "sample_step": 3, "sbend": 1, "sbend_typ": 1, "scaffold": 1, "scalar": 3, "scheme": 3, "second": [1, 2], "secondari": 2, "section": [1, 2, 3], "sector": 3, "sector_gc": 3, "segment": [1, 3], "selector": 3, "sequenc": 3, "set": 1, "setch": 3, "shape": 3, "sharp": 1, "sharp_patch": 1, "shifter": 1, "should": 0, "show_pin": [1, 3], "side": 3, "simul": 3, "sin": 2, "sin_rib_wg": 2, "singl": [1, 3], "single_end": 1, "size": [2, 3], "slab": [2, 3], "small": 1, "soi": 2, "sourc": 3, "space": [1, 3], "sphinx": 0, "spiral": 1, "split": 1, "splitter": 1, "spot": 2, "squar": 3, "stand": 3, "standard": 1, "step": 1, "str": [1, 2, 3], "straight": [1, 3], "strip": [1, 3], "strip_cor": 3, "structur": 3, "stub": [1, 3], "suffix": 3, "sun": 0, "suppli": 3, "support": 3, "symmetr": 1, "symmetri": 3, "symmetric_bu": 1, "taper": [0, 1, 2, 3], "taper_length": 3, "target": [1, 3], "teeth": 3, "teeth_numb": 3, "termin": [1, 3], "theta_arc": 1, "theta_ext": 1, "thi": [0, 1, 2, 3], "third": 2, "three": [1, 3], "tilt": 2, "tip": [1, 2], "toctre": 0, "toler": 1, "tooth": 3, "top": 2, "topologi": 1, "total": 3, "tp_angl": 1, "transit": [1, 2, 3], "trench": 2, "triangular": 3, "true": [1, 3], "tunabl": 1, "two": 1, "twod_grat": 3, "type": [1, 3], "type_tap": 3, "uninstanti": 3, "uniqu": [1, 2], "unit": 3, "upper": 1, "us": [1, 3], "valu": 3, "vector": 3, "versatil": 3, "vertic": [1, 3], "w0": 1, "w1": 1, "w1_slab": 2, "w_box": 2, "w_box_end": 2, "w_bu": 1, "w_cp": 1, "w_dt": 2, "w_gt": 3, "w_in": [1, 2], "w_mid_slab": 2, "w_out": 1, "w_tip_cor": 2, "w_tip_slab": 2, "w_tran": 1, "w_wg": [1, 3], "wa0": 1, "wa1": 1, "waveguid": [1, 2, 3], "wb0": 1, "wb1": 1, "wb_in": 1, "wb_out": 1, "wd0": 1, "wd1": 1, "wd_in": 1, "wd_out": 1, "wg_ltp": 1, "when": [1, 3], "whether": 1, "width": [1, 2, 3], "width1": 3, "width2": 3, "wrapper": 1, "written": 1, "wu0": 1, "wu1": 1, "wu_in": 1, "wu_out": 1, "x": [1, 3], "xs_open": 3, "xs_sin": 2, "xs_trench": 2, "xs_wg": [1, 3], "y": 3, "you": 0, "your": 0, "\u00b5m": 3}, "titles": ["Welcome to the automated documentation for the mxPIC silicon photonics library.", "mxpic\\components\\primitives\\directional_couplers\\directional_couplers", "mxpic\\components\\primitives\\edge_couplers\\EC_dual_layer_px3", "mxpic\\components\\primitives\\grating_couplers\\grating_couplers"], "titleterms": {"autom": 0, "compon": [0, 1, 2, 3], "directional_coupl": 1, "document": 0, "ec_dual_layer_px3": 2, "edge_coupl": 2, "grating_coupl": 3, "librari": 0, "mxpic": [0, 1, 2, 3], "photon": 0, "primit": [1, 2, 3], "silicon": 0, "welcom": 0}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Components:": [[0, null]], "Welcome to the automated documentation for the mxPIC silicon photonics library.": [[0, null]], "mxpic\\components\\primitives\\EC_dual_layer_px3": [[1, null]], "mxpic\\components\\primitives\\beam_splitters": [[2, null]], "mxpic\\components\\primitives\\directional_couplers": [[3, null]], "mxpic\\components\\primitives\\grating_couplers": [[4, null]], "mxpic\\components\\primitives\\multimode_interferometers": [[5, null]], "mxpic\\components\\primitives\\spiral": [[6, null]]}, "docnames": ["index", "mxpic/components/primitives/EC_dual_layer_px3", "mxpic/components/primitives/beam_splitters", "mxpic/components/primitives/directional_couplers", "mxpic/components/primitives/grating_couplers", "mxpic/components/primitives/multimode_interferometers", "mxpic/components/primitives/spiral"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.md", "mxpic/components/primitives/EC_dual_layer_px3.md", "mxpic/components/primitives/beam_splitters.md", "mxpic/components/primitives/directional_couplers.md", "mxpic/components/primitives/grating_couplers.md", "mxpic/components/primitives/multimode_interferometers.md", "mxpic/components/primitives/spiral.md"], "indexentries": {"adc_std_2x2 (class in mxpic.components.primitives.directional_couplers)": [[3, "mxpic.components.primitives.directional_couplers.ADC_STD_2x2", false]], "bs_tdc (class in mxpic.components.primitives.directional_couplers)": [[3, "mxpic.components.primitives.directional_couplers.BS_tdc", false]], "cell (mxpic.components.primitives.spiral.spiral_circle attribute)": [[6, "mxpic.components.primitives.spiral.spiral_circle.cell", false]], "dc (class in mxpic.components.primitives.directional_couplers)": [[3, "mxpic.components.primitives.directional_couplers.DC", false]], "dc_bend (class in mxpic.components.primitives.directional_couplers)": [[3, "mxpic.components.primitives.directional_couplers.DC_bend", false]], "dc_px_3sg (class in mxpic.components.primitives.directional_couplers)": [[3, "mxpic.components.primitives.directional_couplers.DC_pX_3sg", false]], "ec_dual_layer_px3 (class in mxpic.components.primitives.ec_dual_layer_px3)": [[1, "mxpic.components.primitives.EC_dual_layer_px3.EC_dual_layer_px3", false]], "fa (class in mxpic.components.primitives.grating_couplers)": [[4, "mxpic.components.primitives.grating_couplers.FA", false]], "gc_std_1d (class in mxpic.components.primitives.grating_couplers)": [[4, "mxpic.components.primitives.grating_couplers.GC_STD_1D", false]], "gc_std_2d (class in mxpic.components.primitives.grating_couplers)": [[4, "mxpic.components.primitives.grating_couplers.GC_STD_2D", false]], "generate_err() (mxpic.components.primitives.directional_couplers.adc_std_2x2 method)": [[3, "mxpic.components.primitives.directional_couplers.ADC_STD_2x2.generate_err", false]], "generate_gds() (mxpic.components.primitives.beam_splitters.ybranch method)": [[2, "mxpic.components.primitives.beam_splitters.YBranch.generate_gds", false]], "generate_gds() (mxpic.components.primitives.beam_splitters.ybranch_3wg method)": [[2, "mxpic.components.primitives.beam_splitters.Ybranch_3wg.generate_gds", false]], "generate_gds() (mxpic.components.primitives.directional_couplers.adc_std_2x2 method)": [[3, "mxpic.components.primitives.directional_couplers.ADC_STD_2x2.generate_gds", false]], "generate_gds() (mxpic.components.primitives.directional_couplers.dc_bend method)": [[3, "mxpic.components.primitives.directional_couplers.DC_bend.generate_gds", false]], "generate_gds() (mxpic.components.primitives.directional_couplers.dc_px_3sg method)": [[3, "mxpic.components.primitives.directional_couplers.DC_pX_3sg.generate_gds", false]], "generate_gds() (mxpic.components.primitives.directional_couplers.ring_bus_wg method)": [[3, "mxpic.components.primitives.directional_couplers.ring_bus_wg.generate_gds", false]], "generate_gds() (mxpic.components.primitives.ec_dual_layer_px3.ec_dual_layer_px3 method)": [[1, "mxpic.components.primitives.EC_dual_layer_px3.EC_dual_layer_px3.generate_gds", false]], "generate_gds() (mxpic.components.primitives.grating_couplers.grating_2d_hole method)": [[4, "mxpic.components.primitives.grating_couplers.Grating_2D_Hole.generate_gds", false]], "generate_gds() (mxpic.components.primitives.grating_couplers.grating_2d_hole_3rec method)": [[4, "mxpic.components.primitives.grating_couplers.Grating_2D_Hole_3Rec.generate_gds", false]], "generate_gds() (mxpic.components.primitives.grating_couplers.grating_2d_hole_4rec method)": [[4, "mxpic.components.primitives.grating_couplers.Grating_2D_Hole_4Rec.generate_gds", false]], "generate_gds() (mxpic.components.primitives.grating_couplers.nano_ant method)": [[4, "mxpic.components.primitives.grating_couplers.Nano_ant.generate_gds", false]], "generate_gds() (mxpic.components.primitives.grating_couplers.taper method)": [[4, "mxpic.components.primitives.grating_couplers.Taper.generate_gds", false]], "generate_gds() (mxpic.components.primitives.multimode_interferometers.mmi_ml method)": [[5, "mxpic.components.primitives.multimode_interferometers.MMI_ML.generate_gds", false]], "generate_gds() (mxpic.components.primitives.spiral.spiral method)": [[6, "mxpic.components.primitives.spiral.spiral.generate_gds", false]], "generate_gds() (mxpic.components.primitives.spiral.spiral_circle method)": [[6, "mxpic.components.primitives.spiral.spiral_circle.generate_gds", false]], "generate_gds() (mxpic.components.primitives.spiral.spiral_rectangle method)": [[6, "mxpic.components.primitives.spiral.spiral_rectangle.generate_gds", false]], "generate_gds_error() (mxpic.components.primitives.grating_couplers.nano_ant method)": [[4, "mxpic.components.primitives.grating_couplers.Nano_ant.generate_gds_error", false]], "generate_gds_positive() (mxpic.components.primitives.grating_couplers.nano_ant method)": [[4, "mxpic.components.primitives.grating_couplers.Nano_ant.generate_gds_positive", false]], "generate_negative() (mxpic.components.primitives.grating_couplers.gc_std_1d method)": [[4, "mxpic.components.primitives.grating_couplers.GC_STD_1D.generate_negative", false]], "generate_negative() (mxpic.components.primitives.grating_couplers.gc_std_2d method)": [[4, "mxpic.components.primitives.grating_couplers.GC_STD_2D.generate_negative", false]], "generate_positive() (mxpic.components.primitives.grating_couplers.gc_std_1d method)": [[4, "mxpic.components.primitives.grating_couplers.GC_STD_1D.generate_positive", false]], "generate_positive() (mxpic.components.primitives.grating_couplers.gc_std_2d method)": [[4, "mxpic.components.primitives.grating_couplers.GC_STD_2D.generate_positive", false]], "generate_test_dev() (mxpic.components.primitives.grating_couplers.gc_std_1d method)": [[4, "mxpic.components.primitives.grating_couplers.GC_STD_1D.generate_test_dev", false]], "generate_test_gds() (mxpic.components.primitives.beam_splitters.ybranch_3wg method)": [[2, "mxpic.components.primitives.beam_splitters.Ybranch_3wg.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.directional_couplers.adc_std_2x2 method)": [[3, "mxpic.components.primitives.directional_couplers.ADC_STD_2x2.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.directional_couplers.dc method)": [[3, "mxpic.components.primitives.directional_couplers.DC.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.directional_couplers.dc_bend method)": [[3, "mxpic.components.primitives.directional_couplers.DC_bend.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.directional_couplers.dc_px_3sg method)": [[3, "mxpic.components.primitives.directional_couplers.DC_pX_3sg.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.directional_couplers.mdm method)": [[3, "mxpic.components.primitives.directional_couplers.MDM.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.grating_couplers.gc_std_2d method)": [[4, "mxpic.components.primitives.grating_couplers.GC_STD_2D.generate_test_gds", false]], "generate_test_gds() (mxpic.components.primitives.multimode_interferometers.mmi_ml method)": [[5, "mxpic.components.primitives.multimode_interferometers.MMI_ML.generate_test_gds", false]], "grating_2d_hole (class in mxpic.components.primitives.grating_couplers)": [[4, "mxpic.components.primitives.grating_couplers.Grating_2D_Hole", false]], "grating_2d_hole_3rec (class in mxpic.components.primitives.grating_couplers)": [[4, "mxpic.components.primitives.grating_couplers.Grating_2D_Hole_3Rec", false]], "grating_2d_hole_4rec (class in mxpic.components.primitives.grating_couplers)": [[4, "mxpic.components.primitives.grating_couplers.Grating_2D_Hole_4Rec", false]], "mdm (class in mxpic.components.primitives.directional_couplers)": [[3, "mxpic.components.primitives.directional_couplers.MDM", false]], "mmi_ml (class in mxpic.components.primitives.multimode_interferometers)": [[5, "mxpic.components.primitives.multimode_interferometers.MMI_ML", false]], "mmi_std (class in mxpic.components.primitives.multimode_interferometers)": [[5, "mxpic.components.primitives.multimode_interferometers.MMI_STD", false]], "module": [[1, "module-mxpic.components.primitives.EC_dual_layer_px3", false], [2, "module-mxpic.components.primitives.beam_splitters", false], [3, "module-mxpic.components.primitives.directional_couplers", false], [4, "module-mxpic.components.primitives.grating_couplers", false], [5, "module-mxpic.components.primitives.multimode_interferometers", false], [6, "module-mxpic.components.primitives.spiral", false]], "mxpic.components.primitives.beam_splitters": [[2, "module-mxpic.components.primitives.beam_splitters", false]], "mxpic.components.primitives.directional_couplers": [[3, "module-mxpic.components.primitives.directional_couplers", false]], "mxpic.components.primitives.ec_dual_layer_px3": [[1, "module-mxpic.components.primitives.EC_dual_layer_px3", false]], "mxpic.components.primitives.grating_couplers": [[4, "module-mxpic.components.primitives.grating_couplers", false]], "mxpic.components.primitives.multimode_interferometers": [[5, "module-mxpic.components.primitives.multimode_interferometers", false]], "mxpic.components.primitives.spiral": [[6, "module-mxpic.components.primitives.spiral", false]], "nano_ant (class in mxpic.components.primitives.grating_couplers)": [[4, "mxpic.components.primitives.grating_couplers.Nano_ant", false]], "opt_euler() (mxpic.components.primitives.spiral.spiral_circle method)": [[6, "mxpic.components.primitives.spiral.spiral_circle.opt_euler", false]], "ring_bus_wg (class in mxpic.components.primitives.directional_couplers)": [[3, "mxpic.components.primitives.directional_couplers.ring_bus_wg", false]], "spiral (class in mxpic.components.primitives.spiral)": [[6, "mxpic.components.primitives.spiral.spiral", false]], "spiral_cicle_mm (class in mxpic.components.primitives.spiral)": [[6, "mxpic.components.primitives.spiral.Spiral_Cicle_MM", false]], "spiral_cicle_std (class in mxpic.components.primitives.spiral)": [[6, "mxpic.components.primitives.spiral.Spiral_Cicle_STD", false]], "spiral_circle (class in mxpic.components.primitives.spiral)": [[6, "mxpic.components.primitives.spiral.spiral_circle", false]], "spiral_rect_std (class in mxpic.components.primitives.spiral)": [[6, "mxpic.components.primitives.spiral.Spiral_Rect_STD", false]], "spiral_rectangle (class in mxpic.components.primitives.spiral)": [[6, "mxpic.components.primitives.spiral.spiral_rectangle", false]], "taper (class in mxpic.components.primitives.grating_couplers)": [[4, "mxpic.components.primitives.grating_couplers.Taper", false]], "ybranch (class in mxpic.components.primitives.beam_splitters)": [[2, "mxpic.components.primitives.beam_splitters.YBranch", false]], "ybranch_3wg (class in mxpic.components.primitives.beam_splitters)": [[2, "mxpic.components.primitives.beam_splitters.Ybranch_3wg", false]]}, "objects": {"mxpic.components.primitives": [[1, 0, 0, "-", "EC_dual_layer_px3"], [2, 0, 0, "-", "beam_splitters"], [3, 0, 0, "-", "directional_couplers"], [4, 0, 0, "-", "grating_couplers"], [5, 0, 0, "-", "multimode_interferometers"], [6, 0, 0, "-", "spiral"]], "mxpic.components.primitives.EC_dual_layer_px3": [[1, 1, 1, "", "EC_dual_layer_px3"]], "mxpic.components.primitives.EC_dual_layer_px3.EC_dual_layer_px3": [[1, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.beam_splitters": [[2, 1, 1, "", "YBranch"], [2, 1, 1, "", "Ybranch_3wg"]], "mxpic.components.primitives.beam_splitters.YBranch": [[2, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.beam_splitters.Ybranch_3wg": [[2, 2, 1, "", "generate_gds"], [2, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers": [[3, 1, 1, "", "ADC_STD_2x2"], [3, 1, 1, "", "BS_tdc"], [3, 1, 1, "", "DC"], [3, 1, 1, "", "DC_bend"], [3, 1, 1, "", "DC_pX_3sg"], [3, 1, 1, "", "MDM"], [3, 1, 1, "", "ring_bus_wg"]], "mxpic.components.primitives.directional_couplers.ADC_STD_2x2": [[3, 2, 1, "", "generate_err"], [3, 2, 1, "", "generate_gds"], [3, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers.DC": [[3, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers.DC_bend": [[3, 2, 1, "", "generate_gds"], [3, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers.DC_pX_3sg": [[3, 2, 1, "", "generate_gds"], [3, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers.MDM": [[3, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.directional_couplers.ring_bus_wg": [[3, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.grating_couplers": [[4, 1, 1, "", "FA"], [4, 1, 1, "", "GC_STD_1D"], [4, 1, 1, "", "GC_STD_2D"], [4, 1, 1, "", "Grating_2D_Hole"], [4, 1, 1, "", "Grating_2D_Hole_3Rec"], [4, 1, 1, "", "Grating_2D_Hole_4Rec"], [4, 1, 1, "", "Nano_ant"], [4, 1, 1, "", "Taper"]], "mxpic.components.primitives.grating_couplers.GC_STD_1D": [[4, 2, 1, "", "generate_negative"], [4, 2, 1, "", "generate_positive"], [4, 2, 1, "", "generate_test_dev"]], "mxpic.components.primitives.grating_couplers.GC_STD_2D": [[4, 2, 1, "", "generate_negative"], [4, 2, 1, "", "generate_positive"], [4, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.grating_couplers.Grating_2D_Hole": [[4, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.grating_couplers.Grating_2D_Hole_3Rec": [[4, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.grating_couplers.Grating_2D_Hole_4Rec": [[4, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.grating_couplers.Nano_ant": [[4, 2, 1, "", "generate_gds"], [4, 2, 1, "", "generate_gds_error"], [4, 2, 1, "", "generate_gds_positive"]], "mxpic.components.primitives.grating_couplers.Taper": [[4, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.multimode_interferometers": [[5, 1, 1, "", "MMI_ML"], [5, 1, 1, "", "MMI_STD"]], "mxpic.components.primitives.multimode_interferometers.MMI_ML": [[5, 2, 1, "", "generate_gds"], [5, 2, 1, "", "generate_test_gds"]], "mxpic.components.primitives.spiral": [[6, 1, 1, "", "Spiral_Cicle_MM"], [6, 1, 1, "", "Spiral_Cicle_STD"], [6, 1, 1, "", "Spiral_Rect_STD"], [6, 1, 1, "", "spiral"], [6, 1, 1, "", "spiral_circle"], [6, 1, 1, "", "spiral_rectangle"]], "mxpic.components.primitives.spiral.spiral": [[6, 2, 1, "", "generate_gds"]], "mxpic.components.primitives.spiral.spiral_circle": [[6, 3, 1, "", "cell"], [6, 2, 1, "", "generate_gds"], [6, 2, 1, "", "opt_euler"]], "mxpic.components.primitives.spiral.spiral_rectangle": [[6, 2, 1, "", "generate_gds"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute"}, "terms": {"": 6, "0": [1, 2, 3, 4, 5, 6], "01": 5, "02": 3, "05": [0, 6], "1": [2, 3, 4, 5, 6], "10": [2, 3, 4, 5, 6], "100": 3, "110": 4, "12": 1, "15": [2, 3], "16": 0, "18": 2, "180": 6, "1d": 4, "2": [1, 2, 3, 4, 5, 6], "20": [2, 3, 4, 6], "2022": 3, "2026": 0, "22": 3, "25": 4, "2d": 4, "3": [0, 2, 4, 5], "30": [3, 4], "300": [3, 4], "33": 3, "35": [3, 5], "3db": 2, "4": [2, 4], "40": 3, "400": [2, 3], "41": 4, "45": [1, 2, 3, 4, 5, 6], "5": [3, 4, 5, 6], "50": [1, 4, 5, 6], "55": 3, "57": [0, 4], "6": [1, 2, 4], "61": 3, "64": 3, "8": [1, 2, 3, 4], "80": [2, 3], "88": 3, "A": 3, "If": [5, 6], "a0": 4, "a_anti": 3, "a_att": 2, "a_tap": 4, "acut": [3, 5], "ad": 4, "adapt": [0, 6], "adc_std_2x2": [0, 3], "add": [2, 5, 6], "adiabat": [1, 3], "adjac": [2, 4, 5, 6], "after": [2, 3, 4, 6], "air": 1, "air_trench": 1, "align": 6, "all": [2, 3, 4, 5], "alon": 4, "along": [2, 4, 6], "altern": 4, "analysi": 4, "angl": [1, 2, 3, 4, 6], "angle_til": 1, "antenna": 4, "anti": [3, 4], "apertur": 4, "append": [2, 4, 6], "appli": [3, 4, 6], "ar": [3, 4], "arc": [2, 3, 4, 6], "area": 4, "arm": [2, 3, 5], "arm_sine_width": 5, "arrai": 4, "assembl": 4, "associ": 1, "asymmetr": 3, "attach": [2, 6], "auto": 3, "avoid": 3, "axi": [2, 6], "back": 1, "balanc": 3, "base": [1, 2, 3, 4, 5, 6], "bdc": 3, "beam_splitt": 0, "befor": [3, 4, 6], "bend": [1, 2, 3, 6], "bend_dc": 3, "bent": 2, "beol": 1, "between": [1, 2, 3, 4, 5, 6], "bodi": [2, 5, 6], "bool": [2, 3, 4, 5, 6], "boolean": 6, "both": [2, 3, 5], "box": 1, "branch": 2, "broadband": [2, 3], "broadcast": 4, "bs_tdc": [0, 3], "bu": 3, "built": [3, 4, 6], "calcul": 3, "can": [0, 4], "cell": [1, 2, 3, 4, 5, 6], "cell_nam": 4, "cell_transit": 6, "cell_xs_transit": 6, "cellnam": 3, "center": [2, 4, 6], "central": [1, 5, 6], "chamfer": [2, 3, 5, 6], "channel": 4, "chip": 1, "circl": [3, 4, 6], "circular": [3, 4, 6], "circumscrib": 4, "clad": 1, "class": [1, 2, 3, 4, 5, 6], "clear": 1, "clothoid": [3, 6], "clothoid_ord": 3, "column": 4, "complet": 0, "conchoid": 6, "configur": 4, "connect": 6, "constant": 6, "constraint": 6, "contain": 0, "contrast": 1, "control": [2, 6], "conveni": [5, 6], "convert": [1, 6], "core": [1, 3], "corner": [3, 5, 6], "correspond": 5, "cosin": 5, "coupl": [1, 2, 3], "coupler": [1, 2, 3, 4], "creat": [0, 4], "cross": [1, 2, 3, 4, 5, 6], "cubic": 2, "curvatur": 1, "custom": 4, "cycl": 6, "d_hole": 4, "da_tran": 3, "dac": 3, "dc": [0, 3], "dc_bend": [0, 3], "dc_px_3sg": [0, 3], "debug": [3, 4, 5], "deep": 1, "default": [1, 2, 3, 4, 5, 6], "defin": 4, "define_typ": 4, "definit": 4, "deflect": [2, 3, 6], "degre": [1, 2, 3, 4, 6], "depth": 4, "deriv": [3, 6], "determin": 4, "devic": [1, 3, 5], "diamet": [4, 6], "diffract": 4, "dimens": 1, "direct": [0, 3], "directional_coupl": 0, "disabl": 3, "discret": [2, 3], "divis": 3, "dl_p2p": 3, "dl_tran": 3, "dlc": 3, "dmin": 6, "do": 4, "dp_in": 5, "dp_out": 5, "draw": [2, 3, 4, 5, 6], "dual": [1, 4], "dummi": 1, "duti": 4, "duty_cycl": 4, "dw": 3, "dx_gc2gc": [2, 3, 4, 5], "dx_hole": 4, "dy_gc2gc": [2, 3, 5], "dy_hol": 4, "e": 1, "each": [2, 5, 6], "eas": 6, "ec_dual_layer_px3": 0, "edg": [1, 4], "either": 4, "enabl": 3, "end": [3, 4], "end_patch": 3, "enforc": 6, "entir": 6, "entranc": [2, 4], "entri": 4, "equal": 5, "err": 3, "err_asi": 2, "eta_etch": 4, "etch": 4, "etch_depth": 4, "etch_typ": 4, "euler": [3, 6], "euler_anti_bend": 3, "euler_bend": 6, "euler_point": 3, "euler_sbend": 6, "euler_transist": 3, "evalu": 3, "everi": 6, "exactli": 6, "except": 4, "exclus": 1, "exit": 2, "expect": 6, "export": 4, "expos": 4, "extens": [1, 6], "extern": [2, 3], "extra": 4, "fa": [0, 4], "fabric": 3, "facet": 1, "fals": [2, 3, 4, 5, 6], "fan": 4, "fanout": 4, "fcw_tre": 4, "feed": 4, "fetch": 4, "fiber": [1, 4], "fiber_coupl": 4, "field": 4, "file": 0, "fill": 4, "filler": 3, "final": [1, 3, 6], "first": [1, 3, 6], "float": [1, 2, 3, 4, 5, 6], "follow": 5, "footprint": [4, 6], "forc": 3, "form": [2, 6], "four": 4, "fraction": 4, "from": [3, 4, 6], "futur": [3, 4], "g": 1, "g0": 3, "g1": [3, 4], "gaolei": 3, "gap": [2, 3, 6], "gap0": 3, "gap1": 3, "gc": [2, 3, 5], "gc_std_1d": [0, 4], "gc_std_2d": [0, 4], "gd": [1, 3, 4], "gener": [3, 4, 5], "generate_err": 3, "generate_gd": [1, 2, 3, 4, 5, 6], "generate_gds_error": 4, "generate_gds_posit": 4, "generate_neg": 4, "generate_posit": 4, "generate_test_dev": 4, "generate_test_gd": [2, 3, 4, 5], "geometri": [3, 4], "getch_tr": 4, "go": 4, "grate": 4, "grating_2d_hol": [0, 4], "grating_2d_hole_3rec": [0, 4], "grating_2d_hole_4rec": [0, 4], "grating_coupl": 0, "grating_unit": 4, "gt_diamet": 4, "gt_layer": 4, "gt_vector": 4, "guid": 3, "half": [3, 6], "helper": [2, 5, 6], "high": 1, "hole": 4, "hole_shap": 4, "horizont": [3, 4], "hu": 3, "i": [1, 2, 3, 4, 5, 6], "ident": 4, "identifi": [1, 3, 4], "imec": 4, "implement": 6, "in_out_align": 6, "index": 1, "individu": 4, "inherit": 6, "initi": [1, 2, 3], "inner": 6, "innermost": 6, "input": [1, 3, 4, 5, 6], "insert": [2, 3, 5, 6], "insid": [2, 3, 6], "instanc": 4, "instanti": [3, 4], "instead": [5, 6], "int": [3, 4, 5], "interact": 3, "interfer": 5, "intern": 6, "interpol": 5, "io": [2, 3, 4, 6], "keep": [2, 3, 4, 5], "kei": [2, 3, 4, 5, 6], "l": 2, "l_ar": 4, "l_arm": 5, "l_attach": 2, "l_box_end": 1, "l_cp": 3, "l_end": [1, 4], "l_field_cent": 4, "l_in": 1, "l_in_tp": 2, "l_mmi": 5, "l_tail": 4, "l_taper": 4, "laid": 6, "later": 4, "layer": [1, 4, 5, 6], "layer_dt": 1, "layer_dum_exl_b": 1, "layer_sin_slab": 1, "layer_top_cov": 1, "layout": 4, "lb0": 3, "lc1": 3, "lc2": 3, "lcp": 2, "ld": 3, "least": 0, "len": 5, "length": [1, 2, 3, 4, 5, 6], "like": 0, "linear": [4, 5], "link": 2, "list": 4, "lmin": 6, "logic": 4, "longitudin": [2, 5], "loop": 6, "lower": 3, "lp1": 3, "lpatch": 6, "lport": 6, "lt": 3, "lt_bu": 3, "lt_cp": 3, "ltp": 6, "ltp1": 1, "ltp2": 1, "ltp3": 1, "ltp_port": 6, "lu": 3, "lx_end": 4, "lx_port": 4, "lx_side": 4, "lx_taper": 4, "ly_end": 4, "ly_port": 4, "ly_sid": 4, "ly_tap": 4, "mai": 0, "main": 4, "manag": 1, "manual": 6, "margin": 4, "marker": [2, 3, 4, 5, 6], "master": 0, "match": [4, 6], "max_theta": 4, "maximum": [3, 4, 6], "mdm": [0, 3], "mean": [3, 4], "measur": 6, "metch": 4, "micron": [1, 2, 3, 4, 5, 6], "midpoint": 1, "minimum": [3, 6], "mirror": 3, "mitig": 3, "mmi": 5, "mmi_ml": [0, 5], "mmi_sine_width": 5, "mmi_std": [0, 5], "mode": [3, 4], "mode_radiu": 4, "mono": 5, "multi": 5, "multimod": 5, "multimode_interferomet": 0, "multiplex": 3, "must": [2, 5], "mxpic_handbook": 0, "n_in": 5, "n_out": 5, "name": [1, 2, 3, 4, 5, 6], "nano": 4, "nano_": [0, 4], "nanoantenna": 4, "nazca": [2, 3, 4, 5, 6], "nd": [4, 6], "nitrid": 1, "nomin": [3, 6], "non": 4, "none": [1, 2, 3, 4, 5, 6], "num": 4, "num_i": 4, "num_x": 4, "number": [3, 4, 5, 6], "object": [1, 2, 3, 4, 5, 6], "offset": [3, 4], "op": 6, "open": [1, 4], "opt_eul": 6, "optic": [1, 4], "optim": 6, "option": [1, 2, 3, 4, 5, 6], "order": 3, "out": [4, 6], "outer": 2, "outermost": 6, "output": [2, 3, 4, 5, 6], "overal": 4, "overrid": 6, "oxid": 1, "oxide_facet": 1, "p_ar": 4, "pad": 1, "pad_opt": 1, "pair": 6, "parabol": 4, "paramet": [1, 2, 3, 4, 5, 6], "parametr": 6, "part": 2, "path": 6, "per": [2, 4], "perform": 6, "period": 4, "phase": [3, 4], "photoresist": 4, "physic": 4, "pin": 4, "pitch": [2, 4, 5], "planar": 4, "plane": 3, "point": [2, 3], "polygon": [2, 3, 5, 6], "polysi_diamet": 4, "polysi_lay": 4, "polysi_vector": 4, "polysilicon": 4, "port": [2, 3, 4, 5, 6], "port_angl": 6, "port_symmetr": 3, "posit": 4, "power": 3, "pre": [4, 6], "preced": 4, "preset": 6, "primit": 0, "profil": 4, "provid": 4, "purpos": [3, 4], "px": [3, 4], "px_type": 3, "py": 4, "quickstart": 0, "r": 6, "r0": [2, 3, 6], "r_att": 2, "r_bend": [1, 5, 6], "r_cp": 3, "r_in": 3, "r_max_anti": 3, "r_max_tran": 3, "r_min_anti": 3, "r_ratio_mamnu": 6, "radian": 6, "radiu": [1, 2, 3, 4, 6], "rais": 4, "ratio": 6, "rbend": 2, "rc_ratio": 6, "rd0": 3, "rd1": 3, "re": [2, 3, 5, 6], "reach": 6, "rectangl": 4, "rectangular": [4, 6], "reduc": [1, 3], "refer": 4, "reflect": [1, 4], "reflector": 4, "reflector_vector": 4, "region": [2, 4, 5], "regist": 3, "repeat": 4, "reserv": 3, "resolut": [5, 6], "respect": 1, "result": 4, "rib": 6, "rib2strip": 6, "ring": 3, "ring_bus_wg": [0, 3], "rm_ratio": 6, "rmax": 3, "rmax_bend": 6, "rmin": 3, "rmin_bend": 6, "rmin_bend_cent": 6, "rmin_eul": 6, "root": 0, "rout": [1, 3], "row": 4, "ru0": 3, "ru1": 3, "same": 6, "sampl": [2, 3, 5, 6], "sample_step": 4, "sbend": 3, "sbend_typ": 3, "scaffold": 3, "scalar": 4, "scheme": 4, "second": [1, 3], "secondari": 1, "section": [1, 2, 3, 4, 5, 6], "sector": 4, "sector_gc": 4, "segment": [2, 3, 4, 5, 6], "selector": 4, "separ": 6, "sequenc": [2, 4, 5], "set": [3, 6], "setch": 4, "shape": [2, 4, 6], "share": 6, "sharp": 3, "sharp_patch": [2, 3, 5, 6], "shifter": 3, "should": 0, "show_pin": [2, 3, 4, 5, 6], "side": 4, "simul": 4, "sin": 1, "sin_rib_wg": 1, "singl": [3, 4, 5, 6], "single_end": 3, "size": [1, 4], "slab": [1, 4], "small": [3, 6], "soi": 1, "sourc": 4, "space": [2, 3, 4, 6], "sphinx": 0, "spiral": [0, 3], "spiral_cicle_mm": [0, 6], "spiral_cicle_std": [0, 6], "spiral_circl": [0, 6], "spiral_rect_std": [0, 6], "spiral_rectangl": [0, 6], "spline": 2, "split": 3, "splitter": 3, "spot": 1, "squar": 4, "stand": 4, "standard": [3, 5], "step": [3, 6], "str": [1, 2, 3, 4, 5, 6], "straight": [2, 3, 4, 6], "strict_condit": 6, "strip": [2, 3, 4, 5, 6], "strip_cor": 4, "structur": [4, 6], "stub": [2, 3, 4, 5, 6], "style": 6, "success": 6, "suffix": 4, "sun": 0, "suppli": 4, "support": [4, 6], "symmetr": [2, 3], "symmetri": 4, "symmetric_bu": 3, "taper": [0, 1, 2, 3, 4, 5, 6], "taper_length": 4, "target": [3, 4], "teeth": 4, "teeth_numb": 4, "termin": [3, 4], "tessel": 6, "theta_arc": 3, "theta_ext": 3, "thi": [0, 1, 3, 4], "third": 1, "three": [3, 4], "throughout": 6, "tilt": [1, 6], "tip": [1, 3], "toctre": 0, "toler": 3, "tooth": 4, "top": 1, "topologi": 3, "total": [2, 4], "tp_angl": 3, "transit": [1, 3, 4, 5, 6], "trench": 1, "triangular": 4, "true": [2, 3, 4, 5, 6], "tunabl": 3, "tupl": 6, "turn": 6, "two": [2, 3], "twod_grat": 4, "type": [3, 4], "type_tap": 4, "uniform": 5, "uninstanti": [2, 4, 5], "uniqu": [1, 3], "unit": 4, "upper": 3, "us": [2, 3, 4, 5, 6], "valu": 4, "vector": 4, "versatil": 4, "vertic": [2, 3, 4, 5, 6], "w": 2, "w0": [2, 3], "w1": [2, 3], "w1_slab": 1, "w_arm": 5, "w_bend_cent": 6, "w_bend_port": 6, "w_box": 1, "w_box_end": 1, "w_bu": 3, "w_cp": 3, "w_dt": 1, "w_gt": 4, "w_in": [1, 3], "w_mid_slab": 1, "w_mmi": 5, "w_out": 3, "w_port": [2, 5, 6], "w_tip_cor": 1, "w_tip_slab": 1, "w_tran": 3, "w_wg": [2, 3, 4, 5], "wa0": 3, "wa1": 3, "waveguid": [1, 2, 3, 4, 5, 6], "wb0": 3, "wb1": 3, "wb_in": 3, "wb_out": 3, "wd0": 3, "wd1": 3, "wd_in": 3, "wd_out": 3, "wg_ltp": 3, "when": [2, 3, 4, 5, 6], "whether": 3, "width": [1, 2, 3, 4, 5, 6], "width1": 4, "width2": 4, "within": [5, 6], "wmin_bend": 6, "wrapper": [3, 5], "written": 3, "wu0": 3, "wu1": 3, "wu_in": 3, "wu_out": 3, "x": [2, 3, 4, 5, 6], "xout_offset": 5, "xs_open": 4, "xs_sin": 1, "xs_trench": 1, "xs_wg": [3, 4], "y": [2, 4], "ybranch": [0, 2], "ybranch_3wg": [0, 2], "you": 0, "your": 0, "\u00b5m": [2, 4, 5, 6], "\u03c0": 6}, "titles": ["Welcome to the automated documentation for the mxPIC silicon photonics library.", "mxpic\\components\\primitives\\EC_dual_layer_px3", "mxpic\\components\\primitives\\beam_splitters", "mxpic\\components\\primitives\\directional_couplers", "mxpic\\components\\primitives\\grating_couplers", "mxpic\\components\\primitives\\multimode_interferometers", "mxpic\\components\\primitives\\spiral"], "titleterms": {"autom": 0, "beam_splitt": 2, "compon": [0, 1, 2, 3, 4, 5, 6], "directional_coupl": 3, "document": 0, "ec_dual_layer_px3": 1, "grating_coupl": 4, "librari": 0, "multimode_interferomet": 5, "mxpic": [0, 1, 2, 3, 4, 5, 6], "photon": 0, "primit": [1, 2, 3, 4, 5, 6], "silicon": 0, "spiral": 6, "welcom": 0}}) \ No newline at end of file diff --git a/mxpic/docs/source/index.md b/mxpic/docs/source/index.md index 61ac5c7..cb4406f 100644 --- a/mxpic/docs/source/index.md +++ b/mxpic/docs/source/index.md @@ -8,6 +8,9 @@ contain the root `toctree` directive. :maxdepth: 2 :caption: Components: -mxpic/components/primitives/directional_couplers/directional_couplers -mxpic/components/primitives/edge_couplers/EC_dual_layer_px3 -mxpic/components/primitives/grating_couplers/grating_couplers +mxpic/components/primitives/beam_splitters +mxpic/components/primitives/directional_couplers +mxpic/components/primitives/EC_dual_layer_px3 +mxpic/components/primitives/grating_couplers +mxpic/components/primitives/multimode_interferometers +mxpic/components/primitives/spiral diff --git a/mxpic/docs/source/mxpic/components/primitives/EC_dual_layer_px3.md b/mxpic/docs/source/mxpic/components/primitives/EC_dual_layer_px3.md new file mode 100644 index 0000000..81da869 --- /dev/null +++ b/mxpic/docs/source/mxpic/components/primitives/EC_dual_layer_px3.md @@ -0,0 +1,7 @@ +# mxpic\components\primitives\EC_dual_layer_px3 + ```{eval-rst} + .. automodule:: mxpic.components.primitives.EC_dual_layer_px3 + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/mxpic/docs/source/mxpic/components/primitives/beam_splitters.md b/mxpic/docs/source/mxpic/components/primitives/beam_splitters.md new file mode 100644 index 0000000..6b76fb5 --- /dev/null +++ b/mxpic/docs/source/mxpic/components/primitives/beam_splitters.md @@ -0,0 +1,7 @@ +# mxpic\components\primitives\beam_splitters + ```{eval-rst} + .. automodule:: mxpic.components.primitives.beam_splitters + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/mxpic/docs/source/mxpic/components/primitives/directional_couplers/directional_couplers.md b/mxpic/docs/source/mxpic/components/primitives/directional_couplers.md similarity index 59% rename from mxpic/docs/source/mxpic/components/primitives/directional_couplers/directional_couplers.md rename to mxpic/docs/source/mxpic/components/primitives/directional_couplers.md index b4da1d5..7776433 100644 --- a/mxpic/docs/source/mxpic/components/primitives/directional_couplers/directional_couplers.md +++ b/mxpic/docs/source/mxpic/components/primitives/directional_couplers.md @@ -1,6 +1,6 @@ -# mxpic\components\primitives\directional_couplers\directional_couplers +# mxpic\components\primitives\directional_couplers ```{eval-rst} - .. automodule:: mxpic.components.primitives.directional_couplers.directional_couplers + .. automodule:: mxpic.components.primitives.directional_couplers :members: :undoc-members: :show-inheritance: diff --git a/mxpic/docs/source/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.md b/mxpic/docs/source/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.md deleted file mode 100644 index 89b7496..0000000 --- a/mxpic/docs/source/mxpic/components/primitives/edge_couplers/EC_dual_layer_px3.md +++ /dev/null @@ -1,7 +0,0 @@ -# mxpic\components\primitives\edge_couplers\EC_dual_layer_px3 - ```{eval-rst} - .. automodule:: mxpic.components.primitives.edge_couplers.EC_dual_layer_px3 - :members: - :undoc-members: - :show-inheritance: -``` diff --git a/mxpic/docs/source/mxpic/components/primitives/grating_couplers.md b/mxpic/docs/source/mxpic/components/primitives/grating_couplers.md new file mode 100644 index 0000000..de8b00c --- /dev/null +++ b/mxpic/docs/source/mxpic/components/primitives/grating_couplers.md @@ -0,0 +1,7 @@ +# mxpic\components\primitives\grating_couplers + ```{eval-rst} + .. automodule:: mxpic.components.primitives.grating_couplers + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/mxpic/docs/source/mxpic/components/primitives/grating_couplers/grating_couplers.md b/mxpic/docs/source/mxpic/components/primitives/grating_couplers/grating_couplers.md deleted file mode 100644 index 1342cc7..0000000 --- a/mxpic/docs/source/mxpic/components/primitives/grating_couplers/grating_couplers.md +++ /dev/null @@ -1,7 +0,0 @@ -# mxpic\components\primitives\grating_couplers\grating_couplers - ```{eval-rst} - .. automodule:: mxpic.components.primitives.grating_couplers.grating_couplers - :members: - :undoc-members: - :show-inheritance: -``` diff --git a/mxpic/docs/source/mxpic/components/primitives/multimode_interferometers.md b/mxpic/docs/source/mxpic/components/primitives/multimode_interferometers.md new file mode 100644 index 0000000..cdcb821 --- /dev/null +++ b/mxpic/docs/source/mxpic/components/primitives/multimode_interferometers.md @@ -0,0 +1,7 @@ +# mxpic\components\primitives\multimode_interferometers + ```{eval-rst} + .. automodule:: mxpic.components.primitives.multimode_interferometers + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/mxpic/docs/source/mxpic/components/primitives/spiral.md b/mxpic/docs/source/mxpic/components/primitives/spiral.md new file mode 100644 index 0000000..b55a361 --- /dev/null +++ b/mxpic/docs/source/mxpic/components/primitives/spiral.md @@ -0,0 +1,7 @@ +# mxpic\components\primitives\spiral + ```{eval-rst} + .. automodule:: mxpic.components.primitives.spiral + :members: + :undoc-members: + :show-inheritance: +``` diff --git a/mxpic/foundries/Foundry.py b/mxpic/foundries/Foundry.py new file mode 100644 index 0000000..4a7d3c6 --- /dev/null +++ b/mxpic/foundries/Foundry.py @@ -0,0 +1,48 @@ +import nazca as nd +import numpy as np + +class Foundry: + ## Generall parameters + STD_SMWG_WIDTH = 0.45 + SLAB_GROWTH = 2 + W_METAL_MIN = 1 + SPACING_HEATER_MIN = 1 + SPACING_METAL_MIN = 1.5 + W_HEATER_MIN = 1 + W_VIA_H2M = 0.25 + SPACING_VIA_H2M = 0.35 + ISL_W_MIN = 4 + ISL_SP_MIN = 5 + + show_pins = False + + def __init__(self,layermap=None): + if (layermap!=None): + self.layermap = layermap + for layers in layermap: + + nd.add_layer(name=layers,layer=layermap[layers],overwrite=True) ## adding layers to the program, globally + # nd.add_layer(name=layermap[layers][1],layer=layermap[layers][0],overwrite=True) ## same layer with different name + + nd.add_xsection(name=layers.lower()) ## adding the same name xsections, globally + nd.add_layer2xsection(xsection=layers.lower(), layer=layers) + + setattr(self, "LAYER_"+layers, layers) + setattr(self, "XS_"+layers, layers.lower()) + + + def _add_xsection_(self,xsection=None,layers=None,growth=None,growy=None): + if (len(layers)!=len(growth)): + print("WARNING: In layer growth do not match number of layer") + return 0 + + if (xsection!=None): + nd.add_xsection(name=xsection) + + for _idx_ in range(0,len(layers)): + # nd.add_layer2xsection(xsection=xsection, layer=layers[_idx_],leftedge=(0.5, growth[_idx_]), rightedge=(-0.5, -growth[_idx_]),overwrite=True + # ,growy1=growth[_idx_],growy2=growth[_idx_]) + nd.add_layer2xsection(xsection=xsection, layer=layers[_idx_],leftedge=(0.5, growth[_idx_]), rightedge=(-0.5, -growth[_idx_]), + overwrite=True,growy1=growy,growy2=growy) + setattr(self, "XS_"+xsection.upper(), xsection) + diff --git a/mxpic/foundries/__init__.py b/mxpic/foundries/__init__.py index f9a6cc7..f139e49 100644 --- a/mxpic/foundries/__init__.py +++ b/mxpic/foundries/__init__.py @@ -1,19 +1,5 @@ -from .CUMEC import CUMEC_CSiP130Cu,CUMEC_CSiP180Al_PASSIVE from .AMF import AMF_Si220_Active - -from .ANT import ANT_Si220_MPW - -from .IMEC import IMEC_Si220_Active - -from .IMECAS import IMECAS_SiP - -from .Foundry import Foundry - -from .CompTek import CT_CU3ML - -from .SITRI import SITRI_LSIN_SOI - from .Silterra import EOM1_2ML_CU diff --git a/mxpic_release/mxpic/__init__.py b/mxpic_release/mxpic/__init__.py deleted file mode 100644 index a991874..0000000 --- a/mxpic_release/mxpic/__init__.py +++ /dev/null @@ -1,12 +0,0 @@ -# mxpic/__init__.py - -from .core.license_check import verify_license - -# Run the check immediately upon import -verify_license() - -# If the check passes, the rest of the library loads -from .components import EC_dual_layer_px3 -from .routing import Route - -from .components.primitives import * \ No newline at end of file diff --git a/mxpic_release/mxpic/__init__.pyi b/mxpic_release/mxpic/__init__.pyi new file mode 100644 index 0000000..e02ee5d --- /dev/null +++ b/mxpic_release/mxpic/__init__.pyi @@ -0,0 +1,2 @@ +from .components import DC as DC, DC_bend as DC_bend, DC_pX_3sg as DC_pX_3sg, EC_dual_layer_px3 as EC_dual_layer_px3 +from .routing import Route as Route diff --git a/mxpic_release/mxpic/basic.pyi b/mxpic_release/mxpic/basic.pyi new file mode 100644 index 0000000..5e06c99 --- /dev/null +++ b/mxpic_release/mxpic/basic.pyi @@ -0,0 +1,4 @@ +def __cell_arg__(arg, arg_name, func_name): ... +def __list_convert__(var, name, func_name): ... +def __array_convert__(var, name, func_name, num: int = 1): ... +def __xs_exist__(xs, para_name, func_name): ... diff --git a/mxpic_release/mxpic/components/__init__.py b/mxpic_release/mxpic/components/__init__.py deleted file mode 100644 index f5d6a2d..0000000 --- a/mxpic_release/mxpic/components/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from .primitives import * \ No newline at end of file diff --git a/mxpic_release/mxpic/components/__init__.pyi b/mxpic_release/mxpic/components/__init__.pyi new file mode 100644 index 0000000..bbc20db --- /dev/null +++ b/mxpic_release/mxpic/components/__init__.pyi @@ -0,0 +1 @@ +from .primitives import * diff --git a/mxpic_release/mxpic/components/primitives/EC_dual_layer_px3.pyi b/mxpic_release/mxpic/components/primitives/EC_dual_layer_px3.pyi new file mode 100644 index 0000000..b770757 --- /dev/null +++ b/mxpic_release/mxpic/components/primitives/EC_dual_layer_px3.pyi @@ -0,0 +1,30 @@ +from _typeshed import Incomplete + +class EC_dual_layer_px3: + name: Incomplete + instantiate: bool + w_in: Incomplete + L_in: Incomplete + Ltp1: Incomplete + Ltp2: Incomplete + Ltp3: Incomplete + L_end: Incomplete + w_tip_core: Incomplete + w1_slab: Incomplete + w_tip_slab: Incomplete + w_mid_slab: Incomplete + w_box: Incomplete + w_box_end: Incomplete + L_box_end: Incomplete + w_DT: Incomplete + xs_SiN: Incomplete + layer_SiN_slab: Incomplete + layer_top_cover: Incomplete + layer_dum_exl_be: Incomplete + layer_DT: Incomplete + xs_Trench: Incomplete + angle_tile: Incomplete + R_bend: Incomplete + cell: Incomplete + def __init__(self, name, w_in, L_in, Ltp1, Ltp2, Ltp3, L_end: int = 0, w_tip_core: float = 0.2, w1_slab: float = 0.6, w_tip_slab: float = 0.2, w_mid_slab: float = 0.45, w_box: int = 8, w_box_end: int = 12, L_box_end: int = 2, w_DT: int = 12, xs_SiN: str = 'sin', layer_SiN_slab: str = 'SiN_Rib_WG', layer_DT: str = 'OXIDE_FACET', xs_Trench: str = 'air_trench', layer_top_cover: str = 'PAD_OPTICAL', layer_dum_exl_be: str = None, angle_tile: int = 8, R_bend: int = 50) -> None: ... + def generate_gds(self): ... diff --git a/mxpic_release/mxpic/components/primitives/__init__.py b/mxpic_release/mxpic/components/primitives/__init__.py deleted file mode 100644 index c7dc1c3..0000000 --- a/mxpic_release/mxpic/components/primitives/__init__.py +++ /dev/null @@ -1,2 +0,0 @@ -from .directional_couplers.directional_couplers import * -from .edge_couplers.EC_dual_layer_px3 import * \ No newline at end of file diff --git a/mxpic_release/mxpic/components/primitives/__init__.pyi b/mxpic_release/mxpic/components/primitives/__init__.pyi new file mode 100644 index 0000000..1805c80 --- /dev/null +++ b/mxpic_release/mxpic/components/primitives/__init__.pyi @@ -0,0 +1,5 @@ +from .directional_couplers import * +from .EC_dual_layer_px3 import * +from .beam_splitters import * +from .multimode_interferometers import * +from .spiral import * diff --git a/mxpic_release/mxpic/components/primitives/beam_splitters.pyi b/mxpic_release/mxpic/components/primitives/beam_splitters.pyi new file mode 100644 index 0000000..49b4cab --- /dev/null +++ b/mxpic_release/mxpic/components/primitives/beam_splitters.pyi @@ -0,0 +1,39 @@ +from ...structures import * +from ...foundries import * +import numpy as np +from ...basic import __cell_arg__ as __cell_arg__ +from ...routing import Route as Route +from _typeshed import Incomplete + +class YBranch: + name: Incomplete + instantiate: bool + w: Incomplete + L: Incomplete + res: Incomplete + R_att: Incomplete + A_att: Incomplete + w_port: Incomplete + xs: Incomplete + cell: Incomplete + def __init__(self, name: str = None, xs: str = 'strip', w: list | np.ndarray = [1.2, 1.0, 1.8, 1.2, 1.0, 1.2, 1.2], L: float = 6, R_att: float = 10, A_att: float = 10, w_port: float = 0.45, show_pins: bool = False, sharp_patch: bool = True, res: float = 0.1) -> None: ... + def generate_gds(self, show_pins: bool = False, sharp_patch: bool = True): ... + +class Ybranch_3wg: + name: Incomplete + instantiate: bool + w0: Incomplete + w1: Incomplete + gap: Incomplete + Lcp: Incomplete + xs: Incomplete + w_wg: Incomplete + R0: Incomplete + angle: Incomplete + L_attach: Incomplete + L_in_tp: Incomplete + cell: Incomplete + L: Incomplete + def __init__(self, name=None, w0: float = 0.4, w1: float = 0.2, gap: float = 0.18, Lcp: float = 20, xs: str = 'strip', w_wg: float = 0.45, R0: float = 10, angle: float = 20, L_attach: float = 3, L_in_tp: float = 3, sharp_patch: bool = True) -> None: ... + def generate_gds(self, sharp_patch, err_asy: int = 0): ... + def generate_test_gds(self, gc, dX_gc2gc: int = 400, dY_gc2gc: int = 80, sharp_patch: bool = True, Rbend: int = 15): ... diff --git a/mxpic_release/mxpic/components/primitives/directional_couplers.pyi b/mxpic_release/mxpic/components/primitives/directional_couplers.pyi new file mode 100644 index 0000000..051c101 --- /dev/null +++ b/mxpic_release/mxpic/components/primitives/directional_couplers.pyi @@ -0,0 +1,141 @@ +from ...basic import __cell_arg__ as __cell_arg__ +from ...routing import Route as Route +from ...structures import Clothoid as Clothoid, circle as circle +from _typeshed import Incomplete + +class ring_bus_wg: + xs: Incomplete + R_cp: Incomplete + w_bus: Incomplete + dLc: Incomplete + dAc: Incomplete + w_wg: Incomplete + bend_DC: Incomplete + euler_transistion: Incomplete + dL_trans: Incomplete + dA_trans: Incomplete + R_max_trans: Incomplete + w_trans: Incomplete + R_max_anti: Incomplete + R_min_anti: Incomplete + A_anti: Incomplete + wg_Ltp: Incomplete + dL_p2p: Incomplete + res: Incomplete + end_patch: Incomplete + L: int + clothoid_order: Incomplete + cell: Incomplete + def __init__(self, xs: str = 'strip', R_cp: int = 20, w_bus: float = 0.5, bend_DC: bool = True, w_wg: float = 0.5, dLc: int = 10, dAc: int = 10, euler_transistion: bool = False, dL_trans: int = 10, dA_trans: int = 30, R_max_trans: int = 100, w_trans: float = 0.5, euler_anti_bend: bool = False, R_max_anti: int = 100, R_min_anti: int = 10, A_anti=None, res: float = 0.1, wg_Ltp: int = 5, dL_p2p=None, sharp_patch: bool = True, show_pins: bool = False, end_patch: bool = False, clothoid_order: int = 1) -> None: ... + w: Incomplete + sz: Incomplete + def generate_gds(self, sharp_patch, show_pins: bool = False): ... + +class ADC_STD_2x2: + name: Incomplete + instantiate: bool + wu0: Incomplete + xs: Incomplete + wu1: Incomplete + wu_in: Incomplete + wu_out: Incomplete + wd0: Incomplete + wd1: Incomplete + wd_in: Incomplete + wd_out: Incomplete + Lu: Incomplete + Ld: Incomplete + angle: Incomplete + g0: Incomplete + g1: Incomplete + sbend_type: Incomplete + Rmax: Incomplete + Rmin: Incomplete + sharp_patch: Incomplete + euler_points: Incomplete + res: Incomplete + Ru0: Incomplete + Ru1: Incomplete + Rd0: Incomplete + Rd1: Incomplete + tp_angle: Incomplete + cell: Incomplete + L: Incomplete + def __init__(self, name=None, xs: str = 'strip', wu0: float = 0.45, wu1: float = 0.61, wu_in: float = 0.45, wu_out: float = 0.8, wd0: float = 0.33, wd1: float = 0.2, wd_in: float = 0.45, wd_out: float = 0.8, Lu: int = 33, Ld: int = 33, angle: int = 20, g0: float = 0.2, g1: float = 0.2, sbend_type: str = 'euler', Rmax=None, Rmin: int = 5, Ru0: int = 0, Ru1: int = 20, Rd0: int = 20, Rd1: int = 0, tp_angle: int = 2, sharp_patch: bool = True, show_pins: bool = False, euler_points: int = 64, res: float = 0.1) -> None: ... + def generate_gds(self, err: int = 0, show_pins: bool = False): ... + err: Incomplete + def generate_err(self, err: float = 0.02): ... + def generate_test_gds(self, gc, dX_gc2gc: int = 400, dY_gc2gc: int = 80, sharp_patch: bool = True): ... + +class DC(ADC_STD_2x2): + def __init__(self, name=None, xs: str = 'strip', w_cp: float = 0.45, w_wg: float = 0.45, L_cp: float = 30, angle: float = 20, gap: float = 0.2, sbend_type: str = 'circular', Rmax: float = None, Rmin: float = 5, R0: float = 10, tp_angle: float = 2, sharp_patch: bool = True, show_pins: bool = False) -> None: ... + def generate_test_gds(self, gc, dX_gc2gc: int = 300, dY_gc2gc: int = 40, sharp_patch: bool = True): ... + +class BS_tdc(ADC_STD_2x2): + def __init__(self, name=None, xs: str = 'strip', wa0: float = 0.35, wa1: float = 0.45, wb0: float = 0.55, wb1: float = 0.45, w_wg: float = 0.45, gap: float = 0.2, Lt: float = 20, R0: float = 30, angle: float = 15, sbend_type: str = 'circle') -> None: ... + +class MDM(ADC_STD_2x2): + wb0: Incomplete + wb1: Incomplete + w0: Incomplete + w1: Incomplete + w_wg: Incomplete + gap0: Incomplete + gap1: Incomplete + Lt_bus: Incomplete + Lt_cp: Incomplete + xs: Incomplete + R0: Incomplete + angle: Incomplete + symmetric_BUS: Incomplete + Rmin: Incomplete + L: Incomplete + def __init__(self, name=None, xs: str = 'strip', wb0: float = 0.45, wb1: float = 0.61, wb_in: float = 0.45, wb_out: float = 0.88, w_wg: float = 0.45, w0: float = 0.33, w1: float = 0.2, gap0: float = 0.2, Lt_bus: float = 20, R0: float = 40, angle: float = 22.5, Lt_cp: float = None, gap1: float = None, Lb0: float = None, symmetric_BUS: bool = True, single_end: bool = True, Rmin: float = 8) -> None: ... + def generate_test_gds(self, gc, dX_gc2gc: int = 300, dY_gc2gc: int = 40, sharp_patch: bool = True): ... + +class DC_bend: + name: Incomplete + instantiate: bool + w_in: Incomplete + w_out: Incomplete + gap: Incomplete + r_in: Incomplete + r_out: Incomplete + theta_arc: Incomplete + theta_ext: Incomplete + w_wg: Incomplete + xs_wg: Incomplete + sharp_patch: Incomplete + show_pins: Incomplete + cell: Incomplete + def __init__(self, name=None, w_in: float = 0.45, w_out: float = 0.45, gap: float = 0.2, r_in: int = 40, theta_arc: int = 30, w_wg: float = 0.45, theta_ext: int = 15, xs_wg: str = 'strip', sharp_patch: bool = True, show_pins: bool = False) -> None: ... + width: Incomplete + length: Incomplete + def generate_gds(self, cellname: str = ''): ... + def generate_test_gds(self, gc, dX_gc2gc: int = 300, dY_gc2gc: int = 40, sharp_patch: bool = True): ... + +class DC_pX_3sg: + name: Incomplete + instantiate: bool + xs_wg: Incomplete + Lc1: Incomplete + Lp1: Incomplete + Lc2: Incomplete + Lt: Incomplete + w_cp: Incomplete + dw: Incomplete + gap: Incomplete + R0: Incomplete + A: Incomplete + w_wg: Incomplete + sharp_patch: Incomplete + pX_type: Incomplete + port_symmetric: Incomplete + cell: Incomplete + cellU: Incomplete + cellD: Incomplete + L: Incomplete + length: Incomplete + def __init__(self, name=None, xs_wg: str = 'strip', Lc1: float = 10, Lp1: float = 5, Lc2: float = 10, Lt: float = 1, w_cp: float = 0.5, dw: float = 0.1, gap: float = 0.2, R0: float = 10, A: float = 15, w_wg: float = 0.45, pX_type: str = 'symmetric', port_symmetric: bool = True, sharp_patch: bool = True) -> None: ... + def generate_gds(self, err: int = 0): ... + def generate_test_gds(self, gc, dX_gc2gc: int = 300, dY_gc2gc: int = 40, sharp_patch: bool = True): ... diff --git a/mxpic_release/mxpic/components/primitives/directional_couplers/__init__.py b/mxpic_release/mxpic/components/primitives/directional_couplers/__init__.py deleted file mode 100644 index 88513f7..0000000 --- a/mxpic_release/mxpic/components/primitives/directional_couplers/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from .directional_couplers import * \ No newline at end of file diff --git a/mxpic_release/mxpic/components/primitives/grating_couplers.pyi b/mxpic_release/mxpic/components/primitives/grating_couplers.pyi new file mode 100644 index 0000000..fcbf25b --- /dev/null +++ b/mxpic_release/mxpic/components/primitives/grating_couplers.pyi @@ -0,0 +1,143 @@ +from ...basic import __cell_arg__ as __cell_arg__ +from ...routing import Route as Route +from ...structures import Clothoid as Clothoid, circle as circle, hole as hole +from _typeshed import Incomplete + +class Nano_ant: + w_wg: Incomplete + xs_wg: Incomplete + etch_type: str + vector: Incomplete + teeth_number: Incomplete + pitch: Incomplete + duty_cycle: Incomplete + taper_length: Incomplete + ant_length: Incomplete + width: Incomplete + max_theta: Incomplete + define_type: Incomplete + etch_depth: Incomplete + show_pins: Incomplete + cell: Incomplete + def __init__(self, w_wg: float = 0.41, xs_wg: str = 'strip', define_type: str = 'non-periodic', vector: float | list = [0.5, 0.5, 0.5, 0.5, 0.5, 0.5], taper_length: float = 3, width: float = 6, max_theta: float = 110, pitch: float | list = 0.6, duty_cycle: float | list = 0.3, teeth_number: float = 6, etch_depth: str | list = ['METCH'], show_pins: bool = True) -> None: ... + def generate_gds(self, sample_step: float = 0.1, cell_name: str = 'Nanoantenna'): ... + def generate_gds_positive(self, sample_step: float = 0.1): ... + def generate_gds_error(self) -> None: ... + +class Taper: + width1: Incomplete + width2: Incomplete + length: Incomplete + type: Incomplete + order: int + show_pins: Incomplete + cell: Incomplete + def __init__(self, width1: int = 4, width2: float = 0.45, length: int = 30, type: str = 'linear', show_pins: bool = False) -> None: ... + def generate_gds(self): ... + +class Grating_2D_Hole: + w_wg: Incomplete + w_gt: Incomplete + l_taper: Incomplete + type_taper: Incomplete + gt_vector: Incomplete + gt_num: Incomplete + gt_diameter: Incomplete + gt_layer: Incomplete + polysi_vector: Incomplete + polysi_num: Incomplete + polysi_diameter: Incomplete + polysi_layer: Incomplete + reflector_vector: Incomplete + l_field_center: Incomplete + cell: Incomplete + def __init__(self, w_wg: float = 0.5, w_gt: int = 5, l_taper: int = 30, type_taper: str = 'parabolic', gt_vector=[0.5, 0.5, 0.5, 0.5, 0.5], gt_diameter: float = 0.4, gt_layer: str = 'STRIP_COR', polysi_vector=[0.5, 0.5, 0.5, 0.5, 0.5], polysi_diameter: float = 0.4, polysi_layer: str = 'FCW_TRE', reflector_vector=[0.3, 0.3, 0.3, 0.3, 0.3, 0.3], l_field_center: int = 1) -> None: ... + reflector_num: Incomplete + def generate_gds(self): ... + +class Grating_2D_Hole_4Rec: + gt_2D_class: Incomplete + cell_unit: Incomplete + mode_radius: Incomplete + field_center: Incomplete + show_pins: Incomplete + cell_name: Incomplete + cell: Incomplete + def __init__(self, grating_unit, mode_radius: int = 8, cell_name=None, show_pins: bool = False) -> None: ... + def generate_gds(self): ... + +class Grating_2D_Hole_3Rec: + gt_2D_class: Incomplete + cell_unit: Incomplete + mode_radius: Incomplete + cell_name: Incomplete + field_center: Incomplete + show_pins: Incomplete + cell: Incomplete + def __init__(self, grating_unit, mode_radius: float = 6.5, cell_name=None, show_pins: bool = False) -> None: ... + def generate_gds(self): ... + +class GC_STD_2D: + name: Incomplete + instantiate: bool + num_x: Incomplete + num_y: Incomplete + Lx_taper: Incomplete + Ly_taper: Incomplete + Lx_end: Incomplete + Ly_end: Incomplete + Lx_side: Incomplete + Ly_side: Incomplete + Lx_port: Incomplete + Ly_port: Incomplete + xs_open: Incomplete + w_wg: Incomplete + xs_wg: Incomplete + etch_type: Incomplete + shape: Incomplete + hole_shape: Incomplete + Dx_hole: Incomplete + Dy_hole: Incomplete + Px: Incomplete + Py: Incomplete + P_AR: Incomplete + L_AR: Incomplete + show_pins: Incomplete + positive: bool + layer_etch: Incomplete + cell: Incomplete + def __init__(self, name=None, etch_type: str = 'FETCH', xs_wg: str = 'grating', Dx_hole: float = 0.3, Dy_hole: float = 0.3, hole_shape: str = 'circle', shape: str = 'circle', xs_open: str = None, Px: float = 0.57, Py: float = 0.57, num_x: float = 25, num_y: float = 25, Lx_taper: float = 50, Ly_taper: float = 0, Lx_end: float = 1, Ly_end: float = 1, Lx_side: float = 0.5, Ly_side: float = 0.5, Lx_port: float = 5, Ly_port: float = 5, w_wg: float = 0.5, show_pins: bool = False, P_AR: float = 0.6, L_AR: float = 1) -> None: ... + def generate_negative(self): ... + def generate_positive(self): ... + def generate_test_gds(self, dX_gc2gc: int = 300): ... + +class GC_STD_1D: + name: Incomplete + instantiate: bool + xs_open: Incomplete + xs_wg: Incomplete + w_wg: Incomplete + L_taper: Incomplete + L_end: Incomplete + A_taper: Incomplete + show_pins: Incomplete + L_tail: Incomplete + positive: bool + Period: Incomplete + eta_etch: Incomplete + num: Incomplete + sector_gc: Incomplete + L_AR: Incomplete + P_AR: Incomplete + layer_etch: Incomplete + cell: Incomplete + def __init__(self, name=None, xs_wg: str = 'strip', w_wg: float = 0.5, etch_type: str = 'FETCH', xs_open: str = None, L_taper: float = 10, L_end: float = 2, A_taper: float = 30, Period: float = 0.5, eta_etch: float = 0.5, num: float = 20, sector_gc: bool = True, show_pins: bool = False, L_tail: int = 2, P_AR: float = 1, L_AR: float = 2) -> None: ... + def generate_negative(self): ... + def generate_positive(self): ... + def generate_test_dev(self, dX_gc2gc): ... + +class FA: + pitch: Incomplete + number: Incomplete + cell: Incomplete + def __init__(self, fiber_coupler, pitch, number, show_pins: bool = False) -> None: ... diff --git a/mxpic_release/mxpic/components/primitives/multimode_interferometers.pyi b/mxpic_release/mxpic/components/primitives/multimode_interferometers.pyi new file mode 100644 index 0000000..21aba9d --- /dev/null +++ b/mxpic_release/mxpic/components/primitives/multimode_interferometers.pyi @@ -0,0 +1,29 @@ +from ...structures import * +from ...routing import Route as Route +from ...structures import Conchoid as Conchoid +from _typeshed import Incomplete +from turtle import shape as shape + +class MMI_ML: + name: Incomplete + instantiate: bool + L_arm: Incomplete + xs: Incomplete + w_arm: Incomplete + arm_sine_width: Incomplete + L_mmi: Incomplete + w_mmi: Incomplete + res: Incomplete + N_out: Incomplete + N_in: Incomplete + Dp_out: Incomplete + Dp_in: Incomplete + mmi_sine_width: Incomplete + cell: Incomplete + L: Incomplete + def __init__(self, name=None, L_arm=[10], w_arm=[0.45, 1.35], xs: str = 'strip', arm_sine_width: bool = False, L_mmi=[10], w_mmi=[5, 5], mmi_sine_width: bool = False, sharp_patch: bool = True, show_pins: bool = False, res: float = 0.01, N_out: int = 3, N_in: int = 1, Dp_out: float = 1.5, Dp_in: float = 1.5) -> None: ... + def generate_gds(self, sharp_patch, show_pins): ... + def generate_test_gds(self, gc, dX_gc2gc, dY_gc2gc, R_bend: int = 10, Xout_offset: int = 50): ... + +class MMI_STD(MMI_ML): + def __init__(self, name=None, N_out: int = 3, N_in: int = 1, L_arm: int = 10, w_wg: float = 0.45, w_port: float = 1.2, xs: str = 'strip', L_mmi: int = 10, w_mmi: int = 5, sharp_patch: bool = True, show_pins: bool = False, Dp_out: float = 1.5, Dp_in: float = 1.5) -> None: ... diff --git a/mxpic_release/mxpic/components/primitives/spiral.pyi b/mxpic_release/mxpic/components/primitives/spiral.pyi new file mode 100644 index 0000000..ee51394 --- /dev/null +++ b/mxpic_release/mxpic/components/primitives/spiral.pyi @@ -0,0 +1,108 @@ +from ...structures import * +from ...foundries import * +import nazca as nd +from ...routing import Route as Route +from ...structures import Conchoid as Conchoid +from _typeshed import Incomplete +from scipy import optimize as optimize + +class spiral: + Dmin: Incomplete + Lmin: Incomplete + R_bend: Incomplete + shape: Incomplete + cycles: Incomplete + width: Incomplete + w_port: Incomplete + gap: Incomplete + xs: Incomplete + layer: Incomplete + name: Incomplete + instantiate: bool + port_angle: Incomplete + w_bend_center: Incomplete + Rmin_bend_center: Incomplete + Euler_bend: Incomplete + Rmin_euler: Incomplete + sharp_patch: Incomplete + w_bend_port: Incomplete + Ltp_port: Incomplete + cell_transition: Incomplete + res: Incomplete + cell: Incomplete + def __init__(self, name: str = None, shape: str = 'circle', Dmin: float = 50, R_bend: float = 10, Rmin_euler: float = 10, Lmin: float = 50, width: float = 2, w_port: float = 0.45, w_bend_center: float = 1, Rmin_bend_center: float = 10, gap: float = 1, cycles: float = 20, xs: str = 'strip', layer: str = None, w_bend_port=None, Ltp_port: int = 10, res: float = 0.5, cell_transition: nd.Cell = None, port_angle: float = 180, Euler_bend: bool = False, show_pins: bool = False, sharp_patch: bool = True) -> None: ... + def __strt_with_taper__(self, width1, width2, xs, length, Ltp: int = 15, Lstart: int = 2): ... + Atilt: Incomplete + L: Incomplete + Ru: Incomplete + Rd: Incomplete + bend_cell: Incomplete + def generate_gds(self, show_pins): ... + +class spiral_rectangle: + Dmin: Incomplete + Lmin: Incomplete + Rmax_bend: Incomplete + Rmin_bend: Incomplete + wmin_bend: Incomplete + cycles: Incomplete + width: Incomplete + w_port: Incomplete + gap: Incomplete + xs: Incomplete + layer: Incomplete + Ltp: Incomplete + Lpatch: Incomplete + name: Incomplete + instantiate: bool + port_angle: Incomplete + sharp_patch: Incomplete + w_bend_port: Incomplete + Lport: Incomplete + cell_xs_transition: Incomplete + res: Incomplete + in_out_align: Incomplete + cell: Incomplete + def __init__(self, name: str = None, Dmin: float = 50, Rmax_bend: float = 10, Rmin_bend: float = 10, wmin_bend: float = 10, Lmin: float = 50, width: float = 2, w_port: float = 0.45, gap: float = 1, cycles: float = 20, xs: str = 'strip', layer: str = None, w_bend_port=None, Lport: int = 10, Ltp: int = 10, res: float = 0.5, cell_xs_transition=None, port_angle: float = 180, show_pins: bool = False, sharp_patch: bool = True, in_out_align: bool = True, Lpatch: float = 0.05) -> None: ... + def __strt_with_taper__(self, width1, width2, xs, length, Ltp: int = 15, Lstart: int = 2): ... + bend_cell: Incomplete + L: Incomplete + def generate_gds(self, show_pins): ... + +class Spiral_Rect_STD(spiral_rectangle): + def __init__(self, name: str = None, Dmin: float = 50, R_bend: float = 10, Lmin: float = 50, width: float = 2, w_port: float = 0.45, gap: float = 1, cycles: float = 20, xs: str = 'strip', layer: str = None, Lport: int = 10, in_out_align: bool = True, res: float = 0.5, cell_xs_transition=None, port_angle: float = 180, show_pins: bool = False, sharp_patch: bool = True) -> None: ... + +class spiral_circle: + Dmin: Incomplete + cycles: Incomplete + width: Incomplete + w_port: Incomplete + gap: Incomplete + xs: Incomplete + layer: Incomplete + name: Incomplete + instantiate: bool + port_angle: Incomplete + w_bend_center: Incomplete + Euler_Sbend: Incomplete + sharp_patch: Incomplete + Lport: Incomplete + rib2strip: Incomplete + res: Incomplete + strict_condition: Incomplete + R_ratio_mamnual: Incomplete + cell: Incomplete + def __init__(self, name: str = None, Dmin: float = 50, width: float = 2, w_port: float = 0.45, w_bend_center: float = 1, gap: float = 1, cycles: float = 20, xs: str = 'strip', layer: str = None, Lport: int = 10, res: float = 0.5, rib2strip: bool = True, port_angle: float = 180, Euler_Sbend: bool = False, show_pins: bool = False, sharp_patch: bool = True, strict_condition: bool = False, R_ratio_mamnual=None) -> None: ... + def opt_euler(self, R, R0): ... + Atilt: Incomplete + Rmax: Incomplete + L: Incomplete + Ru: Incomplete + Rd: Incomplete + def generate_gds(self, show_pins): ... + +class Spiral_Cicle_MM(spiral_circle): + def __init__(self, name: str = None, Dmin: float = 50, width: float = 2, w_port: float = 0.45, w_bend_center: float = 1, gap: float = 1, cycles: float = 20, xs: str = 'strip', layer: str = None, Lport: int = 10, res: float = 0.5, rib2strip: bool = True, port_angle: float = 180, show_pins: bool = False, sharp_patch: bool = True, strict_condition: bool = False) -> None: ... + +class Spiral_Cicle_STD(spiral_circle): + def __init__(self, name: str = None, Dmin: float = 50, width: float = 2, w_port: float = 0.45, gap: float = 1, cycles: float = 20, xs: str = 'strip', layer: str = None, Lport: int = 10, res: float = 0.5, rib2strip: bool = True, port_angle: float = 180, show_pins: bool = False, sharp_patch: bool = True, strict_condition: bool = False) -> None: ... diff --git a/mxpic_release/mxpic/core/generate_license.pyi b/mxpic_release/mxpic/core/generate_license.pyi new file mode 100644 index 0000000..f8f63c2 --- /dev/null +++ b/mxpic_release/mxpic/core/generate_license.pyi @@ -0,0 +1,3 @@ +SECRET_KEY: bytes + +def generate_license(mac_address: str, days_valid: int, output_file: str = 'mxpic.lic'): ... diff --git a/mxpic_release/mxpic/core/license_check.pyi b/mxpic_release/mxpic/core/license_check.pyi new file mode 100644 index 0000000..ce59c57 --- /dev/null +++ b/mxpic_release/mxpic/core/license_check.pyi @@ -0,0 +1 @@ +def verify_license() -> None: ... diff --git a/mxpic_release/mxpic/foundries/AMF.pyi b/mxpic_release/mxpic/foundries/AMF.pyi new file mode 100644 index 0000000..2d2b2ba --- /dev/null +++ b/mxpic_release/mxpic/foundries/AMF.pyi @@ -0,0 +1,11 @@ +from .Foundry import Foundry as Foundry + +class AMF_Si220_Active(Foundry): + STD_SMWG_WIDTH: float + SLAB_GROWTH: int + W_METAL_MIN: int + SPACING_HEATER_MIN: int + SPACING_METAL_MIN: int + W_HEATER_MIN: int + lib_path: str + def __init__(self, layermap=...) -> None: ... diff --git a/mxpic_release/mxpic/foundries/Foundry.pyi b/mxpic_release/mxpic/foundries/Foundry.pyi new file mode 100644 index 0000000..76dbb0c --- /dev/null +++ b/mxpic_release/mxpic/foundries/Foundry.pyi @@ -0,0 +1,16 @@ +from _typeshed import Incomplete + +class Foundry: + STD_SMWG_WIDTH: float + SLAB_GROWTH: int + W_METAL_MIN: int + SPACING_HEATER_MIN: int + SPACING_METAL_MIN: float + W_HEATER_MIN: int + W_VIA_H2M: float + SPACING_VIA_H2M: float + ISL_W_MIN: int + ISL_SP_MIN: int + show_pins: bool + layermap: Incomplete + def __init__(self, layermap=None) -> None: ... diff --git a/mxpic_release/mxpic/foundries/Silterra.pyi b/mxpic_release/mxpic/foundries/Silterra.pyi new file mode 100644 index 0000000..689a483 --- /dev/null +++ b/mxpic_release/mxpic/foundries/Silterra.pyi @@ -0,0 +1,11 @@ +from .Foundry import Foundry as Foundry + +class EOM1_2ML_CU(Foundry): + STD_SMWG_WIDTH: float + SLAB_GROWTH: int + W_METAL_MIN: int + SPACING_HEATER_MIN: int + SPACING_METAL_MIN: int + W_HEATER_MIN: int + lib_path: str + def __init__(self, layermap=...) -> None: ... diff --git a/mxpic_release/mxpic/foundries/__init__.py b/mxpic_release/mxpic/foundries/__init__.py deleted file mode 100644 index f9a6cc7..0000000 --- a/mxpic_release/mxpic/foundries/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -from .CUMEC import CUMEC_CSiP130Cu,CUMEC_CSiP180Al_PASSIVE - -from .AMF import AMF_Si220_Active - -from .ANT import ANT_Si220_MPW - -from .IMEC import IMEC_Si220_Active - -from .IMECAS import IMECAS_SiP - -from .Foundry import Foundry - -from .CompTek import CT_CU3ML - -from .SITRI import SITRI_LSIN_SOI - -from .Silterra import EOM1_2ML_CU - - - - - - - - diff --git a/mxpic_release/mxpic/foundries/__init__.pyi b/mxpic_release/mxpic/foundries/__init__.pyi new file mode 100644 index 0000000..57b2a25 --- /dev/null +++ b/mxpic_release/mxpic/foundries/__init__.pyi @@ -0,0 +1,2 @@ +from .AMF import AMF_Si220_Active as AMF_Si220_Active +from .Silterra import EOM1_2ML_CU as EOM1_2ML_CU diff --git a/mxpic_release/mxpic/routing/__init__.py b/mxpic_release/mxpic/routing/__init__.py deleted file mode 100644 index d77a451..0000000 --- a/mxpic_release/mxpic/routing/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from .routing import * \ No newline at end of file diff --git a/mxpic_release/mxpic/routing/__init__.pyi b/mxpic_release/mxpic/routing/__init__.pyi new file mode 100644 index 0000000..94cee78 --- /dev/null +++ b/mxpic_release/mxpic/routing/__init__.pyi @@ -0,0 +1 @@ +from .routing import * diff --git a/mxpic_release/mxpic/routing/routing.pyi b/mxpic_release/mxpic/routing/routing.pyi new file mode 100644 index 0000000..eebfd59 --- /dev/null +++ b/mxpic_release/mxpic/routing/routing.pyi @@ -0,0 +1,36 @@ +from ..structures import * +import nazca as nd +from _typeshed import Incomplete + +def ic_exception(msg: str = '') -> None: ... + +class Route(nd.interconnects.Interconnect): + PCB: Incomplete + sharp_patch: Incomplete + Ltp_mm: Incomplete + width2_mm: Incomplete + MM_route: Incomplete + def __init__(self, radius=None, width=None, angle: int = 90, Ltp_mm: int = 10, width2_mm: float = 1.0, MM_route: bool = False, xs=None, layer=None, adapt_width: bool = False, adapt_xs: bool = False, instantiate: bool = False, pinstyle=None, offset=None, varname=None, doc: str = '', PCB: bool = False, modes=None, sharp_patch: bool = True) -> None: ... + def connPatch(self) -> None: ... + def rt_bend(self, width: int = 3, xs: str = 'strip', angle: int = 90, layer=None, pin=None): ... + def strt_mm(self, pin=None, width2=None, Ltp=None, width1=None, Lstart: float = 0.5, length=None, xs=None, arrow: bool = False): ... + def line_mm(self, length=None, width=None, xs=None, width_mm=None, Ltp=None): ... + def strt_mm_p2p(self, pin1=None, pin2=None, width2=None, Ltp=None, width1=None, Lstart: float = 0.5, length=None, xs=None, arrow: bool = False, name=None): ... + def bend_p2p(self, pin1=None, pin2=None, radius=None, width=None, xs=None, name=None, arrow: bool = False, width_mm=None, Ltp=None, sharp_path: bool = True): ... + def ubend_route(self, pin=None, offset: float = 20.0, radius=None, width=None, xs=None, length: int = 0, name=None, arrow: bool = False, balance: int = 0, end_angle: bool = False, width_mm=None, Ltp=None): ... + def sbend_route(self, radius=None, width=None, pin=None, xs=None, offset: int = 20, Ltot=None, length1: int = 0, length2: int = 0, name=None, arrow: bool = False, Amax: float = 90.0, original_function: bool = False): ... + def bend_strt_bend_p2p_mine(self, pin1=None, pin2=None, radius=None, radius1=None, radius2=None, width=None, xs=None, length1: int = 0, length2: int = 0, ictype: str = 'shortest', name=None, arrow: bool = False): ... + def bend_route(self, radius=None, angle=None, width=None, pin=None, xs=None, length1: float = 0.1, length2: float = 0.1, name=None, arrow: bool = False, offset=None, sharp_patch: bool = True, original_function: bool = False): ... + def bend_route_p2p(self, pin1=None, pin2=None, radius=None, width=None, xs=None, name=None, arrow: bool = False, original_function: bool = False): ... + def bend_mine(self, radius=None, angle=None, width=None, pin=None, xs=None, length1: int = 0, length2: int = 0, name=None, arrow: bool = False, offset=None, sharp_patch: bool = True): ... + def tube_mine(self, geo, showpins: bool = False, name=None, xs=None, arrow: bool = False, Ltp=None, width_mm=None, sharp_patch=None): ... + def strt_bend_strt_p2p_mine(self, pin1=None, pin2=None, radius=None, radius1=None, radius2=None, width=None, xs=None, length1: int = 0, length2: int = 0, ictype: str = 'shortest', name=None, arrow: bool = False, width_mm=None, Ltp=None): ... + def sbend_p2p_mine(self, pin1=None, pin2=None, width=None, radius=None, Lstart: int = 0, doFirst: int = 1, arrow: bool = False, width_mm=None, Ltp=None, sharp_patch: bool = False): ... + def sbend_p2p(self, pin1=None, pin2=None, width=None, radius=None, Amax: int = 90, xs=None, doStrFirst: int = 1, Lstart: int = 0, BendEndFlag: int = 1, ref=None, name=None, arrow: bool = False, bsb: bool = True, sharp_patch=None, width_mm=None, Ltp=None): ... + def bend_strt_bend_p2p(self, pin1=None, pin2=None, radius=None, radius1=None, radius2=None, width=None, xs=None, length1: int = 0, length2: int = 0, ictype: str = 'shortest', name=None, arrow: bool = True, width_mm=None, Ltp=None): ... + def ubend_p2p(self, pin1=None, pin2=None, radius=None, width=None, xs=None, length: float = 0.1, name=None, arrow: bool = False, balance: int = 0, end_angle: bool = False, original_function: bool = False, Ltp=None, width_mm=None): ... + def strt(self, length=None, width=None, pin=None, xs=None, edge1=None, edge2=None, edgepoints: int = 50, name=None, arrow: bool = False, gridpatch=None): ... + def taper(self, length=None, width1=None, width2=None, shift: int = 0, xs=None, pin=None, name=None, patch: bool = False, arrow: bool = False): ... + adapt_width: bool + def taper_p2p(self, pin1=None, pin2=None, width1=None, width2=None, xs=None, name=None, arrow: bool = False): ... + def strt_p2p(self, pin1=None, pin2=None, width=None, xs=None, name=None, arrow: bool = False): ... diff --git a/mxpic_release/mxpic/setup.py b/mxpic_release/mxpic/setup.py new file mode 100644 index 0000000..cb12db5 --- /dev/null +++ b/mxpic_release/mxpic/setup.py @@ -0,0 +1,9 @@ +import os +from setuptools import setup, Extension + + +setup( + name="mxpic", + version="1.0.0", + +) \ No newline at end of file diff --git a/mxpic_release/mxpic/structures.pyi b/mxpic_release/mxpic/structures.pyi new file mode 100644 index 0000000..52bc280 --- /dev/null +++ b/mxpic_release/mxpic/structures.pyi @@ -0,0 +1,113 @@ +import numpy as np +from _typeshed import Incomplete + +class hole: + cell: Incomplete + def __init__(self, r_hole: float = 0.3, Dx_hole: float = 0.3, Dy_hole: float = 0.3, Lx_sq: int = 6, Ly_sq: int = 6, offset: int = 0, res: float = 0.05, xs: str = 'strip', layer=None, sharp_patch: bool = True, hole_shape: str = 'circle') -> None: ... + +class strt_round_courner: + cell: Incomplete + def __init__(self, width: int = 5, length: int = 10, layer=None, radius: int = 1, n_points: int = 64) -> None: ... + +class circle: + vtx: Incomplete + sz: Incomplete + w: Incomplete + cell: Incomplete + def __init__(self, radius: int = 10, width: float = 0.45, theta_start: int = 0, theta_stop: int = 360, res: float = 0.05, angle=None, xs: str = 'strip', layer=None, sharp_patch: bool = True, y_cut=None) -> None: ... + +class mx_bend: + sz: Incomplete + w: Incomplete + cell: Incomplete + def __init__(self, radius: int = 10, width: float = 0.45, theta_start: int = 0, theta_stop: int = 360, res: float = 0.05, angle=None, xs: str = 'strip', layer=None, sharp_patch: bool = True) -> None: ... + +class Elipse_dual: + ORx: Incomplete + ORy: Incomplete + IRx: Incomplete + IRy: Incomplete + offset_X: Incomplete + offset_Y: Incomplete + xs: Incomplete + layer: Incomplete + res: Incomplete + theta_start: Incomplete + theta_stop: Incomplete + y_cut: Incomplete + cell: Incomplete + wa: Incomplete + wb: Incomplete + def __init__(self, ORx: float, ORy: float, IRx: float, IRy: float, offset_X: float = 0, offset_Y: float = 0, xs: str = None, layer: str = None, theta_start: float = 0, theta_stop: float = 360, sharp_patch: bool = True, res: float = 0.001, y_cut=None) -> None: ... + sz: Incomplete + def generate_gds(self, sharp_patch): ... + +class Elipse: + La: Incomplete + Lb: Incomplete + wa: Incomplete + wb: Incomplete + offset_a: Incomplete + offset_b: Incomplete + type: Incomplete + layer: Incomplete + xs: Incomplete + theta_start: Incomplete + theta_stop: Incomplete + res: Incomplete + cell: Incomplete + def __init__(self, La=None, Lb=None, wa=None, wb=None, offset_a: int = 0, offset_b: int = 0, type: str = 'center', width_type: str = 'sine', layer=None, xs=None, theta_start: int = 0, theta_stop: int = 360, res: float = 0.001, sharp_patch: bool = False, show_pins: bool = False) -> None: ... + sz: Incomplete + def generate_gds(self, sharp_patch, show_pins): ... + +class Conchoid: + Atilt: Incomplete + L: Incomplete + cell: Incomplete + vtx_center: Incomplete + vtx: Incomplete + K_end: Incomplete + R_end: Incomplete + def __init__(self, R0, kR, T, w, layer, w_end=None, res: float = 0.1, final_flat=None, begin_flat=None, xs=None) -> None: ... + +class Clothoid: + name: Incomplete + R: Incomplete + A: Incomplete + width_type: Incomplete + spiral_order: Incomplete + dL_cal: Incomplete + xs: Incomplete + layer: Incomplete + dL_wg: Incomplete + x: Incomplete + y: Incomplete + L: Incomplete + L0: Incomplete + theta: Incomplete + vtx_center: Incomplete + end_patch: Incomplete + sz: Incomplete + n_points: Incomplete + w: Incomplete + cell: Incomplete + def __init__(self, name: str = None, R: list | np.ndarray = [10, 20], w: list | np.ndarray | float = [0.4, 0.5], A: list | np.ndarray = [0, 45], width_type: str = 'sine', spiral_order: float | list = 1, Rmax: float = 10000, dL_cal: float = 0.001, dL_wg: float = 0.1, xs: str = 'strip', layer: str = None, sharp_patch: bool = True, end_patch: bool = True, show_pins: bool = False) -> None: ... + instantiate: bool + vtx: Incomplete + sz_p2p: Incomplete + def generate_gds(self, sharp_patch, show_pins): ... + +class Racetrack: + dLx: Incomplete + R_bend: Incomplete + dLy: Incomplete + xs: Incomplete + layer: Incomplete + bend_cell: Incomplete + A_bend: Incomplete + w: Incomplete + w_crack: float + cell: Incomplete + def __init__(self, bend_cell=None, xs: str = 'strip', layer=None, R_bend: int = 10, w: float = 0.5, dLx: int = 100, dLy: int = 100, res: float = 0.001) -> None: ... + sz: Incomplete + def generate_gds(self): ... diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..c46f354 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,8 @@ +[build-system] +# These are the packages the temporary environment MUST install before running setup.py +requires = [ + "setuptools>=61.0", + "wheel", + "Cython>=3.0.0" +] +build-backend = "setuptools.build_meta" \ No newline at end of file diff --git a/setup.py b/setup.py index 5d3a1c7..c26f840 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,8 @@ def find_pyx_files(directory): dirs.remove('docs') for file in files: - if file.endswith(".py") and file != "__init__.py": + # if file.endswith(".py") and file != "__init__.py": + if file.endswith(".py"): paths.append(os.path.join(root, file)) return paths @@ -30,8 +31,13 @@ extensions = [ setup( name="mxpic", version="1.0.0", + # Tell setuptools to include all .pyi files across all sub-folders + package_data={ + "mxpic": ["*.pyi", "**/*.pyi"], + }, + include_package_data=True, ext_modules=cythonize( extensions, - compiler_directives={'language_level': "3"} # Force Python 3 + compiler_directives={'language_level': "3"} ), ) \ No newline at end of file