Use LScene instead of Axis3 for Bloch Sphere #485

albertomercurio · 2025-06-08T10:48:38Z

Checklist

Thank you for contributing to QuantumToolbox.jl! Please make sure you have finished the following tasks before opening the PR.

Please read Contributing to Quantum Toolbox in Julia.
Any code changes were done in a way that does not break public API.
Appropriate tests were added and tested locally by running: make test.
Any code changes should be julia formatted by running: make format.
All documents (in docs/ folder) related to code changes were updated and able to build locally by running: make docs.
(If necessary) the CHANGELOG.md should be updated (regarding to the code changes) and built by running: make changelog.

Request for a review after you have completed all the tasks. If you have not finished them all, you can also open a Draft Pull Request to let the others know this on-going work.

Description

use LScene instead of Axis3 for Bloch Sphere rendering, in order to have more freedom.

codecov · 2025-06-08T11:04:43Z

Codecov Report

Attention: Patch coverage is 97.77778% with 1 line in your changes missing coverage. Please review.

Project coverage is 93.97%. Comparing base (826a03d) to head (5e226f5).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
ext/QuantumToolboxMakieExt.jl	97.77%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #485      +/-   ##
==========================================
- Coverage   93.98%   93.97%   -0.02%     
==========================================
  Files          50       50              
  Lines        3424     3418       -6     
==========================================
- Hits         3218     3212       -6     
  Misses        206      206

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ytdHuang

Here are some parameter changes that make the sphere looks more similar with the one in qutip.

Also, can you change the default value of Bloch.font_size to 20 (remember to also change the docstring and the table in documentation) ?
Since our sphere becomes larger, I think font size 20 suites the new size of the sphere.

CHANGELOG.md

ext/QuantumToolboxMakieExt.jl

ytdHuang · 2025-06-08T14:38:40Z

ext/QuantumToolboxMakieExt.jl

-    for (points, _) in axes
-        lines!(ax, points; color = axis_color, linewidth = axis_width)
+    for points in axes
+        lines!(lscene, points; color = axis_color)


How about

Suggested change

lines!(lscene, points; color = axis_color)

lines!(lscene, points; color = b.frame_color)

so that we don't need to define axis_color

ytdHuang · 2025-06-08T14:39:10Z

ext/QuantumToolboxMakieExt.jl

    ]
    for circle in circles
-        lines!(ax, circle; color = wire_color, linewidth = 1.0)
+        lines!(lscene, circle; color = wire_color, linewidth = 1.0)


How about

Suggested change

lines!(lscene, circle; color = wire_color, linewidth = 1.0)

lines!(lscene, circle; color = b.frame_color, linewidth = 1.0)

so that we don't need to define wire_color

ytdHuang · 2025-06-08T14:39:35Z

ext/QuantumToolboxMakieExt.jl

+    # XY, XZ circles
    circles = [
        [Point3f(cos(φi), sin(φi), 0) for φi in φ],  # XY
-        [Point3f(0, cos(φi), sin(φi)) for φi in φ],  # YZ
        [Point3f(cos(φi), 0, sin(φi)) for φi in φ],  # XZ


Although qutip doesn't draw the YZ plane circle.

I think it is better to display the three main circles together.

ytdHuang · 2025-06-08T14:52:18Z

ext/QuantumToolboxMakieExt.jl

        t_range = range(0, θ, length = 100)
        arc_points = [Point3f((v1 * cos(t) + cross(n, v1) * sin(t))) for t in t_range]
-        lines!(ax, arc_points; color = RGBAf(0.8, 0.4, 0.1, 0.9), linewidth = 2.0, linestyle = :solid)
+        lines!(lscene, arc_points; color = RGBAf(0.8, 0.4, 0.1, 0.9), linewidth = 2.0, linestyle = :solid)


Not sure whether we should handle the color here like the way in _plot_lines! or not...

But that means we need to add the fmt into Bloch.arcs field...

can think about it in the future

ytdHuang · 2025-06-08T15:52:44Z

ext/QuantumToolboxMakieExt.jl

-    _draw_reference_circles!(ax)
+    _draw_reference_circles!(b::Bloch, lscene)

-Draw the three great circles `(XY, YZ, XZ planes)` on the Bloch sphere.


I think it is better to keep YZ plane

ytdHuang · 2025-06-08T15:55:03Z

ext/QuantumToolboxMakieExt.jl

+        transparency = true,
+        rasterize = 3,
+    )
+    θ_vals = range(0, π, 5)[1:(end-1)]


We only need to draw pi/4, 3*pi/4.
The 0 and 2*pi/4 cases will be handled by _draw_reference_circles! (XZ- and YZ-plane)

Suggested change

θ_vals = range(0, π, 5)[1:(end-1)]

# curves of longitude

θ_vals = [1, 3] * π / 4

(better to add the comment, make it more easier to follow in the future)

ytdHuang · 2025-06-08T15:56:43Z

ext/QuantumToolboxMakieExt.jl

    end
-    φ_vals = range(0.0f0, π, length = n_lat + 2)
-    θ_curve = range(0.0f0, 2π, length = 600)
+    φ_vals = range(0, π, 6)


We only need to draw pi/4, 3*pi/4.
The 0 and pi cases are just north and south poles (no need to draw).
The pi/2 case will be handled by _draw_reference_circles! (YZ-plane)

Suggested change

φ_vals = range(0, π, 6)

# curves of latitude

φ_vals = [1, 3] * π / 4

(better to add the comment, make it more easier to follow in the future)

ext/QuantumToolboxMakieExt.jl

ytdHuang

I will do the above minor changes in another PR

albertomercurio added 3 commits June 8, 2025 12:47

Use LScene instead of Axis3 for Bloch Sphere

a3ea9c0

Make changelog

4e91089

Format code

921cce9

albertomercurio marked this pull request as ready for review June 8, 2025 10:50

albertomercurio requested a review from ytdHuang June 8, 2025 10:50

fix wigner axis3

653acb6

Fix tests

080aa6f

ytdHuang reviewed Jun 8, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

ext/QuantumToolboxMakieExt.jl Outdated Show resolved Hide resolved

ext/QuantumToolboxMakieExt.jl Outdated Show resolved Hide resolved

ytdHuang mentioned this pull request Jun 8, 2025

Display Figure changes the Camera3D and color in LScene.scene MakieOrg/Makie.jl#5042

Closed

Update changelog and adjust camera position

4c54a89

ytdHuang reviewed Jun 8, 2025

View reviewed changes

ext/QuantumToolboxMakieExt.jl Outdated Show resolved Hide resolved

albertomercurio added 2 commits June 8, 2025 16:21

Align with qutip

b670f9c

Make camera distance explicit

30c2ead

ytdHuang reviewed Jun 8, 2025

View reviewed changes

ext/QuantumToolboxMakieExt.jl Show resolved Hide resolved

Merge branch 'main' into dev/patch-3

5e226f5

ytdHuang approved these changes Jun 9, 2025

View reviewed changes

ytdHuang merged commit 22efb11 into qutip:main Jun 9, 2025
14 of 16 checks passed

	lines!(lscene, points; color = axis_color)
	lines!(lscene, points; color = b.frame_color)

	lines!(lscene, circle; color = wire_color, linewidth = 1.0)
	lines!(lscene, circle; color = b.frame_color, linewidth = 1.0)

	θ_vals = range(0, π, 5)[1:(end-1)]
	# curves of longitude
	θ_vals = [1, 3] * π / 4

	φ_vals = range(0, π, 6)
	# curves of latitude
	φ_vals = [1, 3] * π / 4

Use LScene instead of Axis3 for Bloch Sphere #485

Use LScene instead of Axis3 for Bloch Sphere #485

Uh oh!

Conversation

albertomercurio commented Jun 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Description

Uh oh!

codecov bot commented Jun 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ytdHuang left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ytdHuang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

albertomercurio commented Jun 8, 2025 •

edited

Loading

codecov bot commented Jun 8, 2025 •

edited

Loading

ytdHuang left a comment •

edited

Loading