QNLab-USTC · xmgao · Nov 11, 2024 · Nov 25, 2024
diff --git a/docs/build/doctrees/develop.doctree b/docs/build/doctrees/develop.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/install.doctree b/docs/build/doctrees/install.doctree
diff --git a/docs/build/doctrees/introduction.doctree b/docs/build/doctrees/introduction.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/doctrees/qns.doctree b/docs/build/doctrees/qns.doctree
diff --git a/docs/build/doctrees/qns.entity.cchannel.doctree b/docs/build/doctrees/qns.entity.cchannel.doctree
diff --git a/docs/build/doctrees/qns.entity.doctree b/docs/build/doctrees/qns.entity.doctree
diff --git a/docs/build/doctrees/qns.entity.memory.doctree b/docs/build/doctrees/qns.entity.memory.doctree
diff --git a/docs/build/doctrees/qns.entity.monitor.doctree b/docs/build/doctrees/qns.entity.monitor.doctree
diff --git a/docs/build/doctrees/qns.entity.node.doctree b/docs/build/doctrees/qns.entity.node.doctree
diff --git a/docs/build/doctrees/qns.entity.operator.doctree b/docs/build/doctrees/qns.entity.operator.doctree
diff --git a/docs/build/doctrees/qns.entity.qchannel.doctree b/docs/build/doctrees/qns.entity.qchannel.doctree
diff --git a/docs/build/doctrees/qns.entity.timer.doctree b/docs/build/doctrees/qns.entity.timer.doctree
diff --git a/docs/build/doctrees/qns.models.core.doctree b/docs/build/doctrees/qns.models.core.doctree
diff --git a/docs/build/doctrees/qns.models.delay.doctree b/docs/build/doctrees/qns.models.delay.doctree
diff --git a/docs/build/doctrees/qns.models.doctree b/docs/build/doctrees/qns.models.doctree
diff --git a/docs/build/doctrees/qns.models.epr.doctree b/docs/build/doctrees/qns.models.epr.doctree
diff --git a/docs/build/doctrees/qns.models.qubit.doctree b/docs/build/doctrees/qns.models.qubit.doctree
diff --git a/docs/build/doctrees/qns.network.doctree b/docs/build/doctrees/qns.network.doctree
diff --git a/docs/build/doctrees/qns.network.protocol.doctree b/docs/build/doctrees/qns.network.protocol.doctree
diff --git a/docs/build/doctrees/qns.network.route.doctree b/docs/build/doctrees/qns.network.route.doctree
diff --git a/docs/build/doctrees/qns.network.topology.doctree b/docs/build/doctrees/qns.network.topology.doctree
diff --git a/docs/build/doctrees/qns.simulator.doctree b/docs/build/doctrees/qns.simulator.doctree
diff --git a/docs/build/doctrees/qns.utils.doctree b/docs/build/doctrees/qns.utils.doctree
diff --git a/docs/build/doctrees/tutorials.doctree b/docs/build/doctrees/tutorials.doctree
diff --git a/docs/build/doctrees/tutorials.entity.cchannel.doctree b/docs/build/doctrees/tutorials.entity.cchannel.doctree
diff --git a/docs/build/doctrees/tutorials.entity.doctree b/docs/build/doctrees/tutorials.entity.doctree
diff --git a/docs/build/doctrees/tutorials.entity.memory.doctree b/docs/build/doctrees/tutorials.entity.memory.doctree
diff --git a/docs/build/doctrees/tutorials.entity.monitor.doctree b/docs/build/doctrees/tutorials.entity.monitor.doctree
diff --git a/docs/build/doctrees/tutorials.entity.node.doctree b/docs/build/doctrees/tutorials.entity.node.doctree
diff --git a/docs/build/doctrees/tutorials.entity.operator.doctree b/docs/build/doctrees/tutorials.entity.operator.doctree
diff --git a/docs/build/doctrees/tutorials.entity.other.doctree b/docs/build/doctrees/tutorials.entity.other.doctree
diff --git a/docs/build/doctrees/tutorials.entity.qchannel.doctree b/docs/build/doctrees/tutorials.entity.qchannel.doctree
diff --git a/docs/build/doctrees/tutorials.models.delay.doctree b/docs/build/doctrees/tutorials.models.delay.doctree
diff --git a/docs/build/doctrees/tutorials.models.doctree b/docs/build/doctrees/tutorials.models.doctree
diff --git a/docs/build/doctrees/tutorials.models.epr.doctree b/docs/build/doctrees/tutorials.models.epr.doctree
diff --git a/docs/build/doctrees/tutorials.models.qubit.doctree b/docs/build/doctrees/tutorials.models.qubit.doctree
diff --git a/docs/build/doctrees/tutorials.network.doctree b/docs/build/doctrees/tutorials.network.doctree
diff --git a/docs/build/doctrees/tutorials.network.request.doctree b/docs/build/doctrees/tutorials.network.request.doctree
diff --git a/docs/build/doctrees/tutorials.network.route.doctree b/docs/build/doctrees/tutorials.network.route.doctree
diff --git a/docs/build/doctrees/tutorials.network.topology.doctree b/docs/build/doctrees/tutorials.network.topology.doctree
diff --git a/docs/build/doctrees/tutorials.parallel_simulation.doctree b/docs/build/doctrees/tutorials.parallel_simulation.doctree
diff --git a/docs/build/doctrees/tutorials.quickstart.doctree b/docs/build/doctrees/tutorials.quickstart.doctree
diff --git a/docs/build/doctrees/tutorials.simulator.doctree b/docs/build/doctrees/tutorials.simulator.doctree
diff --git a/docs/build/doctrees/tutorials.util.doctree b/docs/build/doctrees/tutorials.util.doctree
diff --git a/docs/build/html/_modules/qns/entity/cchannel/cchannel.html b/docs/build/html/_modules/qns/entity/cchannel/cchannel.html
@@ -152,14 +152,15 @@ <h1>Source code for qns.entity.cchannel.cchannel</h1><div class="highlight"><pre
 <span class="sd">    ClassicChannel is the channel for classic message</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">node_list</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">QNode</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
-                 <span class="n">bandwidth</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">delay</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="n">DelayModel</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">drop_rate</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
+                 <span class="n">bandwidth</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">delay</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="n">DelayModel</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">length</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">drop_rate</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
                  <span class="n">max_buffer_size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Args:</span>
 <span class="sd">            name (str): the name of this channel</span>
 <span class="sd">            node_list (List[QNode]): a list of QNodes that it connects to</span>
 <span class="sd">            bandwidth (int): the byte per second on this channel. 0 represents unlimited</span>
 <span class="sd">            delay (Union[float, DelayModel]): the time delay for transmitting a packet. It is a float number or a ``DelayModel``</span>
+<span class="sd">            length (float): the length of this channel</span>
 <span class="sd">            drop_rate (float): the drop rate</span>
 <span class="sd">            max_buffer_size (int): the max buffer size.</span>
 <span class="sd">                If it is full, the next coming packet will be dropped. 0 represents unlimited.</span>
@@ -169,6 +170,7 @@ <h1>Source code for qns.entity.cchannel.cchannel</h1><div class="highlight"><pre
         <span class="bp">self</span><span class="o">.</span><span class="n">bandwidth</span> <span class="o">=</span> <span class="n">bandwidth</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">delay_model</span> <span class="o">=</span> <span class="n">delay</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">delay</span><span class="p">,</span> <span class="n">DelayModel</span><span class="p">)</span> <span class="k">else</span> <span class="n">ConstantDelayModel</span><span class="p">(</span><span class="n">delay</span><span class="o">=</span><span class="n">delay</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">drop_rate</span> <span class="o">=</span> <span class="n">drop_rate</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">length</span> <span class="o">=</span> <span class="n">length</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">max_buffer_size</span> <span class="o">=</span> <span class="n">max_buffer_size</span>
 
 <div class="viewcode-block" id="ClassicChannel.install"><a class="viewcode-back" href="../../../../qns.entity.cchannel.html#qns.entity.ClassicChannel.install">[docs]</a>    <span class="k">def</span> <span class="nf">install</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">simulator</span><span class="p">:</span> <span class="n">Simulator</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>

diff --git a/docs/build/html/_modules/qns/entity/entity.html b/docs/build/html/_modules/qns/entity/entity.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en,zh-CN" >
+<html class="writer-html5" lang="en" >
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -40,7 +40,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../install.html">Install Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../develop.html">Develop Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">qns</a></li>
 </ul>
 
         </div>

diff --git a/docs/build/html/_modules/qns/entity/memory/event.html b/docs/build/html/_modules/qns/entity/memory/event.html
@@ -40,7 +40,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../../install.html">Install Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../develop.html">Develop Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../modules.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../modules.html">qns</a></li>
 </ul>
 
         </div>

diff --git a/docs/build/html/_modules/qns/entity/monitor/monitor.html b/docs/build/html/_modules/qns/entity/monitor/monitor.html
@@ -88,7 +88,6 @@ <h1>Source code for qns.entity.monitor.monitor</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Optional</span>
 <span class="kn">from</span> <span class="nn">qns.entity.entity</span> <span class="kn">import</span> <span class="n">Entity</span>
-<span class="kn">from</span> <span class="nn">qns.network.network</span> <span class="kn">import</span> <span class="n">QuantumNetwork</span>
 <span class="kn">from</span> <span class="nn">qns.simulator.event</span> <span class="kn">import</span> <span class="n">Event</span>
 <span class="kn">from</span> <span class="nn">qns.simulator.simulator</span> <span class="kn">import</span> <span class="n">Simulator</span>
 <span class="kn">from</span> <span class="nn">qns.simulator.ts</span> <span class="kn">import</span> <span class="n">Time</span>
@@ -108,7 +107,7 @@ <h1>Source code for qns.entity.monitor.monitor</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="Monitor"><a class="viewcode-back" href="../../../../qns.entity.monitor.html#qns.entity.Monitor">[docs]</a><span class="k">class</span> <span class="nc">Monitor</span><span class="p">(</span><span class="n">Entity</span><span class="p">):</span>
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">network</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">QuantumNetwork</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">network</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Monitor is a virtual entity that helps users to collect network status.</span>
 
@@ -174,7 +173,7 @@ <h1>Source code for qns.entity.monitor.monitor</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span></div>
 
 <div class="viewcode-block" id="Monitor.add_attribution"><a class="viewcode-back" href="../../../../qns.entity.monitor.html#qns.entity.Monitor.add_attribution">[docs]</a>    <span class="k">def</span> <span class="nf">add_attribution</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
-                        <span class="n">calculate_func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">Simulator</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="n">QuantumNetwork</span><span class="p">],</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Event</span><span class="p">]],</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+                        <span class="n">calculate_func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">Simulator</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Event</span><span class="p">]],</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Set an attribution that will be recorded. For example, an attribution could be the throughput, or the fidelity.</span>
 
@@ -224,7 +223,7 @@ <h1>Source code for qns.entity.monitor.monitor</h1><div class="highlight"><pre>
 <span class="sd">            # record network status every 3 seconds.</span>
 <span class="sd">            m.at_period(3)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="k">assert</span><span class="p">(</span><span class="n">period_time</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">)</span>
+        <span class="k">assert</span> <span class="p">(</span><span class="n">period_time</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">watch_period</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">period_time</span><span class="p">)</span></div>
 
 <div class="viewcode-block" id="Monitor.at_event"><a class="viewcode-back" href="../../../../qns.entity.monitor.html#qns.entity.Monitor.at_event">[docs]</a>    <span class="k">def</span> <span class="nf">at_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event_type</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>

diff --git a/docs/build/html/_modules/qns/entity/node/app.html b/docs/build/html/_modules/qns/entity/node/app.html
@@ -40,7 +40,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../../install.html">Install Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../tutorials.html">Tutorials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../develop.html">Develop Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../modules.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../modules.html">qns</a></li>
 </ul>
 
         </div>