cirq_google.engine.get_engine

Get an Engine instance assuming some sensible defaults.

cirq_google.engine.get_engine(
    project_id: Optional[str] = None
) -> cirq_google.engine.Engine

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.

project_id If set overrides the project id obtained from the google.auth.default().

The Engine instance.

OSError If the environment variable GOOGLE_CLOUD_PROJECT is not set. This is actually an EnvironmentError, which by definition is an OsError.