Repository navigation
Expand file tree
/
Copy pathapiref.html
More file actions
475 lines (424 loc) · 30.6 KB
/
Copy pathapiref.html
File metadata and controls
475 lines (424 loc) · 30.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API Reference — PyQuafu-Docs 0.4.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=6c02275b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="User Guide" href="tutorial.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
PyQuafu-Docs
</a>
<div class="version">
0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#quantum-circuit">Quantum Circuit</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#quafu.QuantumCircuit"><code class="docutils literal notranslate"><span class="pre">QuantumCircuit</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#quafu.QuantumCircuit.add_gate"><code class="docutils literal notranslate"><span class="pre">QuantumCircuit.add_gate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.QuantumCircuit.barrier"><code class="docutils literal notranslate"><span class="pre">QuantumCircuit.barrier()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.QuantumCircuit.cnot"><code class="docutils literal notranslate"><span class="pre">QuantumCircuit.cnot()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#quantum-elements">Quantum Elements</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#quafu.elements.Instruction"><code class="docutils literal notranslate"><span class="pre">Instruction</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#quafu.elements.Instruction.pos"><code class="docutils literal notranslate"><span class="pre">Instruction.pos</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.elements.Instruction.paras"><code class="docutils literal notranslate"><span class="pre">Instruction.paras</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.elements.Instruction.named_paras"><code class="docutils literal notranslate"><span class="pre">Instruction.named_paras</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.elements.Instruction.named_pos"><code class="docutils literal notranslate"><span class="pre">Instruction.named_pos</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.elements.Instruction.register"><code class="docutils literal notranslate"><span class="pre">Instruction.register()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#task-and-user">Task and User</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#quafu.Task"><code class="docutils literal notranslate"><span class="pre">Task</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#quafu.Task.shots"><code class="docutils literal notranslate"><span class="pre">Task.shots</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.Task.compile"><code class="docutils literal notranslate"><span class="pre">Task.compile</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.Task.tomo"><code class="docutils literal notranslate"><span class="pre">Task.tomo</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.Task.user"><code class="docutils literal notranslate"><span class="pre">Task.user</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.Task.priority"><code class="docutils literal notranslate"><span class="pre">Task.priority</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.Task.submit_history"><code class="docutils literal notranslate"><span class="pre">Task.submit_history</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.Task.backend"><code class="docutils literal notranslate"><span class="pre">Task.backend</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.Task.config"><code class="docutils literal notranslate"><span class="pre">Task.config()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.Task.retrieve"><code class="docutils literal notranslate"><span class="pre">Task.retrieve()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.Task.send"><code class="docutils literal notranslate"><span class="pre">Task.send()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#quafu.User"><code class="docutils literal notranslate"><span class="pre">User</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#quafu.User.get_available_backends"><code class="docutils literal notranslate"><span class="pre">User.get_available_backends()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#quafu.User.save_apitoken"><code class="docutils literal notranslate"><span class="pre">User.save_apitoken()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#quafu.results.results.Result"><code class="docutils literal notranslate"><span class="pre">Result</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PyQuafu-Docs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">API Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apiref.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This page is still under refinement, the contents you see may be incomplete at present.</p>
</div>
<section id="quantum-circuit">
<span id="id1"></span><h2>Quantum Circuit<a class="headerlink" href="#quantum-circuit" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="quafu.QuantumCircuit">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quafu.</span></span><span class="sig-name descname"><span class="pre">QuantumCircuit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qnum</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cnum</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">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.QuantumCircuit" title="Link to this definition"></a></dt>
<dd><p>Representation of quantum circuit.</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>qnum</strong> (<em>int</em>)</p></li>
<li><p><strong>cnum</strong> (<em>int</em><em> | </em><em>None</em>)</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="quafu.QuantumCircuit.add_gate">
<span class="sig-name descname"><span class="pre">add_gate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gate</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.QuantumCircuit.add_gate" title="Link to this definition"></a></dt>
<dd><p>Add quantum gate to circuit, with some checking.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>gate</strong> (<em>QuantumGate</em>)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="quafu.QuantumCircuit.barrier">
<span class="sig-name descname"><span class="pre">barrier</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qlist</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.QuantumCircuit.barrier" title="Link to this definition"></a></dt>
<dd><p>Add barrier for qubits in qlist.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>qlist</strong> (<em>list</em><em>[</em><em>int</em><em>]</em>) – A list contain the qubit need add barrier. When qlist contain at least two qubit, the barrier will be added from minimum qubit to maximum qubit. For example: barrier([0, 2]) create barrier for qubits 0, 1, 2. To create discrete barrier, using barrier([0]), barrier([2]).</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#quafu.QuantumCircuit" title="quafu.circuits.quantum_circuit.QuantumCircuit"><em>QuantumCircuit</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="quafu.QuantumCircuit.cnot">
<span class="sig-name descname"><span class="pre">cnot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctrl</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tar</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.QuantumCircuit.cnot" title="Link to this definition"></a></dt>
<dd><p>CNOT gate.</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>ctrl</strong> (<em>int</em>) – control qubit.</p></li>
<li><p><strong>tar</strong> (<em>int</em>) – target qubit.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#quafu.QuantumCircuit" title="quafu.circuits.quantum_circuit.QuantumCircuit"><em>QuantumCircuit</em></a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="quantum-elements">
<h2>Quantum Elements<a class="headerlink" href="#quantum-elements" title="Link to this heading"></a></h2>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>hello</p>
</div>
<dl class="py class">
<dt class="sig sig-object py" id="quafu.elements.Instruction">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quafu.elements.</span></span><span class="sig-name descname"><span class="pre">Instruction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">paras</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.elements.Instruction" title="Link to this definition"></a></dt>
<dd><p>Base class for ALL the possible instructions on Quafu superconducting quantum circuits.</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>pos</strong> (<em>List</em><em>[</em><em>int</em><em>]</em>)</p></li>
<li><p><strong>paras</strong> (<em>List</em><em>[</em><em>float</em><em> | </em><em>Parameter</em><em> | </em><em>ParameterExpression</em><em>]</em>)</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="quafu.elements.Instruction.pos">
<span class="sig-name descname"><span class="pre">pos</span></span><a class="headerlink" href="#quafu.elements.Instruction.pos" title="Link to this definition"></a></dt>
<dd><p>Qubit position(s) of the instruction on the circuit.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="quafu.elements.Instruction.paras">
<span class="sig-name descname"><span class="pre">paras</span></span><a class="headerlink" href="#quafu.elements.Instruction.paras" title="Link to this definition"></a></dt>
<dd><p>Parameters of the instruction.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="quafu.elements.Instruction.named_paras">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">named_paras</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#quafu.elements.Instruction.named_paras" title="Link to this definition"></a></dt>
<dd><p>dict-mapping for parameters</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="quafu.elements.Instruction.named_pos">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">named_pos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#quafu.elements.Instruction.named_pos" title="Link to this definition"></a></dt>
<dd><p>dict-mapping for positions</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="quafu.elements.Instruction.register">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">register</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.elements.Instruction.register" title="Link to this definition"></a></dt>
<dd><p>Register a virtual subclass of an ABC.</p>
<p>Returns the subclass, to allow usage as a class decorator.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</strong> (<em>str</em><em> | </em><em>None</em>)</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="task-and-user">
<h2>Task and User<a class="headerlink" href="#task-and-user" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="quafu.Task">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quafu.</span></span><span class="sig-name descname"><span class="pre">Task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.Task" title="Link to this definition"></a></dt>
<dd><p>Class for submitting quantum computation task to the backend.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>user</strong> (<a class="reference internal" href="#quafu.User" title="quafu.users.userapi.User"><em>User</em></a><em> | </em><em>None</em>)</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="quafu.Task.shots">
<span class="sig-name descname"><span class="pre">shots</span></span><a class="headerlink" href="#quafu.Task.shots" title="Link to this definition"></a></dt>
<dd><p>Numbers of single shot measurement.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="quafu.Task.compile">
<span class="sig-name descname"><span class="pre">compile</span></span><a class="headerlink" href="#quafu.Task.compile" title="Link to this definition"></a></dt>
<dd><p>Whether compile the circuit on the backend</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="quafu.Task.tomo">
<span class="sig-name descname"><span class="pre">tomo</span></span><a class="headerlink" href="#quafu.Task.tomo" title="Link to this definition"></a></dt>
<dd><p>Whether do tomography (Not support yet)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="quafu.Task.user">
<span class="sig-name descname"><span class="pre">user</span></span><a class="headerlink" href="#quafu.Task.user" title="Link to this definition"></a></dt>
<dd><p>User object corresponding to Quafu account</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#quafu.User" title="quafu.User">User</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="quafu.Task.priority">
<span class="sig-name descname"><span class="pre">priority</span></span><a class="headerlink" href="#quafu.Task.priority" title="Link to this definition"></a></dt>
<dd><p>priority level of the task</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="quafu.Task.submit_history">
<span class="sig-name descname"><span class="pre">submit_history</span></span><a class="headerlink" href="#quafu.Task.submit_history" title="Link to this definition"></a></dt>
<dd><p>circuit submitted with this task</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="quafu.Task.backend">
<span class="sig-name descname"><span class="pre">backend</span></span><a class="headerlink" href="#quafu.Task.backend" title="Link to this definition"></a></dt>
<dd><p>quantum backend that execute the task.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="quafu.Task.config">
<span class="sig-name descname"><span class="pre">config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ScQ-P10'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shots</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compile</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">tomo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.Task.config" title="Link to this definition"></a></dt>
<dd><p>Configure the task properties</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>backend</strong> (<em>str</em>) – Select the experimental backend.</p></li>
<li><p><strong>shots</strong> (<em>int</em>) – Numbers of single shot measurement.</p></li>
<li><p><strong>compile</strong> (<em>bool</em>) – Whether compile the circuit on the backend</p></li>
<li><p><strong>tomo</strong> (<em>bool</em>) – Whether to do tomography (Not support yet)</p></li>
<li><p><strong>priority</strong> (<em>int</em>) – Task priority.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="quafu.Task.retrieve">
<span class="sig-name descname"><span class="pre">retrieve</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">taskid</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.Task.retrieve" title="Link to this definition"></a></dt>
<dd><p>Retrieve the results of submited task by taskid.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>taskid</strong> (<em>str</em>) – The taskid of the task need to be retrieved.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><em>ExecResult</em></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="quafu.Task.send">
<span class="sig-name descname"><span class="pre">send</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait</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="#quafu.Task.send" title="Link to this definition"></a></dt>
<dd><p>Run the circuit on experimental device.</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>qc</strong> (<a class="reference internal" href="#quafu.QuantumCircuit" title="quafu.circuits.quantum_circuit.QuantumCircuit"><em>QuantumCircuit</em></a>) – Quantum circuit that need to be executed on backend.</p></li>
<li><p><strong>name</strong> (<em>str</em>) – Task name.</p></li>
<li><p><strong>group</strong> (<em>str</em>) – The task belong which group.</p></li>
<li><p><strong>wait</strong> (<em>bool</em>) – Whether wait until the execution return.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>ExecResult object that contain the dict return from quantum device.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>ExecResult</em></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="quafu.User">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quafu.</span></span><span class="sig-name descname"><span class="pre">User</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_token</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">token_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.User" title="Link to this definition"></a></dt>
<dd><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>api_token</strong> (<em>str</em><em> | </em><em>None</em>)</p></li>
<li><p><strong>token_dir</strong> (<em>str</em><em> | </em><em>None</em>)</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="quafu.User.get_available_backends">
<span class="sig-name descname"><span class="pre">get_available_backends</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">print_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.User.get_available_backends" title="Link to this definition"></a></dt>
<dd><p>Get available backends</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="quafu.User.save_apitoken">
<span class="sig-name descname"><span class="pre">save_apitoken</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">apitoken</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quafu.User.save_apitoken" title="Link to this definition"></a></dt>
<dd><p>Save api-token associate your Quafu account.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="quafu.results.results.Result">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quafu.results.results.</span></span><span class="sig-name descname"><span class="pre">Result</span></span><a class="headerlink" href="#quafu.results.results.Result" title="Link to this definition"></a></dt>
<dd><p>Basis class for quantum results</p>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="tutorial.html" class="btn btn-neutral float-left" title="User Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2023, BAQIS-ScQ-Cloud.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
Version: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://scq-cloud.github.io/0.2.x/index.html">0.2.x</a></dd>
<dd><a href="https://scq-cloud.github.io/0.3.x/index.html">0.3.x</a></dd>
<dd><a href="https://scq-cloud.github.io/0.4.0/index.html">0.4.0</a></dd>
</dl>
<br>
</dl>
</div>
</div><script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>