Skip to content

Commit 58160f9

Browse files
authored
Bugfix broken links (#198)
Did not address broken links in the section titled 'Opening the exported sequence in Q-CTRL BLACK OPAL'.
1 parent 847c446 commit 58160f9

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

examples/creating-a-driven-control.ipynb

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,17 @@
4646
"\n",
4747
"Q-CTRL Open Controls can create driven controls according to the following dynamically corrected gate protocols:\n",
4848
"\n",
49-
"1. [Primitive](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/new_primitive_control.html)\n",
50-
"2. [BB1](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/new_bb1_control.html)\n",
51-
"3. [SK1](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/new_sk1_control.html)\n",
52-
"4. [CORPSE](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/new_corpse_control.html)\n",
53-
"5. [WAMF1](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/new_wamf1_control.html)\n",
54-
"6. [SCROFULOUS](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/new_scrofulous_control.html)\n",
55-
"7. [CORPSE in BB1](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/new_corpse_in_bb1_control.html)\n",
56-
"8. [CORPSE in SK1](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/new_corpse_in_sk1_control.html)\n",
57-
"9. [CORPSE in SCROFULOUS](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/new_corpse_in_scrofulous_control.html)\n",
49+
"1. [Primitive](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/new_primitive_control.html)\n",
50+
"2. [BB1](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/new_bb1_control.html)\n",
51+
"3. [SK1](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/new_sk1_control.html)\n",
52+
"4. [CORPSE](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/new_corpse_control.html)\n",
53+
"5. [WAMF1](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/new_wamf1_control.html)\n",
54+
"6. [SCROFULOUS](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/new_scrofulous_control.html)\n",
55+
"7. [CORPSE in BB1](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/new_corpse_in_bb1_control.html)\n",
56+
"8. [CORPSE in SK1](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/new_corpse_in_sk1_control.html)\n",
57+
"9. [CORPSE in SCROFULOUS](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/new_corpse_in_scrofulous_control.html)\n",
5858
"\n",
59-
"See the [documentation](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols.html) for details."
59+
"See the [documentation](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols.html) for details."
6060
]
6161
},
6262
{
@@ -65,9 +65,9 @@
6565
"source": [
6666
"## Creating and printing a driven control\n",
6767
"\n",
68-
"A driven control is made of a continuous drive on the qubit transition with a tunable detuning. The continuous drive is described by a piecewise constant function made of a list of segments. Each drive segment has a `rabi_rate` applied at an `azimuthal_angle` for a `duration`, with a `detuning`. The mathematical definition of a driven control is explained in the [documentation](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/DrivenControl.html).\n",
68+
"A driven control is made of a continuous drive on the qubit transition with a tunable detuning. The continuous drive is described by a piecewise constant function made of a list of segments. Each drive segment has a `rabi_rate` applied at an `azimuthal_angle` for a `duration`, with a `detuning`. The mathematical definition of a driven control is explained in the [documentation](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/DrivenControl.html).\n",
6969
"\n",
70-
"Q-CTRL Open Controls can generate a driven control from a library of dynamically corrected gate schemes, mathematically defined in the [documentation](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols/DynamicDecouplingSequence.html#). All dynamically corrected gates are derived from three quantities: \n",
70+
"Q-CTRL Open Controls can generate a driven control from a library of dynamically corrected gate schemes, mathematically defined in the [documentation](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/DynamicDecouplingSequence.html#). All dynamically corrected gates are derived from three quantities: \n",
7171
"\n",
7272
"* `rabi_rotation` the total rotation of the Bloch sphere,\n",
7373
"* `azimuthal_angle` the angle to the center point of the rotation on the equator,\n",
@@ -253,9 +253,9 @@
253253
"source": [
254254
"### Exporting a Driven Control\n",
255255
"\n",
256-
"Q-CTRL Open Controls enables exporting driven controls in CSV or JSON format. An exported driven control is [formatted](https://docs.q-ctrl.com/wiki/control-formats) to be compatible with [Q-CTRL BLACK OPAL](https://app.q-ctrl.com).\n",
256+
"Q-CTRL Open Controls enables exporting driven controls in CSV or JSON format. An exported driven control is formatted to be compatible with [Q-CTRL BLACK OPAL](https://app.q-ctrl.com).\n",
257257
"\n",
258-
"Q-CTRL Open Controls can export a driven control in either `cartesian` or `cylindrical` coordinates. For details, consult the [documentation](https://docs.q-ctrl.com/wiki/output-data-formats#q-ctrl-hardware).\n",
258+
"Q-CTRL Open Controls can export a driven control in either `cartesian` or `cylindrical` coordinates. For details, consult the [documentation](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/DrivenControl.export_to_file.html).\n",
259259
"\n",
260260
"In the example below, we chose the `bb1_x` control (created above) for exporting to a CSV file."
261261
]

examples/creating-a-dynamical-decoupling-sequence.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"9. `X concatenated`\n",
5959
"10. `XY concatenated`\n",
6060
"\n",
61-
"See the [documentation](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols.html) for details."
61+
"See the [documentation](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols.html) for details."
6262
]
6363
},
6464
{
@@ -67,9 +67,9 @@
6767
"source": [
6868
"## Creating and printing a DDS\n",
6969
"\n",
70-
"A DDS is defined as a set of instant unitary operations, each defined by a `rabi_rotation`, `azimuthal_angle`, `detuning_angle`, and `offset` (giving the time at which the operation is applied). The mathematical definition of a sequence is explained in the [documentation](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols.html#qctrlopencontrols.DynamicDecouplingSequence).\n",
70+
"A DDS is defined as a set of instant unitary operations, each defined by a `rabi_rotation`, `azimuthal_angle`, `detuning_angle`, and `offset` (giving the time at which the operation is applied). The mathematical definition of a sequence is explained in the [documentation](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/DynamicDecouplingSequence.html#qctrlopencontrols.DynamicDecouplingSequence).\n",
7171
"\n",
72-
"Q-CTRL Open controls provides a set of functions to generate commonly used DDSs. For each sequence, the detailed mathematical definition can be found in the [documentation](https://docs.q-ctrl.com/references/python/qctrl-open-controls/qctrlopencontrols.html#qctrlopencontrols).\n",
72+
"Q-CTRL Open controls provides a set of functions to generate commonly used DDSs. For each sequence, the detailed mathematical definition can be found in the [documentation](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols.html#qctrlopencontrols).\n",
7373
"Below we give a few examples of generating DDSs."
7474
]
7575
},
@@ -270,11 +270,11 @@
270270
"source": [
271271
"### Exporting the DDS\n",
272272
"\n",
273-
"Q-CTRL Open Controls enables exporting DDS in CSV or JSON format. An exported sequence is [formatted](https://docs.q-ctrl.com/wiki/control-formats) to be compatible with [Q-CTRL BLACK OPAL](https://app.q-ctrl.com).\n",
273+
"Q-CTRL Open Controls enables exporting DDS in CSV or JSON format. An exported sequence is formatted to be compatible with [Q-CTRL BLACK OPAL](https://app.q-ctrl.com).\n",
274274
"\n",
275275
"An ideal DDS is defined as a sequence of instantaneously-applied pulses, which correspond to instantaneous rotations of the Bloch sphere. However, in reality, the rate of rotation is limited by the `maximum_rabi_rate` and/or `maximum_detuning_rate` for a given pulse. Due to this limiting factor, the target rotation is implemented over a control segment with finite duration. Q-CTRL Open Controls converts a `DynamicDecouplingSequence` into a `DrivenControl` before exporting the resulting `DrivenControl`. This conversion requires the `maximum_rabi_rate` and `maximum_detuning_rate` to be specified and raises an error if the conversion is not successful (e.g. if control segments overlap due to a low `maximum_rabi_rate` or `maximum_detuning_rate`).\n",
276276
"\n",
277-
"Q-CTRL Open Controls can export a sequence in either `cartesian` or `cylindrical` coordinates. For details, consult the [documentation](https://docs.q-ctrl.com/wiki/output-data-formats#q-ctrl-hardware).\n",
277+
"Q-CTRL Open Controls can export a sequence in either `cartesian` or `cylindrical` coordinates. For details, consult the [documentation](https://docs.q-ctrl.com/open-controls/references/qctrl-open-controls/qctrlopencontrols/DrivenControl.export_to_file.html).\n",
278278
"\n",
279279
"In the example below, we chose the `quadratic_dds` (created above) for exporting to a CSV file."
280280
]

0 commit comments

Comments
 (0)