shor.providers.qiskit package

Submodules

shor.providers.qiskit.Aer module

class shor.providers.qiskit.Aer.Aer(**config)

Bases: shor.providers.qiskit.base.QiskitProvider

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

shor.providers.qiskit.base module

class shor.providers.qiskit.base.QiskitJob(qiskit_job)

Bases: shor.providers.base.Job

property result

property status

class shor.providers.qiskit.base.QiskitProvider(device=None, provider=<qiskit.providers.aer.aerprovider.AerProvider object>, **config)

Bases: shor.providers.base.Provider

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

devices(**kwargs) → List[str]

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

property jobs

run(circuit: shor.quantum.QuantumCircuit, times: int) → shor.providers.qiskit.base.QiskitJob

use_device(device: Union[str, qiskit.providers.basebackend.BaseBackend], **kwargs) → 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.qiskit.base.QiskitResult(qiskit_result)

Bases: shor.providers.base.Result

property counts

property sig_bits

shor.providers.qiskit.ibmq module

class shor.providers.qiskit.ibmq.IBMQ(device='qasm_simulator', **config)

Bases: shor.providers.qiskit.base.QiskitProvider, shor.providers.base.WithLoginMixin

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

The IBMQ provider enables access to IBM quantum computers.

An IBMQ Experience account is required. If no account is provided, qasm_simulator will be chosen as the device

To login and remember your IBMQ account use IBMQ.login(TOKEN, remember=True) Your TOKEN can be found at: https://quantum-computing.ibm.com/account

classmethod account() → str

Shows active account credentials, if logged in.

classmethod 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

To login and remember your IBMQ account use IBMQ.login(TOKEN, remember=True) Your TOKEN can be found at: https://quantum-computing.ibm.com/account

classmethod logout(forget: bool = False) → None

Logout of provider.

Parameters

forget – Param to forget saved credentials

Module contents