fix incorrect rendering for Bloch in docs

Author: ytdHuang

Project.toml

@@ -12,6 +12,7 @@ Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 IncompleteLU = "40713840-3770-5561-ab4c-a76e7d0d7895"
+LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 LinearSolve = "7ed4a6bd-45f5-4d41-b270-4a48e9bafcae"
 OrdinaryDiffEqCore = "bbf590c4-e513-4bbe-9b18-05decba2e5d8"
@@ -51,6 +52,7 @@ GPUArrays = "10, 11"
 Graphs = "1.7"
 IncompleteLU = "0.2"
 KernelAbstractions = "0.9.2"
+LaTeXStrings = "1.2"
 LinearAlgebra = "1"
 LinearSolve = "2, 3"
 Makie = "0.20, 0.21, 0.22"

docs/src/users_guide/plotting_the_bloch_sphere.md

@@ -188,12 +188,12 @@ At the end of the last section we saw that the colors and marker shapes of the d
 | `b.vector_width` | Width of vectors | `0.025` |
 | `b.vector_arrowsize` | Arrow size parameters as (head length, head width, stem width) | `(0.07, 0.08, 0.08)` |
 | `b.view` | Azimuthal and elevation viewing angles in degrees | `(-60, 30)` |
-| `b.xlabel` | Labels for x-axis | `[L"x", ""]` |
-| `b.xlpos` | Positions of x-axis labels | `[1.0, -1.0]` |
-| `b.ylabel` | Labels for y-axis | `[L"y", ""]` |
-| `b.ylpos` | Positions of y-axis labels | `[1.0, -1.0]` |
-| `b.zlabel` | Labels for z-axis | `[1.0, -1.0]` |
-| `b.zlpos` | Positions of z-axis labels | `[L"\|0\rangle", L"\|1\rangle"]` |
+| `b.xlabel` | Labels for x-axis | `(L"x", "")` |
+| `b.xlpos` | Positions of x-axis labels | `(1.0, -1.0)` |
+| `b.ylabel` | Labels for y-axis | `(L"y", "")` |
+| `b.ylpos` | Positions of y-axis labels | `(1.0, -1.0)` |
+| `b.zlabel` | Labels for z-axis | `(L"\|0\rangle", L"\|1\rangle)"` |
+| `b.zlpos` | Positions of z-axis labels | `(1.0, -1.0)` |
 
 These properties can also be accessed via the `print` command:
 

ext/QuantumToolboxMakieExt.jl

@@ -663,60 +663,60 @@ function _add_labels!(b::Bloch, ax)
     label_color = parse(RGBf, b.font_color)
     label_size = b.font_size
     offset_scale = b.frame_limit
-    if !isempty(b.xlabel) && !isempty(b.xlabel[1])
+    if b.xlabel[1] != ""
         text!(
             ax,
-            L"\textbf{x}",
+            b.xlabel[1],
             position = Point3f(0, -offset_scale * b.xlpos[1], 0),
             color = label_color,
             fontsize = label_size,
             align = (:center, :center),
         )
     end
-    if length(b.xlabel) > 1 && !isempty(b.xlabel[2])
+    if b.xlabel[2] != ""
         text!(
             ax,
-            L"\textbf{-x}",
+            b.xlabel[2],
             position = Point3f(0, -offset_scale * b.xlpos[2], 0),
             color = label_color,
             fontsize = label_size,
             align = (:center, :center),
         )
     end
-    if !isempty(b.ylabel) && !isempty(b.ylabel[1])
+    if b.ylabel[1] != ""
         text!(
             ax,
-            L"\textbf{y}",
+            b.ylabel[1],
             position = Point3f(offset_scale * b.ylpos[1], 0, 0),
             color = label_color,
             fontsize = label_size,
             align = (:center, :center),
         )
     end
-    if length(b.ylabel) > 1 && !isempty(b.ylabel[2])
+    if b.ylabel[2] != ""
         text!(
             ax,
-            L"\textbf{-y}",
+            b.ylabel[2],
             position = Point3f(offset_scale * b.ylpos[2], 0, 0),
             color = label_color,
             fontsize = label_size,
             align = (:center, :center),
         )
     end
-    if !isempty(b.zlabel) && !isempty(b.zlabel[1])
+    if b.zlabel[1] != ""
         text!(
             ax,
-            L"\mathbf{|0\rangle}",
+            b.zlabel[1],
             position = Point3f(0, 0, offset_scale * b.zlpos[1]),
             color = label_color,
             fontsize = label_size,
             align = (:center, :center),
         )
     end
-    if length(b.zlabel) > 1 && !isempty(b.zlabel[2])
+    if b.zlabel[2] != ""
         text!(
             ax,
-            L"\mathbf{|1\rangle}",
+            b.zlabel[2],
             position = Point3f(0, 0, offset_scale * b.zlpos[2]),
             color = label_color,
             fontsize = label_size,

src/visualization.jl

@@ -80,7 +80,7 @@ A structure representing a Bloch sphere visualization for quantum states.
 ## Style properties
 
 - `font_color::String`: Color of axis labels and text
-- `font_size::Int`: Font size for labels (default: 15)
+- `font_size::Int`: Font size for labels. Default: `15`
 - `frame_alpha::Float64`: Transparency of the frame background
 - `frame_color::String`: Background color of the frame
 - `frame_limit::Float64`: Axis limits for the 3D frame (symmetric around origin)
@@ -89,15 +89,15 @@ A structure representing a Bloch sphere visualization for quantum states.
 
 - `point_default_color::Vector{String}}`: Default color cycle for points
 - `point_color::Vector{String}}`: List of colors for Bloch point markers to cycle through
-- `point_marker::Vector{Symbol}}`: List of point marker shapes to cycle through (default: [:circle, :rect, :diamond, :utriangle])
+- `point_marker::Vector{Symbol}}`: List of point marker shapes to cycle through. Default: `[:circle, :rect, :diamond, :utriangle]`
 - `point_size::Vector{Int}}`: List of point marker sizes (not all markers look the same size when plotted)
 - `point_style::Vector{Symbol}}`: List of marker styles
 - `point_alpha::Vector{Float64}}`: List of marker transparencies
 
 ## Sphere properties
 
 - `sphere_color::String`: Color of Bloch sphere surface
-- `sphere_alpha::Float64`: Transparency of sphere surface (default: 0.2)
+- `sphere_alpha::Float64`: Transparency of sphere surface. Default: `0.2`
 
 # Vector properties
 
@@ -107,15 +107,15 @@ A structure representing a Bloch sphere visualization for quantum states.
 
 ## Layout properties
 
-- `view::Tuple{Int,Int}}`: Azimuthal and elevation viewing angles in degrees (default: (-60, 30))
+- `view::Tuple{Int,Int}}`: Azimuthal and elevation viewing angles in degrees. Default: `(-60, 30)`
 
 ## Label properties
-- `xlabel::Vector{String}}`: Labels for x-axis (default: [raw"$x$", ""])
-- `xlpos::Vector{Float64}}`: Positions of x-axis labels (default: [1.0, -1.0])
-- `ylabel::Vector{String}}`: Labels for y-axis (default: [raw"$y$", ""])
-- `ylpos::Vector{Float64}}`: Positions of y-axis labels (default: [1.0, -1.0])
-- `zlabel::Vector{String}}`: Labels for z-axis (default: [raw"$|0\rangle$", raw"$|1\rangle$"])
-- `zlpos::Vector{Float64}}`: Positions of z-axis labels (default: [1.0, -1.0])
+- `xlabel::Tuple{AbstractString,AbstractString}`: Labels for x-axis. Default: `(L"x", "")`
+- `xlpos::Tuple{Float64,Float64}`: Positions of x-axis labels. Default: `(1.0, -1.0)`
+- `ylabel::Tuple{AbstractString,AbstractString}`: Labels for y-axis. Default: `(L"y", "")`
+- `ylpos::Tuple{Float64,Float64}`: Positions of y-axis labels. Default: `(1.0, -1.0)`
+- `zlabel::Tuple{AbstractString,AbstractString}`: Labels for z-axis. Default: `(L"|0\rangle", L"|1\rangle")`
+- `zlpos::Tuple{Float64,Float64}`: Positions of z-axis labels. Default: `(1.0, -1.0)`
 """
 @kwdef mutable struct Bloch
     points::Vector{Matrix{Float64}} = Vector{Matrix{Float64}}()
@@ -139,12 +139,12 @@ A structure representing a Bloch sphere visualization for quantum states.
     vector_width::Float64 = 0.025
     vector_arrowsize::NTuple{3,Real} = (0.07, 0.08, 0.08)
     view::Tuple{Int,Int} = (-60, 30)
-    xlabel::Vector{String} = [raw"$x$", raw""]
-    xlpos::Vector{Float64} = [1.0, -1.0]
-    ylabel::Vector{String} = [raw"$y$", ""]
-    ylpos::Vector{Float64} = [1.0, -1.0]
-    zlabel::Vector{String} = [raw"$|0\rangle$", raw"$|1\rangle$"]
-    zlpos::Vector{Float64} = [1.0, -1.0]
+    xlabel::Tuple{AbstractString,AbstractString} = (L"x", "")
+    xlpos::Tuple{Float64,Float64} = (1.0, -1.0)
+    ylabel::Tuple{AbstractString,AbstractString} = (L"y", "")
+    ylpos::Tuple{Float64,Float64} = (1.0, -1.0)
+    zlabel::Tuple{AbstractString,AbstractString} = (L"|0\rangle", L"|1\rangle")
+    zlpos::Tuple{Float64,Float64} = (1.0, -1.0)
 end
 
 const BLOCH_DATA_FIELDS = (:points, :vectors, :lines, :arcs)