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

Folder structure simplfied

Browse Source
This commit is contained in:
=
2026-06-06 16:43:26 +08:00
parent 8da92ced57
commit 8a17f1dde0
138 changed files with 10429 additions and 1432 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/build/html/mxpic/components/primitives/pic/PBS.html
Vendored
+27 -1
View File
@@ -303,7 +303,13 @@
<li class="toctree-l1"><a class="reference internal" href="../../gds_devices.html">mxpic.components.gds_devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../pins.html">mxpic.components.pins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../routing.html">mxpic.components.routing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../structures.html">mxpic.components.structures</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../geometry/index.html">Geometry</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/polygons.html">mxpic.components.geometry.polygons</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/rings.html">mxpic.components.geometry.rings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/curves.html">mxpic.components.geometry.curves</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/racetrack.html">mxpic.components.geometry.racetrack</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
@@ -378,6 +384,26 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.PBS.PBS_3wg">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.PBS.</span></span><span class="sig-name descname"><span class="pre">PBS_3wg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lcp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">11.7</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w1_tp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.55</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w2_tp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_m</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">gap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.25</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">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">A_bend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">7.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_wg</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">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.PBS.PBS_3wg" 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>PBS 3wg primitive component.</p>
<p>This component builds the PBS 3wg layout cell.</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>Optional</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>Lcp</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 11.7.</p></li>
<li><p><strong>w1_tp</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the w1_tp parameter. Default is 0.55.</p></li>
<li><p><strong>w2_tp</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the w2_tp parameter. Default is 0.3.</p></li>
<li><p><strong>w_m</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>gap</strong> (<em>float</em><em>, </em><em>optional</em>) – Spacing or gap parameter in microns. Default is 0.25.</p></li>
<li><p><strong>R_bend</strong> (<em>int</em><em>, </em><em>optional</em>) – Radius parameter in microns. Default is 20.</p></li>
<li><p><strong>A_bend</strong> (<em>float</em><em>, </em><em>optional</em>) – Angle parameter in degrees. Default is 7.5.</p></li>
<li><p><strong>w_wg</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.PBS.PBS_3wg.generate_gds">
<span class="sig-name descname"><span class="pre">generate_gds</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.PBS.PBS_3wg.generate_gds" title="Link to this definition">#</a></dt>
docs/build/html/mxpic/components/primitives/pic/YBS.html
Vendored
+45 -1
View File
@@ -303,7 +303,13 @@
<li class="toctree-l1"><a class="reference internal" href="../../gds_devices.html">mxpic.components.gds_devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../pins.html">mxpic.components.pins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../routing.html">mxpic.components.routing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../structures.html">mxpic.components.structures</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../geometry/index.html">Geometry</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/polygons.html">mxpic.components.geometry.polygons</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/rings.html">mxpic.components.geometry.rings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/curves.html">mxpic.components.geometry.curves</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/racetrack.html">mxpic.components.geometry.racetrack</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
@@ -378,6 +384,24 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.YBS.YBranch">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.YBS.</span></span><span class="sig-name descname"><span class="pre">YBranch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[1.2,</span> <span class="pre">1.0,</span> <span class="pre">1.8,</span> <span class="pre">1.2,</span> <span class="pre">1.0,</span> <span class="pre">1.2,</span> <span class="pre">1.2]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">6</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">R_att</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">A_att</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_port</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">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">res</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.YBS.YBranch" 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>YBranch primitive component.</p>
<p>This component builds the YBranch layout cell.</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><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>w</strong> (<em>list</em><em> or </em><em>np.ndarray</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is [1.2, 1.0, 1.8, 1.2, 1.0, 1.2, 1.2].</p></li>
<li><p><strong>L</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 6.</p></li>
<li><p><strong>R_att</strong> (<em>float</em><em>, </em><em>optional</em>) – Radius parameter in microns. Default is 10.</p></li>
<li><p><strong>A_att</strong> (<em>float</em><em>, </em><em>optional</em>) – Angle parameter in degrees. Default is 10.</p></li>
<li><p><strong>w_port</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
<li><p><strong>res</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the res parameter. Default is 0.1.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.YBS.YBranch.generate_gds">
<span class="sig-name descname"><span class="pre">generate_gds</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.YBS.YBranch.generate_gds" title="Link to this definition">#</a></dt>
@@ -392,6 +416,26 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.YBS.Ybranch_3wg">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.YBS.</span></span><span class="sig-name descname"><span class="pre">Ybranch_3wg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">w0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.4</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w1</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">gap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.18</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lcp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_wg</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">R0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">angle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_attach</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_in_tp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.YBS.Ybranch_3wg" 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>Ybranch 3wg primitive component.</p>
<p>This component builds the Ybranch 3wg layout cell.</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>Optional</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>w0</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.4.</p></li>
<li><p><strong>w1</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.2.</p></li>
<li><p><strong>gap</strong> (<em>float</em><em>, </em><em>optional</em>) – Spacing or gap parameter in microns. Default is 0.18.</p></li>
<li><p><strong>Lcp</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 20.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>w_wg</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>R0</strong> (<em>float</em><em>, </em><em>optional</em>) – Radius parameter in microns. Default is 10.</p></li>
<li><p><strong>angle</strong> (<em>float</em><em>, </em><em>optional</em>) – Angle parameter in degrees. Default is 20.</p></li>
<li><p><strong>L_attach</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 3.</p></li>
<li><p><strong>L_in_tp</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 3.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.YBS.Ybranch_3wg.generate_gds">
<span class="sig-name descname"><span class="pre">generate_gds</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">err_asy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.YBS.Ybranch_3wg.generate_gds" title="Link to this definition">#</a></dt>
docs/build/html/mxpic/components/primitives/pic/bragg.html
Vendored
+43 -1
View File
@@ -303,7 +303,13 @@
<li class="toctree-l1"><a class="reference internal" href="../../gds_devices.html">mxpic.components.gds_devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../pins.html">mxpic.components.pins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../routing.html">mxpic.components.routing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../structures.html">mxpic.components.structures</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../geometry/index.html">Geometry</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/polygons.html">mxpic.components.geometry.polygons</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/rings.html">mxpic.components.geometry.rings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/curves.html">mxpic.components.geometry.curves</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/racetrack.html">mxpic.components.geometry.racetrack</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
@@ -378,6 +384,25 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.bragg.Bragg_apodized">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.bragg.</span></span><span class="sig-name descname"><span class="pre">Bragg_apodized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Period</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">etch_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'FETCH'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">etch_shape</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'rectangle'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">N</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">200</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eta_etch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dT</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eta_ds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.bragg.Bragg_apodized" 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>Bragg apodized primitive component.</p>
<p>This component builds the Bragg apodized layout cell.</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>Period</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Period parameter. Default is 0.3.</p></li>
<li><p><strong>w</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 1.1.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>etch_type</strong> (<em>str</em><em>, </em><em>optional</em>) – Value for the etch_type parameter. Default is ‘FETCH’.</p></li>
<li><p><strong>etch_shape</strong> (<em>str</em><em>, </em><em>optional</em>) – Value for the etch_shape parameter. Default is ‘rectangle’.</p></li>
<li><p><strong>N</strong> (<em>int</em><em>, </em><em>optional</em>) – Value for the N parameter. Default is 200.</p></li>
<li><p><strong>eta_etch</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the eta_etch parameter. Default is 0.5.</p></li>
<li><p><strong>dT</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the dT parameter. Default is 0.15.</p></li>
<li><p><strong>b</strong> (<em>int</em><em>, </em><em>optional</em>) – Value for the b parameter. Default is 10.</p></li>
<li><p><strong>eta_ds</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the eta_ds parameter. Default is 0.5.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.bragg.Bragg_apodized.generate_negative">
<span class="sig-name descname"><span class="pre">generate_negative</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.bragg.Bragg_apodized.generate_negative" title="Link to this definition">#</a></dt>
@@ -397,6 +422,23 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.bragg.Bragg">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.bragg.</span></span><span class="sig-name descname"><span class="pre">Bragg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Period</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">etch_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'FETCH'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">etch_shape</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'rectangle'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">N</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">200</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eta_etch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dT</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.bragg.Bragg" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#mxpic.components.primitives.pic.bragg.Bragg_apodized" title="mxpic.components.primitives.pic.bragg.Bragg_apodized"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bragg_apodized</span></code></a></p>
<p>Bragg primitive component.</p>
<p>This component builds the Bragg layout cell.</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>Period</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Period parameter. Default is 0.3.</p></li>
<li><p><strong>w</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 1.1.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>etch_type</strong> (<em>str</em><em>, </em><em>optional</em>) – Value for the etch_type parameter. Default is ‘FETCH’.</p></li>
<li><p><strong>etch_shape</strong> (<em>str</em><em>, </em><em>optional</em>) – Value for the etch_shape parameter. Default is ‘rectangle’.</p></li>
<li><p><strong>N</strong> (<em>int</em><em>, </em><em>optional</em>) – Value for the N parameter. Default is 200.</p></li>
<li><p><strong>eta_etch</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the eta_etch parameter. Default is 0.5.</p></li>
<li><p><strong>dT</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the dT parameter. Default is 0.15.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
docs/build/html/mxpic/components/primitives/pic/couplers.html
Vendored
+183 -3
View File
File diff suppressed because one or more lines are too long
docs/build/html/mxpic/components/primitives/pic/cross.html
Vendored
+34 -1
View File
@@ -303,7 +303,13 @@
<li class="toctree-l1"><a class="reference internal" href="../../gds_devices.html">mxpic.components.gds_devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../pins.html">mxpic.components.pins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../routing.html">mxpic.components.routing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../structures.html">mxpic.components.structures</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../geometry/index.html">Geometry</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/polygons.html">mxpic.components.geometry.polygons</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/rings.html">mxpic.components.geometry.rings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/curves.html">mxpic.components.geometry.curves</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/racetrack.html">mxpic.components.geometry.racetrack</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
@@ -378,6 +384,19 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.cross.Cross">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.cross.</span></span><span class="sig-name descname"><span class="pre">Cross</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">L</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0,</span> <span class="pre">1,</span> <span class="pre">2,</span> <span class="pre">3,</span> <span class="pre">4]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.5,</span> <span class="pre">0.45,</span> <span class="pre">0.6,</span> <span class="pre">0.4,</span> <span class="pre">0.5]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.cross.Cross" 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>Cross primitive component.</p>
<p>This component builds the Cross layout cell.</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>Optional</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>L</strong> (<em>list</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is [0, 1, 2, 3, 4].</p></li>
<li><p><strong>w</strong> (<em>list</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is [0.5, 0.45, 0.6, 0.4, 0.5].</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.cross.Cross.generate_gds">
<span class="sig-name descname"><span class="pre">generate_gds</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">show_pins</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.cross.Cross.generate_gds" title="Link to this definition">#</a></dt>
@@ -397,6 +416,20 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.cross.Cross_Sine">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.cross.</span></span><span class="sig-name descname"><span class="pre">Cross_Sine</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">res</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[1,</span> <span class="pre">1,</span> <span class="pre">1,</span> <span class="pre">1]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.5,</span> <span class="pre">0.45,</span> <span class="pre">0.6,</span> <span class="pre">0.4,</span> <span class="pre">0.5]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_points</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.cross.Cross_Sine" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#mxpic.components.primitives.pic.cross.Cross" title="mxpic.components.primitives.pic.cross.Cross"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cross</span></code></a></p>
<p>Cross Sine primitive component.</p>
<p>This component builds the Cross Sine layout cell.</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>Optional</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>res</strong> (<em>list</em><em>, </em><em>optional</em>) – Value for the res parameter. Default is [1, 1, 1, 1].</p></li>
<li><p><strong>w</strong> (<em>list</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is [0.5, 0.45, 0.6, 0.4, 0.5].</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>n_points</strong> (<em>int</em><em>, </em><em>optional</em>) – Value for the n_points parameter. Default is 4.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
docs/build/html/mxpic/components/primitives/pic/gratings.html
Vendored
+142 -16
View File
File diff suppressed because one or more lines are too long
docs/build/html/mxpic/components/primitives/pic/index.html
Vendored
+7 -1
View File
@@ -303,7 +303,13 @@
<li class="toctree-l1"><a class="reference internal" href="../../gds_devices.html">mxpic.components.gds_devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../pins.html">mxpic.components.pins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../routing.html">mxpic.components.routing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../structures.html">mxpic.components.structures</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../geometry/index.html">Geometry</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/polygons.html">mxpic.components.geometry.polygons</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/rings.html">mxpic.components.geometry.rings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/curves.html">mxpic.components.geometry.curves</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/racetrack.html">mxpic.components.geometry.racetrack</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
docs/build/html/mxpic/components/primitives/pic/mmi.html
Vendored
+51 -1
View File
@@ -303,7 +303,13 @@
<li class="toctree-l1"><a class="reference internal" href="../../gds_devices.html">mxpic.components.gds_devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../pins.html">mxpic.components.pins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../routing.html">mxpic.components.routing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../structures.html">mxpic.components.structures</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../geometry/index.html">Geometry</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/polygons.html">mxpic.components.geometry.polygons</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/rings.html">mxpic.components.geometry.rings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/curves.html">mxpic.components.geometry.curves</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/racetrack.html">mxpic.components.geometry.racetrack</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
@@ -378,6 +384,29 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.mmi.MMI_ML">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.mmi.</span></span><span class="sig-name descname"><span class="pre">MMI_ML</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">L_arm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[10]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_arm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.45,</span> <span class="pre">1.35]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arm_sine_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_mmi</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[10]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_mmi</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[5,</span> <span class="pre">5]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mmi_sine_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">res</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.01</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">N_out</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">N_in</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Dp_out</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Dp_in</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.mmi.MMI_ML" 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>MMI ML primitive component.</p>
<p>This component builds the MMI ML layout cell.</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>Optional</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>L_arm</strong> (<em>list</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is [10].</p></li>
<li><p><strong>w_arm</strong> (<em>list</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is [0.45, 1.35].</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>arm_sine_width</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the arm_sine_width parameter. Default is False.</p></li>
<li><p><strong>L_mmi</strong> (<em>list</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is [10].</p></li>
<li><p><strong>w_mmi</strong> (<em>list</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is [5, 5].</p></li>
<li><p><strong>mmi_sine_width</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the mmi_sine_width parameter. Default is False.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
<li><p><strong>res</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the res parameter. Default is 0.01.</p></li>
<li><p><strong>N_out</strong> (<em>int</em><em>, </em><em>optional</em>) – Count or repetition parameter. Default is 3.</p></li>
<li><p><strong>N_in</strong> (<em>int</em><em>, </em><em>optional</em>) – Count or repetition parameter. Default is 1.</p></li>
<li><p><strong>Dp_out</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Dp_out parameter. Default is 1.5.</p></li>
<li><p><strong>Dp_in</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Dp_in parameter. Default is 1.5.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.mmi.MMI_ML.generate_gds">
<span class="sig-name descname"><span class="pre">generate_gds</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.mmi.MMI_ML.generate_gds" title="Link to this definition">#</a></dt>
@@ -397,6 +426,27 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.mmi.MMI_STD">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.mmi.</span></span><span class="sig-name descname"><span class="pre">MMI_STD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">N_out</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">N_in</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_arm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_wg</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_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_mmi</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_mmi</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Dp_out</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Dp_in</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.mmi.MMI_STD" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#mxpic.components.primitives.pic.mmi.MMI_ML" title="mxpic.components.primitives.pic.mmi.MMI_ML"><code class="xref py py-class docutils literal notranslate"><span class="pre">MMI_ML</span></code></a></p>
<p>MMI STD primitive component.</p>
<p>This component builds the MMI STD layout cell.</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>Optional</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>N_out</strong> (<em>int</em><em>, </em><em>optional</em>) – Count or repetition parameter. Default is 3.</p></li>
<li><p><strong>N_in</strong> (<em>int</em><em>, </em><em>optional</em>) – Count or repetition parameter. Default is 1.</p></li>
<li><p><strong>L_arm</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>w_wg</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>w_port</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 1.2.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>L_mmi</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>w_mmi</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 5.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
<li><p><strong>Dp_out</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Dp_out parameter. Default is 1.5.</p></li>
<li><p><strong>Dp_in</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Dp_in parameter. Default is 1.5.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
docs/build/html/mxpic/components/primitives/pic/racetrack.html
Vendored
+132 -1
View File
File diff suppressed because one or more lines are too long
docs/build/html/mxpic/components/primitives/pic/rings.html
Vendored
+83 -1
View File
File diff suppressed because one or more lines are too long
docs/build/html/mxpic/components/primitives/pic/spiral.html
Vendored
+165 -1
View File
@@ -303,7 +303,13 @@
<li class="toctree-l1"><a class="reference internal" href="../../gds_devices.html">mxpic.components.gds_devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../pins.html">mxpic.components.pins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../routing.html">mxpic.components.routing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../structures.html">mxpic.components.structures</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../geometry/index.html">Geometry</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/polygons.html">mxpic.components.geometry.polygons</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/rings.html">mxpic.components.geometry.rings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/curves.html">mxpic.components.geometry.curves</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/racetrack.html">mxpic.components.geometry.racetrack</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
@@ -378,6 +384,36 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.spiral.spiral">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.spiral.</span></span><span class="sig-name descname"><span class="pre">spiral</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">shape</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'circle'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Dmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50</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">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rmin_euler</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</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_port</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_bend_center</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rmin_bend_center</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cycles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer</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">w_bend_port</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">Ltp_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">res</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rib2strip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port_angle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Euler_bend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.spiral.spiral" 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>spiral primitive component.</p>
<p>This component builds the spiral layout cell.</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><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>shape</strong> (<em>str</em><em>, </em><em>optional</em>) – Value for the shape parameter. Default is ‘circle’.</p></li>
<li><p><strong>Dmin</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Dmin parameter. Default is 50.</p></li>
<li><p><strong>R_bend</strong> (<em>float</em><em>, </em><em>optional</em>) – Radius parameter in microns. Default is 10.</p></li>
<li><p><strong>Rmin_euler</strong> (<em>float</em><em>, </em><em>optional</em>) – Radius parameter in microns. Default is 10.</p></li>
<li><p><strong>Lmin</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 50.</p></li>
<li><p><strong>width</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 2.</p></li>
<li><p><strong>w_port</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>w_bend_center</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 1.</p></li>
<li><p><strong>Rmin_bend_center</strong> (<em>float</em><em>, </em><em>optional</em>) – Radius parameter in microns. Default is 10.</p></li>
<li><p><strong>gap</strong> (<em>float</em><em>, </em><em>optional</em>) – Spacing or gap parameter in microns. Default is 1.</p></li>
<li><p><strong>cycles</strong> (<em>float</em><em>, </em><em>optional</em>) – Count or repetition parameter. Default is 20.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>layer</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is None.</p></li>
<li><p><strong>w_bend_port</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is None.</p></li>
<li><p><strong>Ltp_port</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>res</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the res parameter. Default is 0.5.</p></li>
<li><p><strong>rib2strip</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the rib2strip parameter. Default is True.</p></li>
<li><p><strong>port_angle</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the port_angle parameter. Default is 180.</p></li>
<li><p><strong>Euler_bend</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the Euler_bend parameter. Default is False.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.spiral.spiral.generate_gds">
<span class="sig-name descname"><span class="pre">generate_gds</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">show_pins</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.spiral.spiral.generate_gds" title="Link to this definition">#</a></dt>
@@ -392,6 +428,36 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.spiral.spiral_rectangle">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.spiral.</span></span><span class="sig-name descname"><span class="pre">spiral_rectangle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">Dmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rmax_bend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rmin_bend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wmin_bend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</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_port</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">gap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cycles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer</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">w_bend_port</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">Lport</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ltp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">res</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_xs_transition</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">port_angle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_out_align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lpatch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.spiral.spiral_rectangle" 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>spiral rectangle primitive component.</p>
<p>This component builds the spiral rectangle layout cell.</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><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>Dmin</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Dmin parameter. Default is 50.</p></li>
<li><p><strong>Rmax_bend</strong> (<em>float</em><em>, </em><em>optional</em>) – Radius parameter in microns. Default is 10.</p></li>
<li><p><strong>Rmin_bend</strong> (<em>float</em><em>, </em><em>optional</em>) – Radius parameter in microns. Default is 10.</p></li>
<li><p><strong>wmin_bend</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the wmin_bend parameter. Default is 10.</p></li>
<li><p><strong>Lmin</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 50.</p></li>
<li><p><strong>width</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 2.</p></li>
<li><p><strong>w_port</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is None.</p></li>
<li><p><strong>gap</strong> (<em>float</em><em>, </em><em>optional</em>) – Spacing or gap parameter in microns. Default is 1.</p></li>
<li><p><strong>cycles</strong> (<em>float</em><em>, </em><em>optional</em>) – Count or repetition parameter. Default is 20.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>layer</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is None.</p></li>
<li><p><strong>w_bend_port</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is None.</p></li>
<li><p><strong>Lport</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>Ltp</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>res</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the res parameter. Default is 0.5.</p></li>
<li><p><strong>cell_xs_transition</strong> (<em>Any</em><em>, </em><em>optional</em>) – Cell or component dependency used by this device. Default is None.</p></li>
<li><p><strong>port_angle</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the port_angle parameter. Default is 180.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
<li><p><strong>in_out_align</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the in_out_align parameter. Default is True.</p></li>
<li><p><strong>Lpatch</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 0.05.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.spiral.spiral_rectangle.generate_gds">
<span class="sig-name descname"><span class="pre">generate_gds</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">show_pins</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.spiral.spiral_rectangle.generate_gds" title="Link to this definition">#</a></dt>
@@ -406,6 +472,31 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.spiral.Spiral_Rect_STD">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.spiral.</span></span><span class="sig-name descname"><span class="pre">Spiral_Rect_STD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">Dmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50</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">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</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_port</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">gap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cycles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer</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">Lport</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_out_align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">res</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_xs_transition</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">port_angle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.spiral.Spiral_Rect_STD" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#mxpic.components.primitives.pic.spiral.spiral_rectangle" title="mxpic.components.primitives.pic.spiral.spiral_rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">spiral_rectangle</span></code></a></p>
<p>Spiral Rect STD primitive component.</p>
<p>This component builds the Spiral Rect STD layout cell.</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><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>Dmin</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Dmin parameter. Default is 50.</p></li>
<li><p><strong>R_bend</strong> (<em>float</em><em>, </em><em>optional</em>) – Radius parameter in microns. Default is 10.</p></li>
<li><p><strong>Lmin</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 50.</p></li>
<li><p><strong>width</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 2.</p></li>
<li><p><strong>w_port</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>gap</strong> (<em>float</em><em>, </em><em>optional</em>) – Spacing or gap parameter in microns. Default is 1.</p></li>
<li><p><strong>cycles</strong> (<em>float</em><em>, </em><em>optional</em>) – Count or repetition parameter. Default is 20.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>layer</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is None.</p></li>
<li><p><strong>Lport</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>in_out_align</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the in_out_align parameter. Default is True.</p></li>
<li><p><strong>res</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the res parameter. Default is 0.5.</p></li>
<li><p><strong>cell_xs_transition</strong> (<em>Any</em><em>, </em><em>optional</em>) – Cell or component dependency used by this device. Default is None.</p></li>
<li><p><strong>port_angle</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the port_angle parameter. Default is 180.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
@@ -415,6 +506,32 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.spiral.spiral_circle">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.spiral.</span></span><span class="sig-name descname"><span class="pre">spiral_circle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">Dmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</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_port</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_bend_center</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cycles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer</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">Lport</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">res</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rib2strip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port_angle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Euler_Sbend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_condition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">R_ratio_mamnual</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.spiral.spiral_circle" 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>spiral circle primitive component.</p>
<p>This component builds the spiral circle layout cell.</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><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>Dmin</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Dmin parameter. Default is 50.</p></li>
<li><p><strong>width</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 2.</p></li>
<li><p><strong>w_port</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>w_bend_center</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 1.</p></li>
<li><p><strong>gap</strong> (<em>float</em><em>, </em><em>optional</em>) – Spacing or gap parameter in microns. Default is 1.</p></li>
<li><p><strong>cycles</strong> (<em>float</em><em>, </em><em>optional</em>) – Count or repetition parameter. Default is 20.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>layer</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is None.</p></li>
<li><p><strong>Lport</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>res</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the res parameter. Default is 0.5.</p></li>
<li><p><strong>rib2strip</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the rib2strip parameter. Default is True.</p></li>
<li><p><strong>port_angle</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the port_angle parameter. Default is 180.</p></li>
<li><p><strong>Euler_Sbend</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the Euler_Sbend parameter. Default is False.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
<li><p><strong>strict_condition</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the strict_condition parameter. Default is False.</p></li>
<li><p><strong>R_ratio_mamnual</strong> (<em>Any</em><em>, </em><em>optional</em>) – Radius parameter in microns. Default is None.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.spiral.spiral_circle.cell">
<span class="sig-name descname"><span class="pre">cell</span></span><a class="headerlink" href="#mxpic.components.primitives.pic.spiral.spiral_circle.cell" title="Link to this definition">#</a></dt>
@@ -440,6 +557,30 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.spiral.Spiral_Cicle_MM">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.spiral.</span></span><span class="sig-name descname"><span class="pre">Spiral_Cicle_MM</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">Dmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</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_port</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_bend_center</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cycles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer</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">Lport</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">res</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rib2strip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port_angle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_condition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.spiral.Spiral_Cicle_MM" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#mxpic.components.primitives.pic.spiral.spiral_circle" title="mxpic.components.primitives.pic.spiral.spiral_circle"><code class="xref py py-class docutils literal notranslate"><span class="pre">spiral_circle</span></code></a></p>
<p>Spiral Cicle MM primitive component.</p>
<p>This component builds the Spiral Cicle MM layout cell.</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><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>Dmin</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Dmin parameter. Default is 50.</p></li>
<li><p><strong>width</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 2.</p></li>
<li><p><strong>w_port</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>w_bend_center</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 1.</p></li>
<li><p><strong>gap</strong> (<em>float</em><em>, </em><em>optional</em>) – Spacing or gap parameter in microns. Default is 1.</p></li>
<li><p><strong>cycles</strong> (<em>float</em><em>, </em><em>optional</em>) – Count or repetition parameter. Default is 20.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>layer</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is None.</p></li>
<li><p><strong>Lport</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>res</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the res parameter. Default is 0.5.</p></li>
<li><p><strong>rib2strip</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the rib2strip parameter. Default is True.</p></li>
<li><p><strong>port_angle</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the port_angle parameter. Default is 180.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
<li><p><strong>strict_condition</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the strict_condition parameter. Default is False.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
@@ -449,6 +590,29 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.spiral.Spiral_Cicle_STD">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.spiral.</span></span><span class="sig-name descname"><span class="pre">Spiral_Cicle_STD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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">Dmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</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_port</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">gap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cycles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer</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">Lport</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">res</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rib2strip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port_angle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharp_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_condition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.spiral.Spiral_Cicle_STD" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#mxpic.components.primitives.pic.spiral.spiral_circle" title="mxpic.components.primitives.pic.spiral.spiral_circle"><code class="xref py py-class docutils literal notranslate"><span class="pre">spiral_circle</span></code></a></p>
<p>Spiral Cicle STD primitive component.</p>
<p>This component builds the Spiral Cicle STD layout cell.</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><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is None.</p></li>
<li><p><strong>Dmin</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the Dmin parameter. Default is 50.</p></li>
<li><p><strong>width</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 2.</p></li>
<li><p><strong>w_port</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>gap</strong> (<em>float</em><em>, </em><em>optional</em>) – Spacing or gap parameter in microns. Default is 1.</p></li>
<li><p><strong>cycles</strong> (<em>float</em><em>, </em><em>optional</em>) – Count or repetition parameter. Default is 20.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>layer</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is None.</p></li>
<li><p><strong>Lport</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>res</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the res parameter. Default is 0.5.</p></li>
<li><p><strong>rib2strip</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the rib2strip parameter. Default is True.</p></li>
<li><p><strong>port_angle</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the port_angle parameter. Default is 180.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
<li><p><strong>sharp_patch</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to add geometry patches for sharp corners or cladding continuity. Default is True.</p></li>
<li><p><strong>strict_condition</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the strict_condition parameter. Default is False.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
docs/build/html/mxpic/components/primitives/pic/taper.html
Vendored
+58 -2
View File
@@ -303,7 +303,13 @@
<li class="toctree-l1"><a class="reference internal" href="../../gds_devices.html">mxpic.components.gds_devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../pins.html">mxpic.components.pins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../routing.html">mxpic.components.routing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../structures.html">mxpic.components.structures</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../geometry/index.html">Geometry</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/polygons.html">mxpic.components.geometry.polygons</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/rings.html">mxpic.components.geometry.rings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/curves.html">mxpic.components.geometry.curves</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../geometry/racetrack.html">mxpic.components.geometry.racetrack</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
@@ -378,6 +384,25 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.taper.transition">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.taper.</span></span><span class="sig-name descname"><span class="pre">transition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">layer_FETCH</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'STRIP_TRE'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer_METCH</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'RIB_TRE'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_rib</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dw_tolerance</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_grow_rib</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_grow_strip</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">Ltp1</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ltp2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ltrans</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_port</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">show_pins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.taper.transition" 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>transition primitive component.</p>
<p>This component builds the transition layout cell.</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>layer_FETCH</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘STRIP_TRE’.</p></li>
<li><p><strong>layer_METCH</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘RIB_TRE’.</p></li>
<li><p><strong>w_rib</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 1.1.</p></li>
<li><p><strong>dw_tolerance</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the dw_tolerance parameter. Default is 0.2.</p></li>
<li><p><strong>w_grow_rib</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 2.</p></li>
<li><p><strong>w_grow_strip</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 2.</p></li>
<li><p><strong>Ltp1</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 15.</p></li>
<li><p><strong>Ltp2</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>Ltrans</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 5.</p></li>
<li><p><strong>L_port</strong> (<em>int</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 2.</p></li>
<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to draw pin markers in the generated layout. Default is False.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
@@ -387,6 +412,20 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.taper.taper_xs2xs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.taper.</span></span><span class="sig-name descname"><span class="pre">taper_xs2xs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xs_1</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'rib'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs_2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strip'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_taper</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_1</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_2</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">L_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.taper.taper_xs2xs" 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>taper xs2xs primitive component.</p>
<p>This component builds the taper xs2xs layout cell.</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>xs_1</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘rib’.</p></li>
<li><p><strong>xs_2</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘strip’.</p></li>
<li><p><strong>L_taper</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 10.</p></li>
<li><p><strong>w_1</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>w_2</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
<li><p><strong>L_port</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
@@ -396,7 +435,24 @@
<dt class="sig sig-object py" id="mxpic.components.primitives.pic.taper.PSR">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.pic.taper.</span></span><span class="sig-name descname"><span class="pre">PSR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'PSR_unit'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'rib'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">layer_u</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">layer_d</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">w</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.45,</span> <span class="pre">0.45,</span> <span class="pre">0.55,</span> <span class="pre">1.2,</span> <span class="pre">1.2]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lt_rib</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[10,</span> <span class="pre">30,</span> <span class="pre">30,</span> <span class="pre">10]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ws</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.45,</span> <span class="pre">2,</span> <span class="pre">1.2]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lt_slab</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[40,</span> <span class="pre">40]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'sine'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">res</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.01</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.pic.taper.PSR" 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>Polarization Splitter &amp; rotator</p>
<p>Polarization Splitter &amp; rotator.</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><em>, </em><em>optional</em>) – Unique identifier for the device cell. Default is ‘PSR_unit’.</p></li>
<li><p><strong>xs</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is ‘rib’.</p></li>
<li><p><strong>layer_u</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is None.</p></li>
<li><p><strong>layer_d</strong> (<em>str</em><em>, </em><em>optional</em>) – Layer or cross-section name used by the device. Default is None.</p></li>
<li><p><strong>w</strong> (<em>list</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is [0.45, 0.45, 0.55, 1.2, 1.2].</p></li>
<li><p><strong>Lt_rib</strong> (<em>list</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is [10, 30, 30, 10].</p></li>
<li><p><strong>ws</strong> (<em>list</em><em>, </em><em>optional</em>) – Value for the ws parameter. Default is [0.45, 2, 1.2].</p></li>
<li><p><strong>Lt_slab</strong> (<em>list</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is [40, 40].</p></li>
<li><p><strong>shape</strong> (<em>str</em><em>, </em><em>optional</em>) – Value for the shape parameter. Default is ‘sine’.</p></li>
<li><p><strong>L_port</strong> (<em>float</em><em>, </em><em>optional</em>) – Length parameter in microns. Default is 5.</p></li>
<li><p><strong>res</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the res parameter. Default is 0.01.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>