Qiskit IBM Experiment service for accessing the quantum experiment interface at IBM
Project description
Qiskit IBM Experiment service
Qiskit is an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules.
This project contains a service that allows accessing the IBM Quantum experiment database.
Installation
The provider can be installed via pip:
pip install qiskit-ibm-experiment
Provider Setup
-
Create an IBM Quantum account or log in to your existing account by visiting the IBM Quantum login page.
-
Ensure you have access to the experiment database.
-
Copy (and/or optionally regenerate) your API token from your IBM Quantum account page.
-
Take your token from step 2, here called
MY_API_TOKEN
, and save it by callingIBMExperimentService.save_account()
:from qiskit_ibm_experiment import IBMExperimentService IBMExperimentService.save_account(token='MY_API_TOKEN')
The command above stores your credentials locally in a configuration file called
qiskit-ibm.json
. By default, this file is located in$HOME/.qiskit
, where$HOME
is your home directory.Once saved you can then instantiate the experiment service without using the API token:
from qiskit_ibm_experiment import IBMExperimentService service = IBMExperimentService() # display current supported backends print(service.backends()) # get the latest experiments in the DB experiment_list = service.experiments()
You can also save specific configuration under a given name:
from qiskit_ibm_experiment import IBMExperimentService IBMExperimentService.save_account(name='my_config', token='MY_API_TOKEN')
And explicitly load it:
from qiskit_ibm_experiment import IBMExperimentService service = IBMExperimentService(name='my_config') # display current supported backends print(service.backends())
Load Account from Environment Variables
Alternatively, the IBM Provider can discover credentials from environment variables:
export QISKIT_IBM_EXPERIMENT_TOKEN='MY_API_TOKEN'
export QISKIT_IBM_EXPERIMENT_URL='https://auth.quantum-computing.ibm.com/api'
Then instantiate the provider without any arguments and access the backends:
from qiskit_ibm_experiment import IBMExperimentService
service = IBMExperimentService()
Environment variable take precedence over the default account saved to disk via save_account
,
if one exists; but if the name
parameter is given, the environment variables are ignored.
Enable Account for Current Session
As another alternative, you can also enable an account just for the current session by instantiating the service with the token
from qiskit_ibm_experiment import IBMExperimentService
service = IBMExperimentService(token='MY_API_TOKEN')
Contribution Guidelines
If you'd like to contribute to IBM Quantum Experiment Service, please take a look at our contribution guidelines. This project adheres to Qiskit's code of conduct. By participating, you are expect to uphold to this code.
We use GitHub issues for tracking requests and bugs. Please use our Slack for discussion and simple questions. To join our Slack community, use the invite link here.
Next Steps
Now you're set up and ready to check out some of the other examples from our Qiskit Tutorial repository.
Authors and Citation
The Qiskit IBM Quantum Experiment Service is the work of many people who contribute to the project at different levels. If you use Qiskit, please cite as per the included BibTeX file.
License
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 qiskit-ibm-experiment-0.4.8.tar.gz
.
File metadata
- Download URL: qiskit-ibm-experiment-0.4.8.tar.gz
- Upload date:
- Size: 66.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5866b63fde3247008c578286b8bf5a61493e0d9839467f0d1fcfa24f45a9077 |
|
MD5 | c45331cb24e8c141ec0a983eb6ee7aa6 |
|
BLAKE2b-256 | b87041affde88704599bf7bc36cf66b51ed5d1983b9632e646fedc6ef4760a6c |
File details
Details for the file qiskit_ibm_experiment-0.4.8-py3-none-any.whl
.
File metadata
- Download URL: qiskit_ibm_experiment-0.4.8-py3-none-any.whl
- Upload date:
- Size: 57.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0924fff8de7f86a6fbf77895bda467840450cbc721b114de709cc45071bfc4b5 |
|
MD5 | 1ab5d1ec0dc5417e6ee348d57d7039e4 |
|
BLAKE2b-256 | 6a8182966b0d9703a1c4732b48953510179b2baaacac31e0eb7e5c29a63d4eb7 |