Blochsphere Visualization #1763

prateekchawla168 · 2024-06-05T12:53:46Z

Description

Fixes #1639 by adding a visualization for Bloch sphere for single-qubit states.
Significant changes:

Added QuTiP as an optional dependency in pyproject.toml
Added bloch_visualize module in python/cudaq/visualization with code to handle Bloch sphere generation and management. Docstrings are contained within the code itself. Tested with Jupyter notebooks.
Modified Python initialization init.py to import QuTiP, and if successful, load the visualization functionality.
REST server cannot be built on Singularity containers because CMake is never able to find ZLib/Minizip, especially if the program must search manually. Corrected the corresponding CmakeLists.txt so it searches in the correct places.

This is a submission for Unitary Hack 2024.

I have read the Contributor License Agreement and I hereby accept the Terms.

copy-pr-bot · 2024-06-05T12:53:50Z

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

github-actions · 2024-06-05T12:54:04Z

CLA Assistant Lite bot All Contributors have signed the CLA.

prateekchawla168 · 2024-06-05T13:08:48Z

I have read the Contributor License Agreement and I hereby accept the Terms.

prateekchawla168 · 2024-06-05T13:08:56Z

recheck

khalatepradnya

Thank you for the contribution. This is looking good.
Recommend the following enhancements for completeness:

Please add a unit test that can check the newly added APIs. You can add to existing suite in this file - https://github.com/NVIDIA/cuda-quantum/blob/main/python/tests/kernel/test_kernel_features.py
Add a notebook example to showcase the functionality. You can edit this - https://github.com/NVIDIA/cuda-quantum/blob/main/docs/sphinx/examples/python/tutorials/quantum_bits.ipynb. (It currently has an image of Bloch sphere.)

pyproject.toml

python/cudaq/__init__.py

khalatepradnya · 2024-06-05T17:31:30Z

Can you add screenshots to this PR of how the output will look like for - (a) one Bloch sphere, (b) side by side rendering of multiple Bloch spheres?

khalatepradnya · 2024-06-05T17:37:54Z

For CI failures:

Add license header to the new file python/cudaq/visualization/bloch_visualize.py
For python formatting run yapf. First install it pip install yapf and then run with yapf --style google --recursive -i <filename>
Run the spell checker script and update accordingly.

prateekchawla168 · 2024-06-06T10:44:48Z

Added functionality in the latest commit:

Added a separate dependency in pyproject.toml for qutip, and removed it from chemistry.
Added minor comment on how to install qutip in Python init.py.
Minor bugfix in bloch_visualize. When a single-qubit state vector is passed to the function, the $\ell_2$-norm was not evaluated properly.
Added tests for visualization files in python/tests/visualization.
Added examples for visualization of Bloch sphere code in quantum_bits.ipynb

prateekchawla168 · 2024-06-06T10:47:12Z

Screenshots for Visualisation on Bloch sphere:

python/cudaq/__init__.py

prateekchawla168 · 2024-06-06T13:10:28Z

Implemented @amccaskey 's suggestion: If import qutip fails, then a helpful error message is printed to the screen whenever the user attempts to call any of the visualization functions.

khalatepradnya · 2024-06-06T16:08:31Z

Thanks for the updates and addressing review comments.
Can you fix the 2 CI failures (code formatting, and spell check)?

freifrauvonbleifrei · 2024-06-07T01:08:04Z

Hi, a comment from my work on #1723 : I am introducing a folder python/cudaq/display/ which semantically looks similar to your python/cudaq/visualization/. Maybe we could coordinate on a joint folder name.

prateekchawla168 · 2024-06-07T09:30:14Z

@freifrauvonbleifrei Absolutely! I had used the name visualization simply because I meant to put in multiple files there, as I had planned to work on the $\LaTeX$ rendering next, but it seems like you've got it handled already, which is awesome!

Fixed docstrings in python/cudaq/visualization/bloch_visualize.py

khalatepradnya

Thanks for the updates. Requesting changes on spell check.

.github/workflows/config/spelling_allowlist.txt

python/tests/visualization/test_bloch_sphere_visualization.py

docs/sphinx/examples/python/tutorials/quantum_bits.ipynb

python/tests/visualization/test_bloch_sphere_visualization.py

freifrauvonbleifrei · 2024-06-10T02:18:38Z

@freifrauvonbleifrei Absolutely! I had used the name visualization simply because I meant to put in multiple files there, as I had planned to work on the LATEX rendering next, but it seems like you've got it handled already, which is awesome!

@prateekchawla168 I had chosen display instead of visualize because the amount of data shown is rather limited (both for the circuits and the bloch sphere), which better suits the notion of display. If you agree with the naming, feel free to rename your folder to avoid merge conflicts further upstream :)

python/cudaq/visualization/bloch_visualize.py

khalatepradnya

Thank you for the contribution.
One open Q in comments.
CI failure will be addressed separately (see 6328008)

khalatepradnya · 2024-06-17T01:31:09Z

/ok to test

Command Bot: Processing...

github-actions · 2024-06-17T02:20:45Z

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

khalatepradnya · 2024-06-17T15:47:49Z

/ok to test

Command Bot: Processing...

github-actions · 2024-06-17T16:44:49Z

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

khalatepradnya · 2024-06-18T15:00:22Z

@prateekchawla168: Please add a comment on the issue #1639 so it can be assigned to you.

khalatepradnya · 2024-06-18T15:00:45Z

/ok to test

Command Bot: Processing...

github-actions · 2024-06-18T15:56:06Z

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

image so that it available to run the new functionality out-of-the-box. Also addresses the CI failure on notebook validation.

khalatepradnya · 2024-06-18T18:54:02Z

/ok to test

Command Bot: Processing...

-- updated toml file to reflect qutip<5 -- updated notebook to use default target (optionally set 'density-matrix-cpu') -- removed redundant comments and fixed one occurence of 'CUDA-Q'

khalatepradnya · 2024-06-18T19:08:46Z

/ok to test

Command Bot: Processing...

github-actions · 2024-06-18T19:57:02Z

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

Prateek Chawla added 2 commits June 5, 2024 15:29

Added bloch sphere visualization

7670091

made cmake less verbose in pyproject.toml

9d72007

cuda-quantum-bot added a commit that referenced this pull request Jun 5, 2024

@prateekchawla168 has signed the CLA from Pull Request #1763

cdcd4ef

khalatepradnya reviewed Jun 5, 2024

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

python/cudaq/__init__.py Outdated Show resolved Hide resolved

add visualization tests, dependencies and header

f83d4e2

prateekchawla168 requested a review from khalatepradnya June 6, 2024 10:47

amccaskey reviewed Jun 6, 2024

View reviewed changes

python/cudaq/__init__.py Outdated Show resolved Hide resolved

added silent error message if importing qutip fails

74a80c8

spellcheck and code formatting changes

d18dfa9

prateekchawla168 requested review from bettinaheim and bmhowe23 as code owners June 7, 2024 09:26

prateekchawla168 added 2 commits June 7, 2024 12:30

Merge branch 'main' into blochsphere

dba71b3

Updated docstrings in bloch_visualize.py

5181cf9

Fixed docstrings in python/cudaq/visualization/bloch_visualize.py

khalatepradnya requested changes Jun 7, 2024

View reviewed changes

khalatepradnya reviewed Jun 7, 2024

View reviewed changes

python/tests/visualization/test_bloch_sphere_visualization.py Show resolved Hide resolved

khalatepradnya reviewed Jun 7, 2024

View reviewed changes

docs/sphinx/examples/python/tutorials/quantum_bits.ipynb Show resolved Hide resolved

khalatepradnya reviewed Jun 7, 2024

View reviewed changes

python/tests/visualization/test_bloch_sphere_visualization.py Outdated Show resolved Hide resolved

khalatepradnya reviewed Jun 13, 2024

View reviewed changes

python/cudaq/visualization/bloch_visualize.py Outdated Show resolved Hide resolved

khalatepradnya approved these changes Jun 14, 2024

View reviewed changes

khalatepradnya assigned prateekchawla168 Jun 15, 2024

fixed pure state testing formula in bloch_visualize.py

5876393

github-actions bot pushed a commit that referenced this pull request Jun 17, 2024

Docs preview for PR #1763.

dae156d

code formatting changes for CI failures

52289d4

github-actions bot pushed a commit that referenced this pull request Jun 17, 2024

Docs preview for PR #1763.

a0e2475

improved efficiency while testing for pure state

73e1d84

khalatepradnya mentioned this pull request Jun 18, 2024

Bloch sphere visualization for single-qubit operations #1639

Closed

github-actions bot pushed a commit that referenced this pull request Jun 18, 2024

Docs preview for PR #1763.

f6c858d

khalatepradnya and others added 2 commits June 18, 2024 11:35

Merge branch 'main' into blochsphere

69ca8a6

* Installing the packages for qutip and matplotlib in the CUDA-Q dev

f6fc36f

image so that it available to run the new functionality out-of-the-box. Also addresses the CI failure on notebook validation.

* Code clean-up:

b21be48

-- updated toml file to reflect qutip<5 -- updated notebook to use default target (optionally set 'density-matrix-cpu') -- removed redundant comments and fixed one occurence of 'CUDA-Q'

khalatepradnya mentioned this pull request Jun 18, 2024

[Do not merge] Testing CI on notebook #1810

Closed

github-actions bot pushed a commit that referenced this pull request Jun 18, 2024

Docs preview for PR #1763.

6f60259

Merge branch 'main' into blochsphere

d4a065f

bettinaheim merged commit ccf9713 into NVIDIA:main Jun 19, 2024

github-actions bot locked and limited conversation to collaborators Jun 19, 2024

bettinaheim added the enhancement New feature or request label Jul 29, 2024

bettinaheim added this to the release 0.8.0 milestone Jul 29, 2024

Blochsphere Visualization #1763

Blochsphere Visualization #1763

Uh oh!

Conversation

prateekchawla168 commented Jun 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

copy-pr-bot bot commented Jun 5, 2024

Uh oh!

github-actions bot commented Jun 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

prateekchawla168 commented Jun 5, 2024

Uh oh!

prateekchawla168 commented Jun 5, 2024

Uh oh!

khalatepradnya left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

khalatepradnya commented Jun 5, 2024

Uh oh!

khalatepradnya commented Jun 5, 2024

Uh oh!

prateekchawla168 commented Jun 6, 2024

Uh oh!

prateekchawla168 commented Jun 6, 2024

Uh oh!

Uh oh!

prateekchawla168 commented Jun 6, 2024

Uh oh!

khalatepradnya commented Jun 6, 2024

Uh oh!

freifrauvonbleifrei commented Jun 7, 2024

Uh oh!

prateekchawla168 commented Jun 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

khalatepradnya left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

freifrauvonbleifrei commented Jun 10, 2024

Uh oh!

Uh oh!

khalatepradnya 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!

khalatepradnya commented Jun 17, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 17, 2024

Uh oh!

khalatepradnya commented Jun 17, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 17, 2024

Uh oh!

khalatepradnya commented Jun 18, 2024

Uh oh!

khalatepradnya commented Jun 18, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 18, 2024

Uh oh!

khalatepradnya commented Jun 18, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

prateekchawla168 commented Jun 5, 2024 •

edited

Loading

github-actions bot commented Jun 5, 2024 •

edited

Loading

prateekchawla168 commented Jun 7, 2024 •

edited

Loading

khalatepradnya left a comment •

edited

Loading

khalatepradnya commented Jun 17, 2024 •

edited by github-actions bot

Loading

khalatepradnya commented Jun 17, 2024 •

edited by github-actions bot

Loading

khalatepradnya commented Jun 18, 2024 •

edited by github-actions bot

Loading

khalatepradnya commented Jun 18, 2024 •

edited by github-actions bot

Loading

khalatepradnya commented Jun 18, 2024 •

edited by github-actions bot

Loading