Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Qiskit/qiskit-ibm-provider
Qiskit Provider for accessing the IBM Quantum Services: Online Systems and Simulators
https://github.com/Qiskit/qiskit-ibm-provider
qiskit
Last synced: 17 days ago
JSON representation
Qiskit Provider for accessing the IBM Quantum Services: Online Systems and Simulators
- Host: GitHub
- URL: https://github.com/Qiskit/qiskit-ibm-provider
- Owner: Qiskit
- License: apache-2.0
- Created: 2021-03-18T14:52:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-18T17:20:05.000Z (2 months ago)
- Last Synced: 2024-05-14T21:42:40.551Z (about 2 months ago)
- Topics: qiskit
- Language: Python
- Homepage: https://qiskit.org/ecosystem/ibm-provider/
- Size: 3.73 MB
- Stars: 76
- Watchers: 11
- Forks: 70
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Lists
- awesome-qiskit - Qiskit IBM Provider - This project contains a provider that allows accessing the ibm quantum systems and simulators. (Main)
README
# Qiskit IBM Quantum Provider (_NOW DEPRECATED_)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/Qiskit/qiskit-ibm-provider/actions/workflows/ci.yml)
[](https://github.com/Qiskit/qiskit-ibm-provider/releases)
[](https://pypi.org/project/qiskit-ibm-provider/)
[](https://github.com/psf/black)
[](https://coveralls.io/github/Qiskit/qiskit-ibm-provider?branch=main)
---
**_PLEASE NOTE:_** _As of version 0.11.0, released in April 2024, `qiskit-ibm-provider` has been deprecated
with its support ending and eventual archival being no sooner than 3 months from that date. The
function provided by `qiskit-ibm-provider` has been moved to [qiskit-ibm-runtime](https://github.com/Qiskit/qiskit-ibm-runtime).
Please see the [Runtime migration Guide] for more details. We encourage you
to migrate over at your earliest convenience._
---
**Qiskit** is 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 accessing the **[IBM Quantum]**
systems and simulators.
## Migrating from qiskit-ibmq-provider
If you are familiar with the `qiskit-ibmq-provider` repository, check out the [migration guide].
## Installation
You can install the provider using pip:
```bash
pip install qiskit-ibm-provider
```
## Provider Setup
1. Create an IBM Quantum account or log in to your existing account by visiting the [IBM Quantum login page].
1. Copy (and/or optionally regenerate) your API token from your
[IBM Quantum account page].
1. Take your token from step 2, here called `MY_API_TOKEN`, and save it by calling `IBMProvider.save_account()`:
```python
from qiskit_ibm_provider import IBMProvider
IBMProvider.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 provider like below and access the backends:
```python
from qiskit_ibm_provider import IBMProvider
provider = IBMProvider()
# display current supported backends
print(provider.backends())
# get IBM's simulator backend
simulator_backend = provider.get_backend('ibmq_qasm_simulator')
```
### Load Account from Environment Variables
Alternatively, the IBM Provider can discover credentials from environment variables:
```bash
export QISKIT_IBM_TOKEN='MY_API_TOKEN'
```
Then instantiate the provider without any arguments and access the backends:
```python
from qiskit_ibm_provider import IBMProvider
provider = IBMProvider()
```
### Enable Account for Current Session
As another alternative, you can also enable an account just for the current session by instantiating the provider with the token.
```python
from qiskit_ibm_provider import IBMProvider
provider = IBMProvider(token='MY_API_TOKEN')
```
## Next Steps
Now you're set up and ready to check out some of the tutorials.
- [IBM Quantum Learning]
- [Qiskit]
## Contribution Guidelines
If you'd like to contribute to qiskit-ibm-provider, 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](https://docs.quantum.ibm.com/support#qiskit).
## Authors and Citation
The Qiskit IBM Quantum Provider 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
[Apache License 2.0].
[IBM Quantum]: https://www.ibm.com/quantum-computing/
[IBM Quantum login page]: https://quantum-computing.ibm.com/login
[IBM Quantum account page]: https://quantum-computing.ibm.com/account
[contribution guidelines]: https://github.com/Qiskit/qiskit-ibm-provider/blob/main/CONTRIBUTING.md
[code of conduct]: https://github.com/Qiskit/qiskit-ibm-provider/blob/main/CODE_OF_CONDUCT.md
[GitHub issues]: https://github.com/Qiskit/qiskit-ibm-provider/issues
[slack]: https://qiskit.slack.com
[many people]: https://github.com/Qiskit/qiskit-ibm-provider/graphs/contributors
[IBM Quantum Learning]: https://learning.quantum.ibm.com/catalog/tutorials
[Qiskit]: https://github.com/Qiskit/qiskit-tutorial
[BibTeX file]: https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib
[Apache License 2.0]: https://github.com/Qiskit/qiskit-ibm-provider/blob/main/LICENSE.txt
[migration guide]: https://github.com/Qiskit/qiskit-ibm-provider/blob/6be5f3297ede75bb062b20601058b55a397668e3/docs/tutorials/Migration_Guide_from_qiskit-ibmq-provider.ipynb
[Runtime migration guide]: https://docs.quantum.ibm.com/api/migration-guides/qiskit-runtime