Update docu to mention barrier instructions. (#28)

* Update docu to mention barrier instructions. * Apply suggestions from review Co-authored-by: Hayk Sargsyan <[email protected]> * Update changelog. Co-authored-by: Hayk Sargsyan <[email protected]>
iqm-finland · May 23, 2022 · 01a1f87 · 01a1f87
1 parent e96de94
commit 01a1f87
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,11 @@
 Changelog
 =========
 
+Version 3.1
+===========
+
+* Update documentation to mention barriers. `#28 <https://github.com/iqm-finland/iqm-client/pull/28>`_
+
 Version 3.0
 ===========
 

diff --git a/src/iqm_client/iqm_client.py b/src/iqm_client/iqm_client.py
@@ -32,6 +32,7 @@
 measurement      >= 1        ``key: str``                           Measurement in the Z basis.
 phased_rx        1           ``angle_t: float``, ``phase_t: float`` Phased x-rotation gate.
 cz               2                                                  Controlled-Z gate.
+barrier          >= 2                                               Barrier instruction.
 ================ =========== ====================================== ===========
 
 Measurement
@@ -76,6 +77,15 @@
 Example: ``Instruction(name='cz', qubits=['alice', 'bob'], args={})``
 
 
+Barrier
+-------
+
+Barriers ensure that all operations after the barrier on the qubit subsystems spanned by
+the barrier are only executed when all the operations before the barrier have been completed.
+
+Example: ``Instruction(name='barrier', qubits=['alice', 'bob'], args={})``
+
+
 Circuit output
 ==============