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

Updated of the forge from github with image system online

Browse Source
This commit is contained in:
PotatoMaxwell
2026-05-08 16:20:49 +08:00
parent d7c19ed782
commit 9f2e3f3f78
152 changed files with 1573 additions and 1201 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/build/html/index.html
Vendored
+496
View File
@@ -0,0 +1,496 @@
<!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>Welcome to the automated documentation for the mxPIC silicon photonics library. &#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 = 'index';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="mxpic.components.primitives.beam_splitters" href="mxpic/components/primitives/beam_splitters.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="#">
<p class="title logo__title">mxpic_handbook mxpic documentation</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 ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/beam_splitters.html">
mxpic.components.primitives.beam_splitters
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/directional_couplers.html">
mxpic.components.primitives.directional_couplers
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/EC_dual_layer_px3.html">
mxpic.components.primitives.EC_dual_layer_px3
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/grating_couplers.html">
mxpic.components.primitives.grating_couplers
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/multimode_interferometers.html">
mxpic.components.primitives.multimode_interferometers
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button"
data-bs-toggle="dropdown" aria-expanded="false"
aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="mxpic/components/primitives/spiral.html">
mxpic.components.primitives.spiral
</a>
</li>
</ul>
</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 hide-on-wide">
<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 ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/beam_splitters.html">
mxpic.components.primitives.beam_splitters
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/directional_couplers.html">
mxpic.components.primitives.directional_couplers
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/EC_dual_layer_px3.html">
mxpic.components.primitives.EC_dual_layer_px3
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/grating_couplers.html">
mxpic.components.primitives.grating_couplers
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/multimode_interferometers.html">
mxpic.components.primitives.multimode_interferometers
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="mxpic/components/primitives/spiral.html">
mxpic.components.primitives.spiral
</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__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>
<div id="searchbox"></div>
<article class="bd-article">
<p>.. mxpic_handbook documentation master file, created by
sphinx-quickstart on Sun May 3 16:05:57 2026.
You can adapt this file completely to your liking, but it should at least
contain the root <code class="docutils literal notranslate"><span class="pre">toctree</span></code> directive.</p>
<section id="welcome-to-the-automated-documentation-for-the-mxpic-silicon-photonics-library">
<h1>Welcome to the automated documentation for the mxPIC silicon photonics library.<a class="headerlink" href="#welcome-to-the-automated-documentation-for-the-mxpic-silicon-photonics-library" title="Link to this heading">#</a></h1>
<div class="toctree-wrapper compound">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Components:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="mxpic/components/primitives/beam_splitters.html">mxpic.components.primitives.beam_splitters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/beam_splitters.html#ybranch">YBranch</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/beam_splitters.html#ybranch-3wg">Ybranch_3wg</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mxpic/components/primitives/directional_couplers.html">mxpic.components.primitives.directional_couplers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/directional_couplers.html#adc-std-2x2">ADC_STD_2x2</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/directional_couplers.html#bs-tdc">BS_tdc</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/directional_couplers.html#dc">DC</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/directional_couplers.html#dc-bend">DC_bend</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/directional_couplers.html#dc-px-3sg">DC_pX_3sg</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/directional_couplers.html#mdm">MDM</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/directional_couplers.html#ring-bus-wg">ring_bus_wg</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mxpic/components/primitives/EC_dual_layer_px3.html">mxpic.components.primitives.EC_dual_layer_px3</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/EC_dual_layer_px3.html#ec-dual-layer-px3">EC_dual_layer_px3</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mxpic/components/primitives/grating_couplers.html">mxpic.components.primitives.grating_couplers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/grating_couplers.html#fa">FA</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/grating_couplers.html#gc-std-1d">GC_STD_1D</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/grating_couplers.html#gc-std-2d">GC_STD_2D</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/grating_couplers.html#grating-2d-hole">Grating_2D_Hole</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/grating_couplers.html#grating-2d-hole-3rec">Grating_2D_Hole_3Rec</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/grating_couplers.html#grating-2d-hole-4rec">Grating_2D_Hole_4Rec</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/grating_couplers.html#nano-ant">Nano_ant</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/grating_couplers.html#taper">Taper</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mxpic/components/primitives/multimode_interferometers.html">mxpic.components.primitives.multimode_interferometers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/multimode_interferometers.html#mmi-ml">MMI_ML</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/multimode_interferometers.html#mmi-std">MMI_STD</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mxpic/components/primitives/spiral.html">mxpic.components.primitives.spiral</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/spiral.html#spiral-cicle-mm">Spiral_Cicle_MM</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/spiral.html#spiral-cicle-std">Spiral_Cicle_STD</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/spiral.html#spiral-rect-std">Spiral_Rect_STD</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/spiral.html#spiral">spiral</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/spiral.html#spiral-circle">spiral_circle</a></li>
<li class="toctree-l2"><a class="reference internal" href="mxpic/components/primitives/spiral.html#spiral-rectangle">spiral_rectangle</a></li>
</ul>
</li>
</ul>
</div>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="right-next"
href="mxpic/components/primitives/beam_splitters.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">mxpic.components.primitives.beam_splitters</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</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 role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.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>