Qiskit IBM Experiment service for accessing the quantum experiment interface at IBM
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.
The provider can be installed via pip:
pip install qiskit-ibm-experiment
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 calling
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
$HOMEis 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
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')
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 at Qiskit.org. For questions that are more suited for a forum we
Qiskit tag in Stack Exchange.
Now you're set up and ready to check out some of the other examples from our Qiskit Tutorial repository.
Authors and Citation
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for qiskit-ibm-experiment-0.2.5.tar.gz
Hashes for qiskit_ibm_experiment-0.2.5-py3-none-any.whl