Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cduck/bloch_sphere
Visualization tools for the qubit Bloch sphere
https://github.com/cduck/bloch_sphere
bloch-sphere quantum-computing visualization
Last synced: 29 days ago
JSON representation
Visualization tools for the qubit Bloch sphere
- Host: GitHub
- URL: https://github.com/cduck/bloch_sphere
- Owner: cduck
- License: mit
- Created: 2020-06-01T01:56:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T05:15:24.000Z (almost 2 years ago)
- Last Synced: 2024-09-16T16:22:30.452Z (3 months ago)
- Topics: bloch-sphere, quantum-computing, visualization
- Language: Python
- Homepage:
- Size: 108 MB
- Stars: 95
- Watchers: 4
- Forks: 30
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-starred - cduck/bloch_sphere - Visualization tools for the qubit Bloch sphere (others)
README
# Qubit Bloch Sphere Visualization
A collection of visualization tools for the qubit Bloch sphere.
The Bloch sphere is a useful representation of the state of a single-qubit quantum computer.
* [Animations for many common gates](https://github.com/cduck/bloch_sphere/blob/master/examples/common_gates.md)
See also: [Feynman path integral visualization](https://github.com/cduck/feynman_path)
# Install
bloch\_sphere is available on PyPI:
```bash
python3 -m pip install bloch_sphere
```
## Prerequisites
Cairo needs to be installed separately to render videos.
See platform-specific [instructions for Linux, Windows, and macOS from Cairo](https://www.cairographics.org/download/).
Below are some examples for installing Cairo on Linux distributions and macOS.
**Ubuntu**
```bash
sudo apt-get install libcairo2
```
**macOS**
Using [homebrew](https://brew.sh/):
```bash
brew install cairo
```
# Usage
This package provides a command line tool to generate animations.
In your shell, run the following (run `animate_bloch -h` for help).
```bash
animate_bloch hadamard x y s s
```
```bash
animate_bloch2 xy_vs_z x,y z
```
With annotations:
```bash
animate_bloch2 xy_vs_z_annotated \
x,y z \
--circuit '& \gate{X} & \gate{Y} & \qw & \push{=} & & \gate{Z} & \qw' \
--equation '$YX\ket{\psi}=Z\ket{\psi}$' \
--fps 20 \
--mp4
```
Custom gates: `custom;;;;;`
```bash
animate_bloch2 custom_hzy "custom;0;1;1;1;Hzy" "s,h,inv_s"
```
Alternate drawing styles:
```bash
animate_bloch ry_gate_arrows --style arrows ry,0.666667 ry,0.666667 ry,0.666667
```
# Code Examples
### Visualize a single Bloch sphere
```python
from bloch_sphere.animate_bloch import do_or_save_animation, AnimState
@do_or_save_animation('my_animation', save=False, fps=20, preview=True)
# Or
#@do_or_save_animation('my_animation', save='gif', fps=20, preview=True)
#@do_or_save_animation('my_animation', save='mp4', fps=20, preview=False)
def animate(state: AnimState):
state.x_gate()
state.y_gate()
state.s_gate()
state.s_gate()
...
state.wait() # Pause at the end
```
### Compare two sequences of gates
```python
from bloch_sphere.animate_bloch_compare import main
main('hzh_x', 'h,z,h'.split(','), 'x'.split(','),
r'& \gate{H} & \gate{Z} & \gate{H} & \qw & \push{=} & & \gate{X} & \qw',
r'$HZH\ket{\psi}=X\ket{\psi}$',
mp4=False,
fps=20,
preview=True,
)
```
Or
```python
import drawsvg as draw
import latextools
from bloch_sphere.animate_bloch_compare import render_animation
# Add some extra labels
zero_ket = draw.Group()
zero_ket.draw(latextools.render_snippet('$\ket{0}$', latextools.pkg.qcircuit),
x=0, y=0, center=True, scale=0.015)
one_ket = draw.Group()
one_ket.draw(latextools.render_snippet('$\ket{1}$', latextools.pkg.qcircuit),
x=0, y=0, center=True, scale=0.015)
zero_ket_inner = draw.Use(zero_ket, 0, 0, transform='scale(0.75)')
one_ket_inner = draw.Use(one_ket, 0, 0, transform='scale(0.75)')
w = 624*2 # Output width
fps = 20
draw_args = dict(
w = w/2,
outer_labels=[
[(0, 0, 1), (-0.15, 0.13), zero_ket],
[(0, 0, -1), (0.15, -0.13), one_ket],
],
inner_labels=[
[(0, 0, 0.8), (0, 0), zero_ket_inner],
[(0, 0, -0.8), (0, 0), one_ket_inner],
],
)
gates1 = 'h,z,h'.split(',')
gates2 = 'x'.split(',')
def func1(state):
state.draw_args = dict(draw_args)
state.draw_args['inner_labels'] = []
state.sphere_fade_in()
state.apply_gate_list(gates1, final_wait=False)
state.wait()
for _ in gates2:
state.i_gate()
state.wait()
state.wait()
state.sphere_fade_out()
state.wait()
def func2(state):
state.draw_args = dict(draw_args)
state.draw_args['inner_labels'] = []
state.sphere_fade_in()
for _ in gates1:
state.i_gate()
state.wait()
state.apply_gate_list(gates2, final_wait=False)
state.wait()
state.wait()
state.sphere_fade_out()
state.wait()
render_animation('hzh_x_compare', func1, func2,
r'& \gate{H} & \gate{Z} & \gate{H} & \qw & \push{=} & & \gate{X} & \qw',
r'$HZH\ket{\psi}=X\ket{\psi}$',
save='gif', # False, 'gif', or 'mp4'
fps=fps,
preview=True,
w=w)
```
### Synthesize any gate as Rz, Rx, Rz
Any single-qubit gate can be decomposed into a series of three rotations about fixed axes, most commonly as rotations about Z, X, and Z.
See [the example code](https://github.com/cduck/bloch_sphere/blob/master/examples/synthesize_from_rz_rx_rz.py) that generated the below animation.
### Synthesize any gate as Rz, Rx(π/2), Rz, Rx(π/2), Rz
Any single-qubit gate can also be decomposed into a series of three Z rotations with fixed X rotations of π/2 (1/4 turn) in between.
See [the example code](https://github.com/cduck/bloch_sphere/blob/master/examples/synthesize_from_rz_rx_rz.py) that generated the below animation.
