Deploying to gh-pages from @ 34403b4 🚀

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 7fab52f36b3e35b36f41f6677f842354
+config: 218bea1aedf0f8bb789acdd8ed586aec
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_modules/index.html

@@ -385,7 +385,7 @@ <h1>All modules for which code is available</h1>
 
             <a href="https://github.com/pradyunsg/furo">Furo</a>
             <div class="last-updated">
-              Last updated on 2024/03/04</div>
+              Last updated on 2024/03/07</div>
           </div>
           <div class="right-details">
 

_modules/qiskit_qec/circuits/code_circuit.html

@@ -388,15 +388,15 @@ <h1>Source code for qiskit_qec.circuits.code_circuit</h1><div class="highlight">
 <div class="viewcode-block" id="CodeCircuit.check_nodes">
 <a class="viewcode-back" href="../../../stubs/qiskit_qec.circuits.CodeCircuit.html#qiskit_qec.circuits.CodeCircuit.check_nodes">[docs]</a>
     <span class="nd">@abstractmethod</span>
-    <span class="k">def</span> <span class="nf">check_nodes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodes</span><span class="p">,</span> <span class="n">ignore_extra_logical</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">minimal</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">check_nodes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodes</span><span class="p">,</span> <span class="n">ignore_extras</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">minimal</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Determines whether a given set of nodes are neutral. If so, also</span>
 <span class="sd">        determines any additional logical readout qubits that would be</span>
 <span class="sd">        flipped by the errors creating such a cluster and how many errors</span>
 <span class="sd">        would be required to make the cluster.</span>
 <span class="sd">        Args:</span>
 <span class="sd">            nodes (list): List of nodes, of the type produced by `string2nodes`.</span>
-<span class="sd">            ignore_extra_logical (bool): If `True`, undeeded logical nodes are</span>
+<span class="sd">            ignore_extras (bool): If `True`, undeeded logical and boundary nodes are</span>
 <span class="sd">            ignored.</span>
 <span class="sd">            minimal (bool): Whether output should only reflect the minimal error</span>
 <span class="sd">            case.</span>
@@ -414,20 +414,20 @@ <h1>Source code for qiskit_qec.circuits.code_circuit</h1><div class="highlight">
 <div class="viewcode-block" id="CodeCircuit.is_cluster_neutral">
 <a class="viewcode-back" href="../../../stubs/qiskit_qec.circuits.CodeCircuit.html#qiskit_qec.circuits.CodeCircuit.is_cluster_neutral">[docs]</a>
     <span class="nd">@abstractmethod</span>
-    <span class="k">def</span> <span class="nf">is_cluster_neutral</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">atypical_nodes</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">is_cluster_neutral</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodes</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Determines whether or not the cluster is neutral, meaning that one or more</span>
-<span class="sd">        errors could have caused the set of atypical nodes (syndrome changes) passed</span>
+<span class="sd">        errors could have caused the set of nodes (syndrome changes) passed</span>
 <span class="sd">        to the method.</span>
 
 <span class="sd">        Default version here assumes that it is as simple as an an even/odd assessment</span>
 <span class="sd">        (as for repetition codes, surface codes, etc). This should be overwritten for</span>
 <span class="sd">        more complex codes. It also should be used with care, by only supplying sets</span>
 <span class="sd">        of nodes for which the even/odd assessment is valid.</span>
 <span class="sd">        Args:</span>
-<span class="sd">            atypical_nodes (dictionary in the form of the return value of string2nodes)</span>
+<span class="sd">            nodes (dictionary in the form of the return value of string2nodes)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="k">return</span> <span class="ow">not</span> <span class="nb">bool</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">atypical_nodes</span><span class="p">)</span> <span class="o">%</span> <span class="mi">2</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="ow">not</span> <span class="nb">bool</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">nodes</span><span class="p">)</span> <span class="o">%</span> <span class="mi">2</span><span class="p">)</span></div>
 </div>
 
 </pre></div>
@@ -447,7 +447,7 @@ <h1>Source code for qiskit_qec.circuits.code_circuit</h1><div class="highlight">
 
             <a href="https://github.com/pradyunsg/furo">Furo</a>
             <div class="last-updated">
-              Last updated on 2024/03/04</div>
+              Last updated on 2024/03/07</div>
           </div>
           <div class="right-details">
 

_modules/qiskit_qec/circuits/css_code.html

@@ -617,13 +617,13 @@ <h1>Source code for qiskit_qec.circuits.css_code</h1><div class="highlight"><pre
 
 <div class="viewcode-block" id="CSSCodeCircuit.check_nodes">
 <a class="viewcode-back" href="../../../stubs/qiskit_qec.circuits.CSSCodeCircuit.html#qiskit_qec.circuits.CSSCodeCircuit.check_nodes">[docs]</a>
-    <span class="k">def</span> <span class="nf">check_nodes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodes</span><span class="p">,</span> <span class="n">ignore_extra_logical</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">minimal</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">check_nodes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodes</span><span class="p">,</span> <span class="n">ignore_extras</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">minimal</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
         <span class="k">raise</span> <span class="ne">NotImplementedError</span></div>
 
 
 <div class="viewcode-block" id="CSSCodeCircuit.is_cluster_neutral">
 <a class="viewcode-back" href="../../../stubs/qiskit_qec.circuits.CSSCodeCircuit.html#qiskit_qec.circuits.CSSCodeCircuit.is_cluster_neutral">[docs]</a>
-    <span class="k">def</span> <span class="nf">is_cluster_neutral</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">atypical_nodes</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">is_cluster_neutral</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nodes</span><span class="p">):</span>
         <span class="k">raise</span> <span class="ne">NotImplementedError</span></div>
 
 
@@ -761,7 +761,7 @@ <h1>Source code for qiskit_qec.circuits.css_code</h1><div class="highlight"><pre
 
             <a href="https://github.com/pradyunsg/furo">Furo</a>
             <div class="last-updated">
-              Last updated on 2024/03/04</div>
+              Last updated on 2024/03/07</div>
           </div>
           <div class="right-details">