PotatoMaxwell/mxpic_forge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

first commit to the repository with Sphinx build inside for HTML construction

Browse Source
This commit is contained in:
PotatoMaxwell
2026-05-03 17:27:05 +08:00
parent e4366b8a6c
commit 802ab5115d
56 changed files with 5464 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/build/html/primitives/edge_couplers/edge_couplers.html
Vendored
+476
View File
@@ -0,0 +1,476 @@
<!DOCTYPE html>
<html lang="en" data-content_root="../../" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Edge Coupler Reference &#8212; mxpic_handbook mxpic documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8f2a1f02" />
<!-- So that users can add custom icons -->
<script src="../../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="../../_static/documentation_options.js?v=91346475"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'primitives/edge_couplers/edge_couplers';</script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="prev" title="mxpic_handbook documentation" href="../../index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="../../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="../../index.html">
<p class="title logo__title">mxPIC Handbook</p>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
Edge Coupler Reference
</a>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
Edge Coupler Reference
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"></div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Edge Coupler Reference</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="edge-coupler-reference">
<h1>Edge Coupler Reference<a class="headerlink" href="#edge-coupler-reference" title="Link to this heading">#</a></h1>
<p>This section covers the dual-layer edge coupler designs used for fiber-to-chip interfacing.</p>
<section id="dual-layer-px3">
<h2>Dual Layer PX3<a class="headerlink" href="#dual-layer-px3" title="Link to this heading">#</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">EC_dual_layer_px3</span></code> is our standard spot-size converter.</p>
<dl class="py class">
<dt class="sig sig-object py" id="mxpic_forge.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic_forge.primitives.edge_couplers.EC_dual_layer_px3.</span></span><span class="sig-name descname"><span class="pre">EC_dual_layer_px3</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_in</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_in</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ltp1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ltp2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ltp3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_tip_core</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w1_slab</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.6</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_tip_slab</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_mid_slab</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.45</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_box</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_box_end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">12</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_box_end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_DT</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">12</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs_SiN</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'sin'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer_SiN_slab</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'SiN_Rib_WG'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer_DT</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'OXIDE_FACET'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs_Trench</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'air_trench'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer_top_cover</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PAD_OPTICAL'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer_dum_exl_be</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">angle_tile</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">R_bend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic_forge.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3" title="Link to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Dual-layer Edge Coupler (Spot Size Converter) for fiber-to-chip coupling.</p>
<p>This component manages the adiabatic transition between a high-index
contrast core and a secondary slab/cladding layer (e.g., SiN to SOI).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) – Unique identifier for the device cell.</p></li>
<li><p><strong>w_in</strong> (<em>float</em>) – Input waveguide width in microns.</p></li>
<li><p><strong>L_in</strong> (<em>float</em>) – Length of the initial input section.</p></li>
<li><p><strong>Ltp1</strong> (<em>float</em>) – Lengths of the first, second, and third taper sections respectively.</p></li>
<li><p><strong>Ltp2</strong> (<em>float</em>) – Lengths of the first, second, and third taper sections respectively.</p></li>
<li><p><strong>Ltp3</strong> (<em>float</em>) – Lengths of the first, second, and third taper sections respectively.</p></li>
<li><p><strong>L_end</strong> (<em>float</em><em>, </em><em>optional</em>) – Length of the final facet extension (default is 0).</p></li>
<li><p><strong>w_tip_core</strong> (<em>float</em><em>, </em><em>optional</em>) – Width of the core taper tip in microns (default is 0.2).</p></li>
<li><p><strong>w1_slab</strong> (<em>float</em><em>, </em><em>optional</em>) – Initial width of the slab/cladding layer.</p></li>
<li><p><strong>w_tip_slab</strong> (<em>float</em><em>, </em><em>optional</em>) – Width of the slab taper tip at the facet.</p></li>
<li><p><strong>w_mid_slab</strong> (<em>float</em><em>, </em><em>optional</em>) – Width of the slab at the transition midpoint.</p></li>
<li><p><strong>w_box</strong> (<em>float</em><em>, </em><em>optional</em>) – Dimensions for the deep-trench/oxide box clearing.</p></li>
<li><p><strong>w_box_end</strong> (<em>float</em><em>, </em><em>optional</em>) – Dimensions for the deep-trench/oxide box clearing.</p></li>
<li><p><strong>L_box_end</strong> (<em>float</em><em>, </em><em>optional</em>) – Dimensions for the deep-trench/oxide box clearing.</p></li>
<li><p><strong>w_DT</strong> (<em>float</em><em>, </em><em>optional</em>) – Deep Trench width.</p></li>
<li><p><strong>xs_SiN</strong> (<em>str</em><em>, </em><em>optional</em>) – Cross-section name for the Nitride layer (default is “sin”).</p></li>
<li><p><strong>layer_SiN_slab</strong> (<em>str</em><em>, </em><em>optional</em>) – GDS layer name for the SiN slab.</p></li>
<li><p><strong>layer_DT</strong> (<em>str</em><em>, </em><em>optional</em>) – GDS layer for the deep trench/oxide facet.</p></li>
<li><p><strong>xs_Trench</strong> (<em>str</em><em>, </em><em>optional</em>) – Cross-section name for the air trench.</p></li>
<li><p><strong>layer_top_cover</strong> (<em>str</em><em>, </em><em>optional</em>) – GDS layer for the optical pad/top cladding opening.</p></li>
<li><p><strong>layer_dum_exl_be</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer for dummy exclusion (BEOL).</p></li>
<li><p><strong>angle_tile</strong> (<em>float</em><em>, </em><em>optional</em>) – Facet tilt angle in degrees to reduce back-reflection (default is 8).</p></li>
<li><p><strong>R_bend</strong> (<em>float</em><em>, </em><em>optional</em>) – Radius of curvature for associated routing bends (default is 50).</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="mxpic_forge.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3.generate_gds">
<span class="sig-name descname"><span class="pre">generate_gds</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxpic_forge.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3.generate_gds" title="Link to this definition">#</a></dt>
<dd><p>central core</p>
</dd></dl>
</dd></dl>
<figure class="align-center" id="id1">
<a class="reference internal image-reference" href="../../_images/ec_px3_layout.png"><img alt="GDS layout of the dual-layer edge coupler" src="../../_images/ec_px3_layout.png" style="width: 600px;" />
</a>
<figcaption>
<p><span class="caption-text">Figure 1: GDS layout of the EC_dual_layer_px3 showing the SiN-to-SOI taper transition.</span><a class="headerlink" href="#id1" title="Link to this image">#</a></p>
</figcaption>
</figure>
</section>
<section id="design-notes">
<h2>Design Notes<a class="headerlink" href="#design-notes" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>Tapers: Ensure Ltp1, Ltp2, and Ltp3 provide enough length for adiabatic mode expansion.</p></li>
<li><p>Alignment: The angle_tile parameter (default 8°) is critical for reducing back-reflections.</p></li>
</ul>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="../../index.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">mxpic_handbook documentation</p>
</div>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#dual-layer-px3">Dual Layer PX3</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#mxpic_forge.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3"><code class="docutils literal notranslate"><span class="pre">EC_dual_layer_px3</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#mxpic_forge.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3.generate_gds"><code class="docutils literal notranslate"><span class="pre">EC_dual_layer_px3.generate_gds()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#design-notes">Design Notes</a></li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/primitives/edge_couplers/edge_couplers.md.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2026, Qin Yue (PotatoMaxwell).
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
</div>
</div>
</footer>
</body>
</html>