example_usage draft

docs/example_usage.ipynb

@@ -122,8 +122,7 @@
     "\n",
     "# VNA operation needs a signal power and measurement bandwidth. These can be tuned for optimal measurement.\n",
     "vna_power = -30 # dBm\n",
-    "vna_bandwidth = 500 # Hz\n",
-    "\n"
+    "vna_bandwidth = 500 # Hz"
    ]
   },
   {
@@ -132,7 +131,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Set parameters accordingly\n",
+    "# Set parameters accordingly on the hardware.\n",
     "lab.HAL('VNA').FrequencyStart = freq_start\n",
     "lab.HAL('VNA').FrequencyEnd = freq_end\n",
     "lab.HAL('VNA').SweepMode = sweep_type\n",
@@ -342,7 +341,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Next, we can load some microwave sources. First will be a source used for resonator spectroscopy. In addition, the acquisition device loaded above has some sample rate constraint which, for all our devices, prohibits accurately sampling microwave signals. So, we use a second microwave signal for downconversion purposes (see ... for an explanation). Finally, we will load a third microwave source for driving qubit/s for qubit spectroscopy. Documentation on microwave sources is available [here](https://github.com/sqdlab/SQDToolz/blob/main/docs/User/GENmwSource.md)."
+    "Next, we can load some microwave sources. First will be a source used for resonator spectroscopy. A second microwave signal is used for [downconversion purposes](deadlink). Finally, we will load a third microwave source for driving qubit/s for qubit spectroscopy. Documentation on microwave sources is available [here](https://github.com/sqdlab/SQDToolz/blob/main/docs/User/GENmwSource.md). "
    ]
   },
   {
@@ -518,7 +517,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We encode this processing with a DataProcessor object. There are three variants; ProcessorFPGA, ProcessorGPU, and ProcessorCPU. Here I use ProcessorFPGA, for which some docs exist [here](https://github.com/sqdlab/SQDToolz/blob/main/docs/User/Proc_FPGA_Overview.md)."
+    "We instruct our processor to perform this with a DataProcessor object. There are three variants; ProcessorFPGA, ProcessorGPU, and ProcessorCPU. Here I use ProcessorFPGA, for which some docs exist [here](https://github.com/sqdlab/SQDToolz/blob/main/docs/User/Proc_FPGA_Overview.md)."
    ]
   },
   {
@@ -889,7 +888,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "So far, we have done qubit spectroscopy by driving the qubit and the resonator at the same time, and measuring the results. It can happen that the resonator drive (populating the resonator) can induce a Stark shift, and move the qubit frequency. We can instead perform a pulsed spectroscopy, using the `PulseModulated` settings on the microwave sources, to successively excite the qubit, THEN measure the resonator. The qubit should be driven from a long time (longer than $T_2$) to ensure that it saturates to 50$\\%$ population, and that a shift can therefore be measured."
+    "So far, we have done qubit spectroscopy by driving the qubit and the resonator at the same time, and measuring the results. It can happen that the resonator drive (populating the resonator) can induce a Stark shift, and move the qubit frequency. We can instead perform a pulsed spectroscopy, using the `PulseModulated` settings on the microwave sources, to successively excite the qubit, THEN measure the resonator. The qubit should be driven from a long time (longer than $T_2$) to ensure that it saturates to 50$\\%$ population, and that a shift can therefore be measured reliably."
    ]
   },
   {
@@ -1687,7 +1686,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### T_1 measurement"
+    "### $T_1$ measurement"
    ]
   },
   {
@@ -1723,34 +1722,42 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Other experiments"
+    "This is the standard set of measurements for characterising coherence times of a qubit. There is also a great deal of documentation (more than what is linked in here) on most of the objects used in this notebook in the [GitHub repo](https://github.com/sqdlab/SQDToolz/tree/main/docs)."
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## General FAQs"
+    "### Other experiments"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Debugging"
+    "As you create new experiments which are useful for other people, it is encouraged to [formalise these](https://github.com/sqdlab/SQDToolz/blob/main/docs/Developer/Creating%20custom%20experiments.md) into Experiment classes, and deposit them in the appropriate [directory](https://github.com/sqdlab/SQDToolz/tree/main/sqdtoolz/Experiments/Experimental). Some additional experiments which have not been discussed here include:\n",
+    "- `ExpACstarkRamseyGE`: an on-resonance Ramsey experiment which drives during the built-in wait time, where the resultant frequency oscillations arise from detuning due to AC-Stark shift.\n",
+    "- `ExpCalibXRot`: an experiment which involves repeating $X_\\pi$ or $X_{\\pi/2}$ rotations, to characterise coherent over- or under-rotation error.\n",
+    "- `ExpHahnGE`: A measurement of pure $T_2$ time.\n",
+    "- `ExpSingleShotGE`: A measurement which repeatedly prepares $\\ket{0}$ and $\\ket{1}$ states, and measures the distribution of the resultant measurement signals in the I-Q plane."
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Custom experiments"
+    "### A note: debugging measurements which don't show what you expect"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
-   "source": []
+   "source": [
+    "Likely the most useful tool for debugging is the Browser tool accessible with `lab.open_browser()`, which displays the current configuration of all loaded instruments (and waveforms, and specifications) while an experiment is ongoing. With this, you should check if all the instruments are behaving as you expect for an experiment.\n",
+    "\n",
+    "There is also a second tab on the browser which allows you to compare configs from finished experiments. You may need to close and restart the browser to retrieve recent experiments. This is useful if a previously functional experiment stops showing sensible results; you can compare what has changed in between the two runs (e.g. perhaps you modified the measurement signal power and didn't realise)."
+   ]
   }
  ],
  "metadata": {