Update examples for labone release 22.08

zhinst · Aug 31, 2022 · 406e209 · 406e209
1 parent 8ba6991
commit 406e209
Show file tree

Hide file tree

Showing 24 changed files with 131 additions and 76 deletions.
diff --git a/examples/awg.md b/examples/awg.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.14.0
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/daq_module.md b/examples/daq_module.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/hdawg_awg.md b/examples/hdawg_awg.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python
@@ -48,33 +48,39 @@ with device.set_transaction():
     device.awgs[0].userregs(0)
 ```
 
-### Configuring the AWG program
+### Define and compile the AWG program
 
 ```python
-import textwrap
+from zhinst.toolkit import Sequence
+
 AWG_N = 2000
+awg_program = Sequence()
+awg_program.constants["AWG_N"] = AWG_N
+awg_program.code = """
+wave w0 = gauss(AWG_N, AWG_N/2, AWG_N/20);
+wave w1 = placeholder(AWG_N);
+wave w2 = zeros(AWG_N);
+wave w3 = placeholder(AWG_N);
+assignWaveIndex(1, w1, 1);
+assignWaveIndex(1, w3, 3);
+while(getUserReg(0) == 0) {
+    setTrigger(1);
+    setTrigger(0);
+    playWave(w0);
+    playWave(w1);
+    playWave(w2);
+    playWave(w3);
+}
+"""
+print(awg_program)
+```
 
-awg_program = textwrap.dedent(f"""
-        const AWG_N = {AWG_N};
-        wave w0 = gauss(AWG_N, AWG_N/2, AWG_N/20);
-        wave w1 = placeholder(AWG_N);
-        wave w2 = zeros(AWG_N);
-        wave w3 = placeholder(AWG_N);
-        assignWaveIndex(1, w1, 1);
-        assignWaveIndex(1, w3, 3);
-        while(getUserReg(0) == 0) {
-        setTrigger(1);
-        setTrigger(0);
-        playWave(w0);
-        playWave(w1);
-        playWave(w2);
-        playWave(w3);
-        }
-""")
-device.awgs[0].load_sequencer_program(awg_program)
+```python
+elf_file, info = device.awgs[0].compile_sequencer_program(awg_program)
+info
 ```
 
-#### Write the waveforms into the device memory
+### Define Waveforms 
 
 ```python
 from zhinst.toolkit import Waveforms
@@ -88,12 +94,16 @@ waveforms.assign_waveform(
     slot=3,
     wave1=-1.0 * np.blackman(AWG_N)
 )
-device.awgs[0].write_to_waveform_memory(waveforms)
 ```
 
-### Run the program
+### Upload and Run the program
+
+This can be done in a single transaction which reduces the network communication overhead to a minimum
 
 ```python
-device.awgs[0].single(True)
-device.awgs[0].enable(True)
+with device.set_transaction():
+    device.awgs[0].elf.data(elf_file)
+    device.awgs[0].write_to_waveform_memory(waveforms)
+    device.awgs[0].single(True)
+    device.awgs[0].enable(True)
 ```
diff --git a/examples/hdawg_precomp_curve_fit.md b/examples/hdawg_precomp_curve_fit.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/hf2.md b/examples/hf2.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/nodetree.md b/examples/nodetree.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/scope_module.md b/examples/scope_module.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python
@@ -28,8 +28,7 @@ Requirements:
 
 * LabOne Version >= 22.02
 * Instruments:
-    1 x MF or UHF Instrument with DIG Option (HF2 does not support
-        multi-channel recording).
+    1 x MF or UHF Instrument with DIG Option (HF2 does not support multi-channel recording).
 
 ```python
 from zhinst.toolkit import Session
@@ -269,6 +268,8 @@ _, (ax1, ax2) = plt.subplots(2)
 plot_time_domain(ax1, data_no_trig, SCOPE_CHANNEL)
 ax1.set_title(f"{len(data_no_trig)} Scope records from {device} (triggering disabled)")
 
+plt.subplots_adjust(hspace = 1)
+
 # Plot the scope data with triggering enabled.
 plot_time_domain(ax2, data_with_trig, SCOPE_CHANNEL)
 ax2.axvline(0.0, linewidth=2, linestyle="--", color="k", label="Trigger time")

diff --git a/examples/shfqa_qubit_readout_measurement.md b/examples/shfqa_qubit_readout_measurement.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python
@@ -173,7 +173,3 @@ plt.ylabel("imaginary part")
 plt.grid()
 plt.show()
 ```
-
-```python
-
-```
diff --git a/examples/shfqa_qubit_readout_weights.md b/examples/shfqa_qubit_readout_weights.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/shfqa_sweeper.md b/examples/shfqa_sweeper.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/shfqc_propagation_delay.md b/examples/shfqc_propagation_delay.md
@@ -6,9 +6,9 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
-    display_name: Python 3
+    display_name: Python 3 (ipykernel)
     language: python
     name: python3
 ---

diff --git a/examples/shfqc_qubit_spectroscopy.md b/examples/shfqc_qubit_spectroscopy.md
@@ -6,9 +6,9 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
-    display_name: Python 3
+    display_name: Python 3 (ipykernel)
     language: python
     name: python3
 ---

diff --git a/examples/shfqc_rabi.md b/examples/shfqc_rabi.md
@@ -6,9 +6,9 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
-    display_name: Python 3
+    display_name: Python 3 (ipykernel)
     language: python
     name: python3
 ---

diff --git a/examples/shfqc_resonator_spectroscopy_cw.md b/examples/shfqc_resonator_spectroscopy_cw.md
@@ -6,9 +6,9 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
-    display_name: Python 3
+    display_name: Python 3 (ipykernel)
     language: python
     name: python3
 ---

diff --git a/examples/shfqc_resonator_spectroscopy_cw_power.md b/examples/shfqc_resonator_spectroscopy_cw_power.md
@@ -6,9 +6,9 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
-    display_name: Python 3
+    display_name: Python 3 (ipykernel)
     language: python
     name: python3
 ---

diff --git a/examples/shfsg_rabi.md b/examples/shfsg_rabi.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/shfsg_sine.md b/examples/shfsg_sine.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/sweeper_module.md b/examples/sweeper_module.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/uhf_boxcar.md b/examples/uhf_boxcar.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/examples/uhfqa_result_unit.md b/examples/uhfqa_result_unit.md
@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.13.7
+      jupytext_version: 1.14.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python

diff --git a/src/zhinst/toolkit/__init__.py b/src/zhinst/toolkit/__init__.py
@@ -31,4 +31,5 @@
     "PollFlags",
     "Session",
     "Waveforms",
+    "Sequence",
 ]
diff --git a/src/zhinst/toolkit/driver/devices/shfsg.py b/src/zhinst/toolkit/driver/devices/shfsg.py
@@ -68,7 +68,7 @@ def available_trigger_slopes(self) -> t.List[str]:
 
     @property
     def available_marker_outputs(self) -> t.List[str]:
-        """List the available trigger slopes for the sequencer."""
+        """List the available trigger marker outputs for the sequencer."""
         return [
             option.enum
             for option in self.root.sgchannels[

diff --git a/src/zhinst/toolkit/session.py b/src/zhinst/toolkit/session.py
@@ -225,7 +225,10 @@ def __init__(self, session: "Session"):
         self._session = session
 
     def __repr__(self):
-        return f"LabOneModules({self._session.daq_server.host}:{self._session.daq_server.port})"
+        return str(
+            "LabOneModules("
+            f"{self._session.daq_server.host}:{self._session.daq_server.port})"
+        )
 
     def create_awg_module(self) -> tk_modules.BaseModule:
         """Create an instance of the AwgModule.