add codereview suggestions

Author: Fe-r-oz

ext/QuantumToolboxMakieExt.jl

@@ -446,6 +446,15 @@ Add one or more quantum states to the Bloch sphere visualization by converting t
 - `b::Bloch`: The Bloch sphere object to modify
 - `states::QuantumObject...`: One or more quantum states (Ket, Bra, or Operator)
 
+# Example
+
+```julia
+x = basis(2, 0) + basis(2, 1);
+y = basis(2, 0) - im * basis(2, 1);
+z = basis(2, 0);
+b = Bloch();
+add_states!(b, [x, y, z])
+```
 """
 function QuantumToolbox.add_states!(b::Bloch, states::Vector{<:QuantumObject})
     vecs = map(states) do state
@@ -596,7 +605,7 @@ function _draw_axes(ax)
     axes = [
         ([Point3f(0, -1.01, 0), Point3f(0, 1.01, 0)], "y"),  # Y-axis
         ([Point3f(-1.01, 0, 0), Point3f(1.01, 0, 0)], "x"),  # X-axis
-        ([Point3f(0, 0, -1.01), Point3f(0, 0, 1.01)], "z"),   # Z-axis
+        ([Point3f(0, 0, -1.01), Point3f(0, 0, 1.01)], "z"),  # Z-axis
     ]
     for (points, _) in axes
         lines!(ax, points; color = axis_color, linewidth = axis_width)
@@ -724,7 +733,7 @@ function _plot_vectors(b::Bloch, ax)
         color = get(b.vector_color, i, RGBAf(0.2, 0.5, 0.8, 0.9))
         vec = Vec3f(v[2], -v[1], v[3])
         length = norm(vec)
-        max_length = r * 0.85
+        max_length = r * 0.90
         vec = length > max_length ? (vec/length) * max_length : vec
         arrows!(
             ax,
@@ -754,10 +763,10 @@ function _add_labels(ax)
     label_font = "TeX Gyre Heros"
 
     labels = [
-        (Point3f(1.04, 0, 0), "y"),
-        (Point3f(0, -1.10, 0), "x"),
-        (Point3f(0, 0, -1.10), "|1⟩"),
-        (Point3f(0, 0, 1.08), "|0⟩"),
+        (Point3f(1.04, 0, 0), L"\textbf{y}"),
+        (Point3f(0, -1.10, 0), L"\textbf{x}"),
+        (Point3f(0, 0, -1.10), L"\mathbf{|1\rangle}"),
+        (Point3f(0, 0, 1.08), L"\mathbf{|0\rangle}"),
     ]
     for (pos, text) in labels
         text!(ax, text; position = pos, color = label_color, fontsize = label_size, font = label_font)

src/visualization.jl

@@ -89,42 +89,42 @@ A structure representing a Bloch sphere visualization for quantum states."""
     arcs::Vector{Vector{Vector{Float64}}} = Vector{Vector{Vector{Float64}}}()
 
     # Style properties
-    """Color of axis labels and text (default: '#2E3440')"""
+    """Color of axis labels and text"""
     font_color::String = "#2E3440"
     """Font size for labels (default: 18)"""
     font_size::Int = 18
-    """Transparency of wireframe (default: 0.1)"""
+    """Transparency of wireframe"""
     frame_alpha::Float64 = 0.1
-    """Color of wireframe (default: '#E5E9F')"""
+    """Color of wireframe"""
     frame_color::String = "#E5E9F0"
-    """ Width of wireframe lines (default: 1)"""
+    """ Width of wireframe lines"""
     frame_width::Int = 1
 
     # Point properties
-    """Default color cycle for points (default: ["blue", "red", "green", "orange"])"""
-    point_default_color::Vector{String} = ["blue", "red", "green", "orange"]
-    """Colors for point markers (default: ["blue", "red", "green", "orange"])"""
-    point_color::Vector{String} = ["blue", "red", "green", "orange"]
+    """Default color cycle for points"""
+    point_default_color::Vector{String} = ["blue", "red", "green", "orange", "cyan", "magenta", "yellow", "black"]
+    """Colors for point markers"""
+    point_color::Vector{String} = ["blue", "red", "green", "orange", "cyan", "magenta", "yellow", "black"]
     """Marker shapes (default: [:circle, :rect, :diamond, :utriangle])"""
     point_marker::Vector{Symbol} = [:circle, :rect, :diamond, :utriangle]
-    """Marker sizes (default: [40, 48, 50, 60])"""
+    """Marker sizes"""
     point_size::Vector{Int} = [40, 48, 50, 60]
-    """Marker styles (default: Symbol[])"""
+    """Marker styles"""
     point_style::Vector{Symbol} = Symbol[]
-    """Marker transparencies (default: Float64[])"""
+    """Marker transparencies"""
     point_alpha::Vector{Float64} = Float64[]
 
     # Sphere properties
-    """Transparency of Bloch sphere surface (default: 0.8)"""
-    sphere_alpha::Float64 = 0.8
-    """Color of Bloch sphere surface (default: '#ECEFF4')"""
+    """Transparency of Bloch sphere surface"""
+    sphere_alpha::Float64 = 0.9
+    """Color of Bloch sphere surface"""
     sphere_color::String = "#ECEFF4"
 
     # Layout properties
-    """Figure size in pixels (default: (1000, 1000))"""
-    size::Tuple{Int,Int} = (1000, 1000)
-    """Colors for vectors (default: ["green", "blue", "orange"])"""
-    vector_color::Vector{String} = ["green", "blue", "orange"]
+    """Figure size in pixels"""
+    size::Tuple{Int,Int} = (700, 700)
+    """Colors for vectors"""
+    vector_color::Vector{String} = ["green", "blue", "orange", "red", "cyan", "magenta", "yellow", "black"]
     """Width of vectors (default: 2)"""
     vector_width::Int = 2
     """Azimuthal and elevation viewing angles in degrees (default: (-60, 30))"""
@@ -133,15 +133,15 @@ A structure representing a Bloch sphere visualization for quantum states."""
     # Label properties
     """Labels for x-axis (default: ["x", ""])"""
     xlabel::Vector{String} = ["x", ""]
-    """Positions of x-axis labels (default: [1.2, -1.2])"""
+    """Positions of x-axis labels"""
     xlpos::Vector{Float64} = [1.2, -1.2]
     """Labels for y-axis (default: ["y", ""])"""
     ylabel::Vector{String} = ["y", ""]
-    """Positions of y-axis labels (default: [1.2, -1.2])"""
+    """Positions of y-axis labels)"""
     ylpos::Vector{Float64} = [1.2, -1.2]
     """Labels for z-axis (default: ["|0⟩", "|1⟩"])"""
     zlabel::Vector{String} = ["|0⟩", "|1⟩"]
-    """Positions of z-axis labels (default: [1.2, -1.2])"""
+    """Positions of z-axis labels"""
     zlpos::Vector{Float64} = [1.2, -1.2]
 end
 
@@ -241,16 +241,6 @@ Add a line between two points on the Bloch sphere.
 - p2::Vector{<:Real}: Second 3D point
 - fmt="k": Line format string (matplotlib style)
 - kwargs...: Additional line properties
-
-# Examples
-
-```jldoctest
-julia> b = Bloch();
-
-julia> add_line!(b, [1, 0, 0], [0, 1, 0])
-1-element Vector{Tuple{Vector{Vector{Float64}}, String, Dict{Any, Any}}}:
- ([[0.0, 1.0], [-1.0, 0.0], [0.0, 0.0]], "k", Dict())
-```
 """
 function add_line!(b::Bloch, p1::Vector{<:Real}, p2::Vector{<:Real}; fmt = "k", kwargs...)
     if length(p1) != 3 || length(p2) != 3

test/ext-test/cpu/makie/makie_ext.jl

@@ -120,7 +120,6 @@
     @test isempty(b.vectors)
     @test isempty(b.lines)
     @test isempty(b.arcs)
-
     b = Bloch()
     add_points!(b, hcat([1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [0.0, 0.0, 1.0]))
     add_vectors!(b, [[1, 1, 0], [0, 1, 1]])
@@ -134,4 +133,40 @@
         @test false
         @info "Render threw unexpected error" exception=e
     end
+    b = Bloch()
+    ψ₁ = normalize(basis(2, 0) + basis(2, 1))
+    ψ₂ = normalize(basis(2, 0) - im * basis(2, 1))
+    add_line!(b, ψ₁, ψ₂; fmt = "r--")
+    try
+        fig, ax = QuantumToolbox.render(b)
+        @test !isnothing(fig)
+        @test !isnothing(ax)
+    catch e
+        @test false
+        @info "Render threw unexpected error" exception=e
+    end
+    b = Bloch()
+    x = basis(2, 0) + basis(2, 1)
+    y = basis(2, 0) - im * basis(2, 1)
+    z = basis(2, 0)
+    add_states!(b, [x, y, z])
+    th = range(0, 2π; length=20);
+    xp = cos.(th);
+    yp = sin.(th);
+    zp = zeros(20);
+    pnts = [xp, yp, zp] ;
+    pnts = Matrix(hcat(xp, yp, zp)');
+    add_points!(b, pnts);
+    vec = [[1, 0, 0], [0, 1, 0], [0, 0, 1]];
+    add_vectors!(b, vec);
+    add_line!(b, [1,0,0], [0,1,0])
+    add_arc!(b, [1, 0, 0], [0, 1, 0], [0, 0, 1])
+    try
+        fig, ax = QuantumToolbox.render(b)
+        @test !isnothing(fig)
+        @test !isnothing(ax)
+    catch e
+        @test false
+        @info "Render threw unexpected error" exception=e
+    end
 end