cirq.google.get_engine

View source on GitHub

Get an Engine instance assuming some sensible defaults.

View aliases

Main aliases

cirq.google.engine.engine.get_engine, cirq.google.engine.get_engine

cirq.google.get_engine(
    project_id: Optional[str] = None
) -> cirq.google.Engine

Used in the notebooks

Used in the tutorials
Notebook template Quantum Computing Service reservation utility Get started with Quantum Computing Service

This uses the environment variable GOOGLE_CLOUD_PROJECT for the Engine project_id, unless set explicitly. By using an environment variable, you can avoid hard-coding the project_id in shared code.

If the environment variables are set, but incorrect, an authentication failure will occur when attempting to run jobs on the engine.

Args
project_id	If set overrides the project id obtained from the environment variable GOOGLE_CLOUD_PROJECT.

Returns
The Engine instance.

Raises
EnvironmentError	If the environment variable GOOGLE_CLOUD_PROJECT is not set.