Skip to content

[unitaryDESIGN] Visual Design of a Bosonic Qubit in Wigner Function Space#71

Open
ahkatlio wants to merge 22 commits intoharmoniqs:mainfrom
ahkatlio:wigner-function-visualization
Open

[unitaryDESIGN] Visual Design of a Bosonic Qubit in Wigner Function Space#71
ahkatlio wants to merge 22 commits intoharmoniqs:mainfrom
ahkatlio:wigner-function-visualization

Conversation

@ahkatlio
Copy link
Copy Markdown

closes #57
This pull request significantly enhances the visualization documentation and animation API for Piccolo.jl, with a focus on bosonic (continuous-variable) quantum systems and improved user guidance. The main changes include the addition of a comprehensive Wigner function visualization guide, expanded quick-start and usage tips for plotting and animation, and detailed docstrings and examples for animation functions. It also updates documentation dependencies to support these new features.

Documentation and Guides:

  • Added a detailed guide wigner_bosonic_qubits.jl covering Wigner function visualization for bosonic quantum states, including coherent, Fock, and cat states, comparison panels, 3D plots, animations, and integration with the CatSystem template. This is now included in the docs navigation. [1] [2]

Copy link
Copy Markdown
Member

@jack-champagne jack-champagne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ahkatlio! It looks like your changes from the #66 are on this as well. If you can make a branch for each that isolates the changes that each pull request is making that would be great!

Comment thread docs/literate/guides/visualization.jl Outdated
# To save animation to file instead:

# using CairoMakie
# fig = animate_name(traj, :u; mode=:record, filename="controls.mp4", fps=24)

This comment was marked as outdated.

Comment thread docs/literate/guides/visualization.jl Outdated

# To save animation to file:
# using CairoMakie
# fig = animate_bloch(traj_ket; mode=:record, filename="bloch_animation.mp4", fps=24)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and this one

Copy link
Copy Markdown
Member

@jack-champagne jack-champagne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

~The checks don't worry about - just needs to be auto formatted before it gets merged. I think the only thing left outstanding are the comments I left on these two lines (I noted them again in the new diff)

https://github.com/harmoniqs/Piccolo.jl/pull/71/changes#r2862149540
https://github.com/harmoniqs/Piccolo.jl/pull/71/changes#r2862150500

I left some details in this comment from earlier last week (sorry I didn't get back to you sooner!): #66 (comment)

Let me know if you have any questions!~

Edit: this comment was meant for your other pull request - #66 (comment). My comment above is the one that applies so that I can review your work:
#71 (review)

@ahkatlio
Copy link
Copy Markdown
Author

Hello @jack-champagne, I updated the visualization guide to clarify the difference between interactive animations using GLMakie and saving animations to file with CairoMakie. The comments now explicitly mention that CairoMakie requires mode=:record for file output, which should help users understand when to use each backend. This addresses the confusion around why some animation examples show using GLMakie while the file-saving examples use using CairoMakie - they're doing fundamentally different things (display vs. save).

@jack-champagne
Copy link
Copy Markdown
Member

Hey @ahkatlio, please refer to my comments in #71 (review) and #71 (review)

I made a mistake and left comments on the wrong pull request, please seperate your changes onto seperate branches so that I can review

Comment thread docs/literate/guides/visualization.jl Outdated
Comment thread docs/literate/guides/visualization.jl Outdated
Comment thread docs/literate/guides/visualization.jl Outdated
Comment thread docs/literate/guides/visualization.jl Outdated
Comment thread docs/literate/guides/visualization.jl Outdated
@jack-champagne
Copy link
Copy Markdown
Member

Hey @ahkatlio! It looks like your changes from the #66 are on this as well. If you can make a branch for each that isolates the changes that each pull request is making that would be great!

Hi @ahkatlio, it looks like this comment still applies to your branch - please split out your changes, thx!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[unitaryDESIGN] Visual Design of a Bosonic Qubit in Wigner Function Space

2 participants