A Python library for interacting with IonQ's quantum computing API
Project description
IonQ SDK
The IonQ SDK provides tools for interacting with the IonQ platform, enabling users to manage backends, jobs, and quantum circuits programmatically.
Features
- Backend Management: Access and manage quantum computers.
- Job Management: Submit, manage, and retrieve quantum jobs.
- Quantum Circuit Design: Build and manipulate quantum circuits for execution (not a focus of this SDK).
Installation
This SDK requires Python 3.9 or later. Below are the steps to install and set it up using a virtual environment and Poetry.
Prerequisites
Ensure you have Python and Poetry installed. Poetry is a tool for dependency management and packaging in Python. To install Poetry, you can use the following command:
curl -sSL https://install.python-poetry.org | python3 -
Installing the SDK
To install the SDK, clone the repository, create a virtual environment, and install the dependencies using Poetry:
# Clone the repository
git clone https://github.com/ionq/python-ionq.git
cd python-ionq
# Create a virtual environment
python3 -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
# Install dependencies using Poetry
pip install poetry
poetry install
# Optional: Install with extras for development
poetry install -E all
Quick Start
Here is a quick example to get you started with the IonQ SDK.
Initialize the SDK
First, set up your API key and initialize the Backend object:
from ionq import Backend
backend = Backend(api_key='your_api_key_here')
List Available Backends
You can list the available backends like this:
backends = backend.get_backends()
print(backends)
Create and Submit a Job
To create a circuit and submit a job:
from ionq import Circuit, Job
circuit = Circuit(2)
circuit.h(0)
circuit.cx(0, 1)
job = Job(api_key='your_api_key_here')
job_details = job.create_job(circuit=circuit)
print(job_details)
Retrieve Job Results
To check the results of a submitted job:
results = job.get_job_results(job_id='your_job_id_here')
print(results)
Documentation
For more detailed information and API specifications, please refer to the official documentation.
Contributing
Contributions are welcome! Please read our contributing guidelines to get started.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ionq-0.0.0a6.tar.gz
.
File metadata
- Download URL: ionq-0.0.0a6.tar.gz
- Upload date:
- Size: 24.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | de493bb8982e5e5909ca357ee38cabf19b42364bdef213dd1412ceebb3bcf96e |
|
MD5 | 4f6501f5be9f9042259e60f8bae5320b |
|
BLAKE2b-256 | fe38ede1a1d823c23c567cd2e3ae1e022ba7e6137f8798f85cc5fb9e9600e012 |
File details
Details for the file ionq-0.0.0a6-py3-none-any.whl
.
File metadata
- Download URL: ionq-0.0.0a6-py3-none-any.whl
- Upload date:
- Size: 31.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa49eaab786bd390e85ab163d3cddf54c386577b37a26b204030324a9c8faf17 |
|
MD5 | 45839a0a7207e1e69c40d7f589c10f9c |
|
BLAKE2b-256 | b9b01df42213197c94a11f4a6c99e0b6978b9266b154cfd307122a611742625a |