Web-based 3D visualization tools for Cirq.
Project description
This is a development version of cirq-web and may be unstable.
For the latest stable release of cirq-web see here.
Cirq is a Python library for writing, manipulating, and optimizing quantum circuits and running them against quantum computers and simulators.
This module is cirq-web, which allows users to take advantage of browser based 3D visualization tools and features in Cirq. cirq-web also provides a development environment for contributors to create and add their own visualizations to the module.
Documentation
Documentation for cirq-web can be found in the README files located in this module’s subdirectories.
Below is a quick example of how to generate a portable 3D rendering of the Bloch sphere using cirq-web:
import cirq
from cirq_web import BlochSphere
# Prepare a state
zero_state = [1+0j, 0+0j]
state_vector = cirq.to_valid_state_vector(zero_state)
# Create and display the Bloch sphere
sphere = BlochSphere(state_vector=state_vector)
sphere.generate_html_file()This will create the file in the current working directory. There are additional options to specify the output directory or to open the visualization in a browser for example.
You can also view and interact with a Bloch sphere in a Colab or Jupyter notebook setting with the following:
import cirq
from cirq_web import BlochSphere
# Prepare a state
zero_state = [1+0j, 0+0j]
state_vector = cirq.to_valid_state_vector(zero_state)
# Create and display the Bloch sphere
sphere = BlochSphere(state_vector=state_vector)
display(sphere)See the example Jupyter notebook in this directory for more examples on how to use cirq-web.
Installation
Cirq-web is currently in development, and therefore is only available via pre-release.
To install the pre-release version of only cirq-web, use pip install cirq-web~=1.0.dev.
Note, that this will install both cirq-web and cirq-core.
To get all the optional modules installed as well, you’ll have to use pip install cirq or pip install cirq~=1.0.dev for the pre-release version.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file cirq_web-1.5.0.dev20241111211633-py3-none-any.whl.
File metadata
- Download URL: cirq_web-1.5.0.dev20241111211633-py3-none-any.whl
- Upload date:
- Size: 596.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 77d686ccc5f16de0ed4de538b2a0f9c724e9294270526836fce0339e1c6b8bf4 |
|
| MD5 | 5cb5da5d3cc511576d70176f36ae5117 |
|
| BLAKE2b-256 | a7d9a1f10216db3411438619958d0f16df93e72f808d31f6fef2ea42e9c7e77a |
