Client object¶

The module implementing the Client class.

class qibo_client.qibo_client.Client(token: str, url: str = 'https://cloud.qibo.science')¶

Bases: object

Class to manage the interaction with the remote server.

check_client_server_qibo_versions()¶

Check that client and server qibo package installed versions match.

Raise assertion error if the two versions are not the same.

run_circuit(circuit: Circuit, device: str, project: str = 'personal', nshots: int | None = None, verbatim: bool = False) → QiboJob | None¶

Run circuit on the cluster.

Parameters:

circuit (Circuit) – the QASM representation of the circuit to run
device (str) – the device to run the circuit on.
nshots (int) – number of shots, mandatory for non-simulation devices, defaults to nshots=100 for simulation partitions
verbatim (bool) – If True, attempts to run the circuit without any transpilation. Defaults to False.
wait_for_results (bool) – whether to let the client hang until server results are ready or not. Defaults to True.

Returns:

the result of the computation. None if the job raised an error.

Return type:

Optional[QiboJob]

print_quota_info()¶: Logs the formatted user quota info table.

print_job_info()¶: Logs the formatted user quota info table.

get_job(pid: str) → QiboJob¶

Retrieves the job from the unique process id.

Parameters:: pid (str) – the job’s process identifier
Returns:: the requested QiboJob object
Return type:: QiboJob

delete_job(pid: str)¶

Removes the given job from the web server.

Parameters:: pid (str) – the job’s process identifier

delete_all_jobs() → list[str]¶: Removes all jobs from the web server.

Job object¶

qibo_client.qibo_job.format_hms(seconds: int | float | None) → str¶

qibo_client.qibo_job.convert_str_to_job_status(status: str)¶

class qibo_client.qibo_job.QiboJobStatus(value)¶

Bases: Enum

An enumeration.

QUEUEING = 'queueing'¶

PENDING = 'pending'¶

RUNNING = 'running'¶

POSTPROCESSING = 'postprocessing'¶

SUCCESS = 'success'¶

ERROR = 'error'¶

qibo_client.qibo_job.build_event_job_posted_panel(device: str, pid: str) → Panel¶

class qibo_client.qibo_job.QiboJob(pid: str, base_url: str = 'https://cloud.qibo.science', headers: Dict[str, str] | None = None, circuit: Circuit | None = None, nshots: int | None = None, device: str | None = None)¶

Bases: object

refresh()¶: Refreshes job information from server (no results download).

status() → QiboJobStatus¶

running() → bool¶

success() → bool¶

result(wait: float = 0.5, verbose: bool = True) → QuantumState | None¶: Poll server until completion, then download and return result.

delete() → str¶