Skip to content

Commit 8bce6f7

Browse files
committed
fix: Improve mathematical notation formatting in predefined.py
1 parent 35778b7 commit 8bce6f7

File tree

2 files changed

+54
-27
lines changed

2 files changed

+54
-27
lines changed

qctrlopencontrols/driven_controls/predefined.py

Lines changed: 52 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -192,10 +192,14 @@ def new_bb1_control(
192192
.. csv-table::
193193
:header: :math:`\\delta t_n`, :math:`\\Omega_n`, :math:`\\phi_n` , :math:`\\Delta_n`
194194
195-
:math:`\theta/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi`, :math:`0`
196-
:math:`\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\phi_*`, :math:`0`
197-
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+3\phi_*`,:math:`0`
198-
:math:`\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\phi_*`, :math:`0`
195+
:math:`\theta/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
196+
:math:`\phi`, :math:`0`
197+
:math:`\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
198+
:math:`\phi+\phi_*`, :math:`0`
199+
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
200+
:math:`\phi+3\phi_*`,:math:`0`
201+
:math:`\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
202+
:math:`\phi+\phi_*`, :math:`0`
199203
200204
where
201205
@@ -273,9 +277,12 @@ def new_sk1_control(
273277
.. csv-table::
274278
:header: :math:`\\delta t_n`, :math:`\\Omega_n`, :math:`\\phi_n` , :math:`\\Delta_n`
275279
276-
:math:`\theta/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi`, :math:`0`
277-
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi-\phi_*`, :math:`0`
278-
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\phi_*`, :math:`0`
280+
:math:`\theta/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
281+
:math:`\phi`, :math:`0`
282+
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
283+
:math:`\phi-\phi_*`, :math:`0`
284+
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
285+
:math:`\phi+\phi_*`, :math:`0`
279286
280287
where
281288
@@ -352,17 +359,22 @@ def new_scrofulous_control(
352359
.. csv-table::
353360
:header: :math:`\\delta t_n`, :math:`\\Omega_n`, :math:`\\phi_n` , :math:`\\Delta_n`
354361
355-
:math:`\theta_1/\Omega_{\mathrm max}`, :math:`\Omega_\mathrm{max}`, :math:`\phi+\phi_1`, :math:`0`
356-
:math:`\theta_2/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\phi_2`, :math:`0`
357-
:math:`\theta_3/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\phi_3`, :math:`0`
362+
:math:`\theta_1/\Omega_{\mathrm max}`, :math:`\Omega_\mathrm{max}`,
363+
:math:`\phi+\phi_1`, :math:`0`
364+
:math:`\theta_2/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
365+
:math:`\phi+\phi_2`, :math:`0`
366+
:math:`\theta_3/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
367+
:math:`\phi+\phi_3`, :math:`0`
358368
359369
where
360370
361371
.. math::
362372
\begin{align}
363-
\theta_1 &= \theta_3 = \mathrm{sinc}^{-1} \left[\frac{2\cos (\theta/2)}{\pi}\right] \\
373+
\theta_1 &=
374+
\theta_3 = \mathrm{sinc}^{-1} \left[\frac{2\cos (\theta/2)}{\pi}\right] \\
364375
\theta_2 &= \pi \\
365-
\phi_1 &= \phi_3 = \cos^{-1}\left[ \frac{-\pi\cos(\theta_1)}{2\theta_1\sin(\theta/2)}\right] \\
376+
\phi_1 &=
377+
\phi_3 = \cos^{-1}\left[ \frac{-\pi\cos(\theta_1)}{2\theta_1\sin(\theta/2)}\right] \\
366378
\phi_2 &= \phi_1 - \cos^{-1} \left(-\frac{\pi}{2\theta_1}\right)
367379
\end{align}
368380
@@ -466,9 +478,12 @@ def new_corpse_control(
466478
.. csv-table::
467479
:header: :math:`\\delta t_n`, :math:`\\Omega_n`, :math:`\\phi_n` , :math:`\\Delta_n`
468480
469-
:math:`\theta_1/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi`, :math:`0`
470-
:math:`\theta_2/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\pi`, :math:`0`
471-
:math:`\theta_3/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi`, :math:`0`
481+
:math:`\theta_1/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
482+
:math:`\phi`, :math:`0`
483+
:math:`\theta_2/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
484+
:math:`\phi+\pi`, :math:`0`
485+
:math:`\theta_3/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
486+
:math:`\phi`, :math:`0`
472487
473488
where
474489
@@ -557,12 +572,18 @@ def new_corpse_in_bb1_control(
557572
.. csv-table::
558573
:header: :math:`\\delta t_n`, :math:`\\Omega_n`, :math:`\\phi_n` , :math:`\\Delta_n`
559574
560-
:math:`\theta_1/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi`, :math:`0`
561-
:math:`\theta_2/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\pi`, :math:`0`
562-
:math:`\theta_3/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi`, :math:`0`
563-
:math:`\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\phi_*`, :math:`0`
564-
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+3\phi_*`, :math:`0`
565-
:math:`\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\phi_*`, :math:`0`
575+
:math:`\theta_1/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
576+
:math:`\phi`, :math:`0`
577+
:math:`\theta_2/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
578+
:math:`\phi+\pi`, :math:`0`
579+
:math:`\theta_3/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
580+
:math:`\phi`, :math:`0`
581+
:math:`\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
582+
:math:`\phi+\phi_*`, :math:`0`
583+
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
584+
:math:`\phi+3\phi_*`, :math:`0`
585+
:math:`\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
586+
:math:`\phi+\phi_*`, :math:`0`
566587
567588
where
568589
@@ -663,11 +684,16 @@ def new_corpse_in_sk1_control(
663684
.. csv-table::
664685
:header: :math:`\\delta t_n`, :math:`\\Omega_n`, :math:`\\phi_n` , :math:`\\Delta_n`
665686
666-
:math:`\theta_1/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi`, :math:`0`
667-
:math:`\theta_2/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\pi`, :math:`0`
668-
:math:`\theta_3/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi`, :math:`0`
669-
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi-\phi_*`, :math:`0`
670-
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`, :math:`\phi+\phi_*`, :math:`0`
687+
:math:`\theta_1/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
688+
:math:`\phi`, :math:`0`
689+
:math:`\theta_2/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
690+
:math:`\phi+\pi`, :math:`0`
691+
:math:`\theta_3/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
692+
:math:`\phi`, :math:`0`
693+
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
694+
:math:`\phi-\phi_*`, :math:`0`
695+
:math:`2\pi/\Omega_{\mathrm max}`, :math:`\Omega_{\mathrm max}`,
696+
:math:`\phi+\phi_*`, :math:`0`
671697
672698
where
673699

qctrlopencontrols/dynamic_decoupling_sequences/predefined.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -614,7 +614,8 @@ def new_walsh_sequence(
614614
function [#]_, which is defined as
615615
616616
.. math::
617-
R_j(x) := {\mathrm sgn}\left[\sin(2^j \pi x)\right] \;, \quad\; x \in [0, 1]\;, \; j \geq 0 \;.
617+
R_j(x) := {\mathrm sgn}\left[\sin(2^j \pi x)\right] \;,
618+
\quad\; x \in [0, 1]\;, \; j \geq 0 \;.
618619
619620
The :math:`j`-th Rademacher function :math:`R_j(x)` is thus a periodic square wave switching
620621
:math:`2^{j-1}` times between :math:`\pm 1` over the interval :math:`[0, 1]`. The Walsh

0 commit comments

Comments
 (0)