cirq_web.bloch_sphere.BlochSphere

Abstract class for all widgets.

Inherits From: Widget

Main aliases

cirq_web.bloch_sphere.BlochSphere(
    sphere_radius: int = 5,
    state_vector: Optional[cirq.STATE_VECTOR_LIKE] = None
)

Args
`sphere_radius`	the radius of the bloch sphere in the three.js diagram. The default value is 5.
`state_vector`	a state vector to pass in to be represented.

Raises
`ValueError`	If the `sphere_radius` is not positive or the `state_vector` is not supplied.

Methods

generate_html_file(
    output_directory: str = './',
    file_name: str = 'bloch_sphere.html',
    open_in_browser: bool = False
) -> str

Generates a portable HTML file of the widget that can be run anywhere. Prints out the absolute path of the file to the console.

Args
`output_directory`	the directory in which the output file will be generated. The default is the current directory ('./')
`file_name`	the name of the output file. Default is 'bloch_sphere'
`open_in_browser`	if True, opens the newly generated file automatically in the browser.

Returns
The path of the HTML file in as a Path object.

get_client_code() -> str

Returns HTML code to render the widget.

get_widget_bundle_name() -> str

Returns the name of the Javascript library file for this widget.