Package: qiskit-ionq
Qiskit IonQ ProviderQiskitis an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules.This project contains a provider that allows access toIonQion trap quantum
systems.The example python notebook (in/example) should help you understand basic usage.API AccessThe IonQ Provider uses IonQ's REST API, and using the provider requires an API access token from IonQ. If you would like to use IonQ as a Qiskit provider, please visithttps://cloud.ionq.com/settings/keysto generate an IonQ API key.Installation:information_source:The Qiskit IonQ Provider requiresqiskit-terra>=0.17.4!To ensure you are on the latest version, run:pipinstall-U"qiskit-terra>=0.17.4"You can install the provider using pip:pipinstallqiskit-ionqProvider SetupTo instantiate the provider, make sure you have an access token then create a provider:fromqiskit_ionqimportIonQProviderprovider=IonQProvider("token")Credential Environment VariablesAlternatively, the IonQ Provider can discover your access token from environment variables:exportIONQ_API_TOKEN="token"Then invoke instantiate the provider without any arguments:fromqiskit_ionqimportIonQProvider,ErrorMitigationprovider=IonQProvider()Once the provider has been instantiated, it may be used to access supported backends:# Show all current supported backends:print(provider.backends())# Get IonQ's simulator backend:simulator_backend=provider.get_backend("ionq_simulator")Submitting a CircuitOnce a backend has been specified, it may be used to submit circuits.
For example, running a Bell State:fromqiskitimportQuantumCircuit# Create a basic Bell State circuit:qc=QuantumCircuit(2,2)qc.h(0)qc.cx(0,1)qc.measure([0,1],[0,1])# Run the circuit on IonQ's platform with error mitigation:job=simulator_backend.run(qc,error_mitigation=ErrorMitigation.DEBIASING)# Print the results.print(job.result().get_counts())# Get results with a different aggregation method when debiasing# is applied as an error mitigation strategyprint(job.result(sharpen=True).get_counts())# The simulator specifically provides the the ideal probabilities and creates# counts by sampling from these probabilities. The raw probabilities are also accessible:print(job.result().get_probabilities())Basis gates and transpilationThe IonQ provider provides access to the full IonQ Cloud backend, which includes its own transpilation and compilation pipeline. As such, IonQ provider backends have a broad set of "basis gates" that they will accept — effectively anything the IonQ API will accept. They areccx, ch, cnot, cp, crx, cry, crz, csx, cx, cy, cz, h, i, id, mcp, mct, mcx, measure, p, rx, rxx, ry, ryy, rz, s, sdg, swap, sx, sxdg, t, tdg, toffoli, x, yandz.If you have circuits that you'd like to run on IonQ backends that use other gates than this (uoriswapfor example), you will either need to manually rewrite the circuit to only use the above list, or use the Qiskit transpiler, per the example below. Please note that not all circuits can be automatically transpiled.If you'd like lower-level access—the ability to program in native gates and skip our compilation/transpilation pipeline—please reach out to your IonQ contact for further information.fromqiskitimportQuantumCircuit,transpilefrommathimportpiqc2=QuantumCircuit(1,1)qc2.u(pi,pi/2,pi/4,0)qc2.measure(0,0)transpiled_circuit=transpile(qc2,simulator_backend)ContributingIf you'd like to contribute to the IonQ Provider, please take a look at thecontribution guidelines. This project adheres the Qiskit Community code of conduct. By participating, you are agreeing to uphold this code.If you have an enhancement request or bug report, we encourage you to open an issue inthis repo's issues tracker. If you have a support question or general discussion topic, we recommend instead asking on theQiskit community slack(you can join usingthis link) or theQuantum Computing StackExchange.Running TestsThis package uses thepytesttest runner, and other packages
for mocking interfactions, reporting coverage, etc.
These can be installed withpip install -r requirements-test.txt.To use pytest directly, just run:pytest[pytest-args]Alternatively, you may use the setuptools integration by running tests throughsetup.py, e.g.:pythonsetup.pytest--addopts="[pytest-args]"FixturesGlobal pytest fixtures for the test suite can be found in the top-leveltest/conftest.pyfile.SSL certificate issuesIf you receive the errorSSLError(SSLCertVerificationError)or otherwise are unable to connect succesfully, there are a few possible resolutions:Try accessinghttps://api.ionq.co/v0.3/healthin your browser; if this does not load, you need to contact an IT administrator about allowing IonQ API access.pip install pip_system_certsinstructs python to use the same certificate roots of trust as your local browser - install this if the first step succeeded but qiskit-ionq continues to have issues.You can debug further by runningres = requests.get('https://api.ionq.co/v0.3/health', timeout=30)and inspectingres, you should receive a 200 response with the content{"status": "pass"}. If you see a corporate or ISP login page, you will need to contact a local IT administrator to debug further.DocumentationTo build the API reference and quickstart docs, run:pipinstall-rrequirements-docs.txt
makehtml
openbuild/html/index.htmlLicenseApache License 2.0.The IonQ logo and Q mark are copyright IonQ, Inc. All rights reserved.