Folder structure simplfied

2026-06-06 16:43:26 +08:00
parent 8da92ced57
commit 8a17f1dde0
138 changed files with 10429 additions and 1432 deletions
@@ -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>
@@ -388,6 +394,18 @@
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.active.dev_ps.</span></span><span class="sig-name descname"><span class="pre">Heater_NDoped</span></span><span class="sig-paren">(</span><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">slab_width</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">heater_length</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">heater_width</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">if_open</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><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.active.dev_ps.Heater_NDoped" 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>This is the class for N-doped heater as a phase shifter.</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>w_wg</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.45.</p></li>
+<li><p><strong>slab_width</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the slab_width parameter. Default is 1.1.</p></li>
+<li><p><strong>heater_length</strong> (<em>int</em><em>, </em><em>optional</em>) – Value for the heater_length parameter. Default is 100.</p></li>
+<li><p><strong>heater_width</strong> (<em>int</em><em>, </em><em>optional</em>) – Value for the heater_width parameter. Default is 1.</p></li>
+<li><p><strong>if_open</strong> (<em>bool</em><em>, </em><em>optional</em>) – Value for the if_open parameter. 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>
+</ul>
+</dd>
+</dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="mxpic.components.primitives.active.dev_ps.Heater_NDoped.generate_gds">
 <span class="sig-name descname"><span class="pre">generate_gds</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mxpic.components.primitives.active.dev_ps.Heater_NDoped.generate_gds" title="Link to this definition">#</a></dt>
@@ -408,6 +426,21 @@
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.primitives.active.dev_ps.</span></span><span class="sig-name descname"><span class="pre">PS_PIN</span></span><span class="sig-paren">(</span><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_wg_slab</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">w_slab</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_wg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">800</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">d2wg_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.2,</span> <span class="pre">1]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p_layer_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['PW',</span> <span class="pre">'PP']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_layer_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['NW',</span> <span class="pre">'NP']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w_plus_max</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5.1</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.active.dev_ps.PS_PIN" 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>PIN junction for a high-speed phase shift.</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>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_wg_slab</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 0.5.</p></li>
+<li><p><strong>w_slab</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 1.</p></li>
+<li><p><strong>l_wg</strong> (<em>float</em><em>, </em><em>optional</em>) – Value for the l_wg parameter. Default is 800.</p></li>
+<li><p><strong>d2wg_list</strong> (<em>list</em><em>, </em><em>optional</em>) – Value for the d2wg_list parameter. Default is [0.2, 1].</p></li>
+<li><p><strong>p_layer_list</strong> (<em>list</em><em>, </em><em>optional</em>) – Value for the p_layer_list parameter. Default is [‘PW’, ‘PP’].</p></li>
+<li><p><strong>n_layer_list</strong> (<em>list</em><em>, </em><em>optional</em>) – Value for the n_layer_list parameter. Default is [‘NW’, ‘NP’].</p></li>
+<li><p><strong>w_plus_max</strong> (<em>float</em><em>, </em><em>optional</em>) – Width parameter in microns. Default is 5.1.</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 attribute">
 <dt class="sig sig-object py" id="mxpic.components.primitives.active.dev_ps.PS_PIN.cell">
 <span class="sig-name descname"><span class="pre">cell</span></span><a class="headerlink" href="#mxpic.components.primitives.active.dev_ps.PS_PIN.cell" title="Link to this definition">#</a></dt>
@@ -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>