Technolgy file archetecture revised with dictionary input method

docs/build/html/mxpic/components/composites/SptTree.html

@@ -375,51 +375,39 @@
                   
   <section id="module-mxpic.components.composites.SptTree">
 <span id="mxpic-components-composites-spttree"></span><h1>mxpic.components.composites.SptTree<a class="headerlink" href="#module-mxpic.components.composites.SptTree" title="Link to this heading">#</a></h1>
+<p>Optical splitting tree composite layouts.</p>
 <section id="splittingtree">
 <h2>SplittingTree<a class="headerlink" href="#splittingtree" title="Link to this heading">#</a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="mxpic.components.composites.SptTree.SplittingTree">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mxpic.components.composites.SptTree.</span></span><span class="sig-name descname"><span class="pre">SplittingTree</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ybranch</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">output_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">16</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bend_radius</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">output_pitch</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">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.composites.SptTree.SplittingTree" 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>Class for generating splitting tree.</p>
-<dl class="simple">
-<dt>Paras:</dt><dd><ol class="arabic simple">
-<li><dl class="simple">
-<dt>ybranch          [class] (Default None)</dt><dd><ul class="simple">
-<li><p>length    (Default: 28)   Length of the ybranch</p></li>
-<li><p>width     (Default: 2)    Pitch between two output waveguides</p></li>
-<li><p>w_wg      (Default: 0.45) Width of output waveguide</p></li>
-<li><dl class="simple">
-<dt>cell      (Default: box)</dt><dd><ul>
-<li><p>a1    [Pin] Input waveguide</p></li>
-<li><p>b1    [Pin] Output waveguide1</p></li>
-<li><p>b2    [Pin] Output waveguide2</p></li>
+<p>Binary splitter tree built from repeated Y-branch cells.</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>ybranch</strong> (<em>Any</em><em>, </em><em>optional</em>) – Y-branch object with a <code class="docutils literal notranslate"><span class="pre">cell</span></code> attribute and <code class="docutils literal notranslate"><span class="pre">a1</span></code>, <code class="docutils literal notranslate"><span class="pre">b1</span></code>, and
+<code class="docutils literal notranslate"><span class="pre">b2</span></code> pins. If omitted, a simple box-based Y-branch is generated.</p></li>
+<li><p><strong>output_number</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of output channels. Values are coerced to the nearest lower
+power of two when needed.</p></li>
+<li><p><strong>bend_radius</strong> (<em>int</em><em>, </em><em>optional</em>) – Bend radius used to route between splitter levels.</p></li>
+<li><p><strong>output_pitch</strong> (<em>Any</em><em>, </em><em>optional</em>) – Output channel pitch in microns. If omitted, the Y-branch output
+pitch is used.</p></li>
+<li><p><strong>show_pins</strong> (<em>bool</em><em>, </em><em>optional</em>) – Show Nazca pin stubs in the generated layout.</p></li>
 </ul>
 </dd>
 </dl>
-</li>
-</ul>
-</dd>
-</dl>
-</li>
-<li><dl class="simple">
-<dt>output_number    [-]     (Default: 16)</dt><dd><p>Number of output channels(Need to be 2^N)</p>
-</dd>
-</dl>
-</li>
-<li><dl class="simple">
-<dt>bend_radius      [um]    (Default: 10)</dt><dd><p>Bend radius used to connect the different layer of Y branch</p>
-</dd>
-</dl>
-</li>
-<li><dl class="simple">
-<dt>output_pitch     [um]    (Default: None)</dt><dd><p>Can define the pitch of output channel(If ==None, then pitch=self.width, which is the minimum pitch)</p>
-</dd>
-</dl>
-</li>
-</ol>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="mxpic.components.composites.SptTree.SplittingTree.cell">
+<span class="sig-name descname"><span class="pre">cell</span></span><a class="headerlink" href="#mxpic.components.composites.SptTree.SplittingTree.cell" title="Link to this definition">#</a></dt>
+<dd><p>Generated splitting tree layout cell.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>nazca.Cell</p>
 </dd>
 </dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="mxpic.components.composites.SptTree.SplittingTree.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.composites.SptTree.SplittingTree.generate_gds" title="Link to this definition">#</a></dt>
@@ -480,6 +468,7 @@
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#splittingtree">SplittingTree</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#mxpic.components.composites.SptTree.SplittingTree"><code class="docutils literal notranslate"><span class="pre">SplittingTree</span></code></a><ul class="nav section-nav flex-column">
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#mxpic.components.composites.SptTree.SplittingTree.cell"><code class="docutils literal notranslate"><span class="pre">SplittingTree.cell</span></code></a></li>
 <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#mxpic.components.composites.SptTree.SplittingTree.generate_gds"><code class="docutils literal notranslate"><span class="pre">SplittingTree.generate_gds()</span></code></a></li>
 </ul>
 </li>