shor.providers package

Subpackages

• shor.providers.qiskit package
  • Submodules
  • shor.providers.qiskit.Aer module
  • shor.providers.qiskit.base module
  • shor.providers.qiskit.ibmq module
  • Module contents

Submodules

shor.providers.base module

class shor.providers.base.Job

Bases: abc.ABC

abstract property result

abstract property status

class shor.providers.base.JobStatus(code: shor.providers.base.JobStatusCode, message: str = '', api_error_code: Optional[int] = None)

Bases: object

class shor.providers.base.JobStatusCode(value)

Bases: enum.Enum

An enumeration.

COMPLETED = ('completed',)

ERROR = ('error',)

RUNNING = ('running',)

WAITING = 'waiting'

class shor.providers.base.Provider

Bases: object

Shor quantum computing providers support: - Running shor QuantumCircuits - Keeping track of running programs (jobs) - Listing and selecting devices - (Optional) Login and logout

abstract devices() → List[str]

List available devices (quantum computers or simulators) for provider :return: A list of device names

abstract property jobs

abstract run(circuit: shor.quantum.QuantumCircuit, times: int) → shor.providers.base.Job

abstract use_device(device: str) → bool

Choose active device for provider. See devices() to list available devices :param device: the name of the desired quantum computer or similator :return: whether or not operation was successful

class shor.providers.base.Result

Bases: abc.ABC

abstract property counts

get(key, default=0)

abstract property sig_bits

class shor.providers.base.WithLoginMixin

Bases: object

abstract account() → str

Shows active account credentials, if logged in.

abstract login(token: str, remember: bool = False, **kwargs) → bool

Login to provider with API token.

Parameters

• token – API token

• remember – Flag to save credentials to file system for future use

• kwargs – Additional params to pass to the downstream provider login function

Returns

boolean if login was successful

abstract logout(forget: bool = False) → None

Logout of provider.

Parameters

forget – Param to forget saved credentials

Module contents