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

2026-05-03 17:27:05 +08:00
parent e4366b8a6c
commit 802ab5115d
56 changed files with 5464 additions and 1 deletions
@@ -0,0 +1,18 @@
+.. 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 `toctree` directive.
+
+# mxpic_handbook documentation
+============================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+Welcome to the automated documentation for the mxPIC silicon photonics library.
+```{toctree}
+   :maxdepth: 2
+   :caption: Components:
+
+primitives/edge_couplers/edge_couplers
@@ -0,0 +1,25 @@
+# Edge Coupler Reference
+
+This section covers the dual-layer edge coupler designs used for fiber-to-chip interfacing.
+
+## Dual Layer PX3
+The `EC_dual_layer_px3` is our standard spot-size converter.
+```{eval-rst}
+.. autoclass:: mxpic_forge.primitives.edge_couplers.EC_dual_layer_px3.EC_dual_layer_px3
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+```
+```{figure} ../../_static/images/ec_px3_layout.png
+:width: 600px
+:align: center
+:alt: GDS layout of the dual-layer edge coupler
+
+Figure 1: GDS layout of the EC_dual_layer_px3 showing the SiN-to-SOI taper transition.
+```
+
+## Design Notes
+- Tapers: Ensure Ltp1, Ltp2, and Ltp3 provide enough length for adiabatic mode expansion.  
+
+- Alignment: The angle_tile parameter (default 8°) is critical for reducing back-reflections.