Skip to main content

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

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 –pre.

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 –pre for the pre-release version.

Project details


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

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

cirq_web-1.3.0.dev20230725201132-py3-none-any.whl (596.5 kB view details)

Uploaded Python 3

File details

Details for the file cirq_web-1.3.0.dev20230725201132-py3-none-any.whl.

File metadata

File hashes

Hashes for cirq_web-1.3.0.dev20230725201132-py3-none-any.whl
Algorithm Hash digest
SHA256 ba97a51f3ff38d034cd7b01bbb8b91562fa509887ba79b6b4647d43876a87b07
MD5 8ea75a3be2b60be7cfa5d6b0763d8b2b
BLAKE2b-256 d642ecf8781fad3e5e3281f9ffd262c546375013605e60cc44104854312fb567

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page