Deploy preview for PR 939 🛫

pr-preview/pr-939/javascripts/mathjax.js

@@ -1,4 +1,4 @@
-document$.subscribe(({ body }) => { 
+document$.subscribe(({ body }) => {
     renderMathInElement(body, {
       delimiters: [
         { left: "$$",  right: "$$",  display: true },
@@ -7,4 +7,4 @@ document$.subscribe(({ body }) => {
         { left: "\\[", right: "\\]", display: true }
       ],
     })
-  })
+  })

pr-preview/pr-939/reference/bloqade/atom_arrangement/index.html

@@ -493,7 +493,7 @@
 <span class=normal><a href=#__codelineno-0-134>134</a></span>
 <span class=normal><a href=#__codelineno-0-135>135</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-0-133><a id=__codelineno-0-133 name=__codelineno-0-133></a><span class=k>def</span> <span class=nf>figure</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>fig_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>):</span>
 </span><span id=__span-0-134><a id=__codelineno-0-134 name=__codelineno-0-134></a><span class=w>    </span><span class=sd>&quot;&quot;&quot;obtain a figure object from the atom arrangement.&quot;&quot;&quot;</span>
-</span><span id=__span-0-135><a id=__codelineno-0-135 name=__codelineno-0-135></a>    <span class=k>return</span> <span class=n>get_atom_arrangement_figure</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>fig_kwargs</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
+</span><span id=__span-0-135><a id=__codelineno-0-135 name=__codelineno-0-135></a>    <span class=k>return</span> <span class=n>get_atom_arrangement_figure</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>fig_kwargs</span><span class=o>=</span><span class=n>fig_kwargs</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
 </span></code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=bloqade.atom_arrangement.AtomArrangement.rydberg_interaction class="doc doc-heading"> <span class="doc doc-object-name doc-function-name">rydberg_interaction</span> <a href=#bloqade.atom_arrangement.AtomArrangement.rydberg_interaction class=headerlink title="Permanent link">&para;</a></h3> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>rydberg_interaction</span><span class=p>(</span><span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
 </span></code></pre></div> <div class="doc doc-contents "> <p>calculate the Rydberg interaction matrix.</p> <p><strong>Parameters:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>**assignments</code></td> <td> </td> <td> <div class=doc-md-description> <p>the values to assign to the variables in the register.</p> </div> </td> <td> <code>{}</code> </td> </tr> </tbody> </table> <p><strong>Returns:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>NDArray</code></td> <td> <code><span title="numpy.typing.NDArray">NDArray</span></code> </td> <td> <div class=doc-md-description> <p>the Rydberg interaction matrix in the lower triangular form.</p> </div> </td> </tr> </tbody> </table> <details class=quote> <summary>Source code in <code>src/bloqade/ir/location/location.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-140>140</a></span>
 <span class=normal><a href=#__codelineno-0-141>141</a></span>

pr-preview/pr-939/reference/bloqade/ir/index.html

@@ -5,23 +5,23 @@
 </span><span id=__span-0-4><a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a><span class=p>&lt;</span><span class=nc>value</span><span class=p>&gt;</span> <span class=o>::=</span> &#39;left value&#39; | &#39;right value&#39; | <span class=p>&lt;</span><span class=nc>scalar expr</span><span class=p>&gt;</span>
 </span></code></pre></div> <div class="doc doc-children"> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=bloqade.ir.AnalogCircuit class="doc doc-heading"> <span class="doc doc-object-name doc-class-name">AnalogCircuit</span> <a href=#bloqade.ir.AnalogCircuit class=headerlink title="Permanent link">&para;</a></h2> <div class="doc doc-contents "> <p>AnalogCircuit is a dummy type that bundle register and sequence together.</p> <div class="doc doc-children"> <div class="doc doc-object doc-attribute"> <h3 id=bloqade.ir.AnalogCircuit.register class="doc doc-heading"> <span class="doc doc-object-name doc-attribute-name">register</span> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#bloqade.ir.AnalogCircuit.register class=headerlink title="Permanent link">&para;</a></h3> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>register</span>
 </span></code></pre></div> <div class="doc doc-contents "> <p>Get the register of the program.</p> <p><strong>Returns:</strong></p> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td> </td> <td> <div class=doc-md-description> <p>register (Union["AtomArrangement", "ParallelRegister"])</p> </div> </td> </tr> </tbody> </table> <details class=note open> <summary>Note</summary> <p>If the program is built with [<code>parallelize()</code>][bloqade.builder.emit.Emit.parallelize], The the register will be a [<code>ParallelRegister</code>][bloqade.ir.location.base.ParallelRegister]. Otherwise it will be a [<code>AtomArrangement</code>][bloqade.ir.location.base.AtomArrangement].</p> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=bloqade.ir.AnalogCircuit.show class="doc doc-heading"> <span class="doc doc-object-name doc-function-name">show</span> <a href=#bloqade.ir.AnalogCircuit.show class=headerlink title="Permanent link">&para;</a></h3> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>show</span><span class=p>(</span><span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
-</span></code></pre></div> <div class="doc doc-contents "> <p>Interactive visualization of the program</p> <p><strong>Parameters:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>**assignments</code></td> <td> </td> <td> <div class=doc-md-description> <p>assigning the instance value (literal) to the existing variables in the program</p> </div> </td> <td> <code>{}</code> </td> </tr> </tbody> </table> <details class=quote> <summary>Source code in <code>src/bloqade/ir/analog_circuit.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-70>70</a></span>
-<span class=normal><a href=#__codelineno-0-71>71</a></span>
-<span class=normal><a href=#__codelineno-0-72>72</a></span>
-<span class=normal><a href=#__codelineno-0-73>73</a></span>
-<span class=normal><a href=#__codelineno-0-74>74</a></span>
-<span class=normal><a href=#__codelineno-0-75>75</a></span>
-<span class=normal><a href=#__codelineno-0-76>76</a></span>
-<span class=normal><a href=#__codelineno-0-77>77</a></span>
-<span class=normal><a href=#__codelineno-0-78>78</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-0-70><a id=__codelineno-0-70 name=__codelineno-0-70></a><span class=k>def</span> <span class=nf>show</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>):</span>
-</span><span id=__span-0-71><a id=__codelineno-0-71 name=__codelineno-0-71></a><span class=w>    </span><span class=sd>&quot;&quot;&quot;Interactive visualization of the program</span>
-</span><span id=__span-0-72><a id=__codelineno-0-72 name=__codelineno-0-72></a>
-</span><span id=__span-0-73><a id=__codelineno-0-73 name=__codelineno-0-73></a><span class=sd>    Args:</span>
-</span><span id=__span-0-74><a id=__codelineno-0-74 name=__codelineno-0-74></a><span class=sd>        **assignments: assigning the instance value (literal) to the</span>
-</span><span id=__span-0-75><a id=__codelineno-0-75 name=__codelineno-0-75></a><span class=sd>            existing variables in the program</span>
-</span><span id=__span-0-76><a id=__codelineno-0-76 name=__codelineno-0-76></a>
-</span><span id=__span-0-77><a id=__codelineno-0-77 name=__codelineno-0-77></a><span class=sd>    &quot;&quot;&quot;</span>
-</span><span id=__span-0-78><a id=__codelineno-0-78 name=__codelineno-0-78></a>    <span class=n>display_ir</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>assignments</span><span class=p>)</span>
+</span></code></pre></div> <div class="doc doc-contents "> <p>Interactive visualization of the program</p> <p><strong>Parameters:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>**assignments</code></td> <td> </td> <td> <div class=doc-md-description> <p>assigning the instance value (literal) to the existing variables in the program</p> </div> </td> <td> <code>{}</code> </td> </tr> </tbody> </table> <details class=quote> <summary>Source code in <code>src/bloqade/ir/analog_circuit.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-120>120</a></span>
+<span class=normal><a href=#__codelineno-0-121>121</a></span>
+<span class=normal><a href=#__codelineno-0-122>122</a></span>
+<span class=normal><a href=#__codelineno-0-123>123</a></span>
+<span class=normal><a href=#__codelineno-0-124>124</a></span>
+<span class=normal><a href=#__codelineno-0-125>125</a></span>
+<span class=normal><a href=#__codelineno-0-126>126</a></span>
+<span class=normal><a href=#__codelineno-0-127>127</a></span>
+<span class=normal><a href=#__codelineno-0-128>128</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-0-120><a id=__codelineno-0-120 name=__codelineno-0-120></a><span class=k>def</span> <span class=nf>show</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>):</span>
+</span><span id=__span-0-121><a id=__codelineno-0-121 name=__codelineno-0-121></a><span class=w>    </span><span class=sd>&quot;&quot;&quot;Interactive visualization of the program</span>
+</span><span id=__span-0-122><a id=__codelineno-0-122 name=__codelineno-0-122></a>
+</span><span id=__span-0-123><a id=__codelineno-0-123 name=__codelineno-0-123></a><span class=sd>    Args:</span>
+</span><span id=__span-0-124><a id=__codelineno-0-124 name=__codelineno-0-124></a><span class=sd>        **assignments: assigning the instance value (literal) to the</span>
+</span><span id=__span-0-125><a id=__codelineno-0-125 name=__codelineno-0-125></a><span class=sd>            existing variables in the program</span>
+</span><span id=__span-0-126><a id=__codelineno-0-126 name=__codelineno-0-126></a>
+</span><span id=__span-0-127><a id=__codelineno-0-127 name=__codelineno-0-127></a><span class=sd>    &quot;&quot;&quot;</span>
+</span><span id=__span-0-128><a id=__codelineno-0-128 name=__codelineno-0-128></a>    <span class=n>display_ir</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>assignments</span><span class=p>)</span>
 </span></code></pre></div></td></tr></table></div> </details> </div> </div> </div> </div> </div> <div class="doc doc-object doc-class"> <h2 id=bloqade.ir.AtomArrangement class="doc doc-heading"> <span class="doc doc-object-name doc-class-name">AtomArrangement</span> <a href=#bloqade.ir.AtomArrangement class=headerlink title="Permanent link">&para;</a></h2> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>AtomArrangement</span><span class=p>(</span><span class=n>parent</span><span class=o>=</span><span class=kc>None</span><span class=p>)</span>
 </span></code></pre></div> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-internal" title="bloqade.builder.start.ProgramStart" href="../builder/start/#bloqade.builder.start.ProgramStart">ProgramStart</a></code></p> <details class=quote> <summary>Source code in <code>src/bloqade/builder/base.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-10>10</a></span>
 <span class=normal><a href=#__codelineno-0-11>11</a></span>
@@ -517,7 +517,7 @@
 <span class=normal><a href=#__codelineno-0-134>134</a></span>
 <span class=normal><a href=#__codelineno-0-135>135</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-0-133><a id=__codelineno-0-133 name=__codelineno-0-133></a><span class=k>def</span> <span class=nf>figure</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>fig_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>):</span>
 </span><span id=__span-0-134><a id=__codelineno-0-134 name=__codelineno-0-134></a><span class=w>    </span><span class=sd>&quot;&quot;&quot;obtain a figure object from the atom arrangement.&quot;&quot;&quot;</span>
-</span><span id=__span-0-135><a id=__codelineno-0-135 name=__codelineno-0-135></a>    <span class=k>return</span> <span class=n>get_atom_arrangement_figure</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>fig_kwargs</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
+</span><span id=__span-0-135><a id=__codelineno-0-135 name=__codelineno-0-135></a>    <span class=k>return</span> <span class=n>get_atom_arrangement_figure</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>fig_kwargs</span><span class=o>=</span><span class=n>fig_kwargs</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
 </span></code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=bloqade.ir.AtomArrangement.rydberg_interaction class="doc doc-heading"> <span class="doc doc-object-name doc-function-name">rydberg_interaction</span> <a href=#bloqade.ir.AtomArrangement.rydberg_interaction class=headerlink title="Permanent link">&para;</a></h3> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>rydberg_interaction</span><span class=p>(</span><span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
 </span></code></pre></div> <div class="doc doc-contents "> <p>calculate the Rydberg interaction matrix.</p> <p><strong>Parameters:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>**assignments</code></td> <td> </td> <td> <div class=doc-md-description> <p>the values to assign to the variables in the register.</p> </div> </td> <td> <code>{}</code> </td> </tr> </tbody> </table> <p><strong>Returns:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>NDArray</code></td> <td> <code><span title="numpy.typing.NDArray">NDArray</span></code> </td> <td> <div class=doc-md-description> <p>the Rydberg interaction matrix in the lower triangular form.</p> </div> </td> </tr> </tbody> </table> <details class=quote> <summary>Source code in <code>src/bloqade/ir/location/location.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-140>140</a></span>
 <span class=normal><a href=#__codelineno-0-141>141</a></span>

pr-preview/pr-939/reference/bloqade/ir/location/index.html

@@ -494,7 +494,7 @@
 <span class=normal><a href=#__codelineno-0-134>134</a></span>
 <span class=normal><a href=#__codelineno-0-135>135</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-0-133><a id=__codelineno-0-133 name=__codelineno-0-133></a><span class=k>def</span> <span class=nf>figure</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>fig_kwargs</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>):</span>
 </span><span id=__span-0-134><a id=__codelineno-0-134 name=__codelineno-0-134></a><span class=w>    </span><span class=sd>&quot;&quot;&quot;obtain a figure object from the atom arrangement.&quot;&quot;&quot;</span>
-</span><span id=__span-0-135><a id=__codelineno-0-135 name=__codelineno-0-135></a>    <span class=k>return</span> <span class=n>get_atom_arrangement_figure</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>fig_kwargs</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
+</span><span id=__span-0-135><a id=__codelineno-0-135 name=__codelineno-0-135></a>    <span class=k>return</span> <span class=n>get_atom_arrangement_figure</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>fig_kwargs</span><span class=o>=</span><span class=n>fig_kwargs</span><span class=p>,</span> <span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
 </span></code></pre></div></td></tr></table></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=bloqade.ir.location.AtomArrangement.rydberg_interaction class="doc doc-heading"> <span class="doc doc-object-name doc-function-name">rydberg_interaction</span> <a href=#bloqade.ir.location.AtomArrangement.rydberg_interaction class=headerlink title="Permanent link">&para;</a></h3> <div class="language-python doc-signature highlight"><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=n>rydberg_interaction</span><span class=p>(</span><span class=o>**</span><span class=n>assignments</span><span class=p>)</span>
 </span></code></pre></div> <div class="doc doc-contents "> <p>calculate the Rydberg interaction matrix.</p> <p><strong>Parameters:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>**assignments</code></td> <td> </td> <td> <div class=doc-md-description> <p>the values to assign to the variables in the register.</p> </div> </td> <td> <code>{}</code> </td> </tr> </tbody> </table> <p><strong>Returns:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>NDArray</code></td> <td> <code><span title="numpy.typing.NDArray">NDArray</span></code> </td> <td> <div class=doc-md-description> <p>the Rydberg interaction matrix in the lower triangular form.</p> </div> </td> </tr> </tbody> </table> <details class=quote> <summary>Source code in <code>src/bloqade/ir/location/location.py</code></summary> <div class="language-python highlight"><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-140>140</a></span>
 <span class=normal><a href=#__codelineno-0-141>141</a></span>