# 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
Raw data
{
"_id": null,
"home_page": "https://github.com/Qiskit/qiskit-ibm-provider",
"name": "qiskit-ibm-provider",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "qiskit, quantum",
"author": "Qiskit Development Team",
"author_email": "qiskit@us.ibm.com",
"download_url": "https://files.pythonhosted.org/packages/3b/75/a3a940de9adbd2c9b85b12e8401a6cbf9b4b6b41d3b65fde64980eaa865e/qiskit_ibm_provider-0.11.0.tar.gz",
"platform": null,
"description": "# Qiskit IBM Quantum Provider (_NOW DEPRECATED_)\n\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://github.com/Qiskit/qiskit-ibm-provider/actions/workflows/ci.yml)\n[](https://github.com/Qiskit/qiskit-ibm-provider/releases)\n[](https://pypi.org/project/qiskit-ibm-provider/)\n[](https://github.com/psf/black)\n[](https://coveralls.io/github/Qiskit/qiskit-ibm-provider?branch=main)\n\n---\n\n**_PLEASE NOTE:_** _As of version 0.11.0, released in April 2024, `qiskit-ibm-provider` has been deprecated\nwith its support ending and eventual archival being no sooner than 3 months from that date. The\nfunction provided by `qiskit-ibm-provider` has been moved to [qiskit-ibm-runtime](https://github.com/Qiskit/qiskit-ibm-runtime).\nPlease see the [Runtime migration Guide] for more details. We encourage you\nto migrate over at your earliest convenience._\n\n---\n\n**Qiskit** is an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules.\n\nThis project contains a provider that allows accessing the **[IBM Quantum]**\nsystems and simulators.\n\n## Migrating from qiskit-ibmq-provider\n\nIf you are familiar with the `qiskit-ibmq-provider` repository, check out the [migration guide].\n\n## Installation\n\nYou can install the provider using pip:\n\n```bash\npip install qiskit-ibm-provider\n```\n\n## Provider Setup\n\n1. Create an IBM Quantum account or log in to your existing account by visiting the [IBM Quantum login page].\n\n1. Copy (and/or optionally regenerate) your API token from your\n [IBM Quantum account page].\n\n1. Take your token from step 2, here called `MY_API_TOKEN`, and save it by calling `IBMProvider.save_account()`:\n\n ```python\n from qiskit_ibm_provider import IBMProvider\n IBMProvider.save_account(token='MY_API_TOKEN')\n ```\n\n 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.\n Once saved you can then instantiate the provider like below and access the backends:\n\n ```python\n from qiskit_ibm_provider import IBMProvider\n provider = IBMProvider()\n\n # display current supported backends\n print(provider.backends())\n\n # get IBM's simulator backend\n simulator_backend = provider.get_backend('ibmq_qasm_simulator')\n ```\n\n### Load Account from Environment Variables\nAlternatively, the IBM Provider can discover credentials from environment variables:\n```bash\nexport QISKIT_IBM_TOKEN='MY_API_TOKEN'\n```\n\nThen instantiate the provider without any arguments and access the backends:\n```python\nfrom qiskit_ibm_provider import IBMProvider\nprovider = IBMProvider()\n```\n\n### Enable Account for Current Session\nAs another alternative, you can also enable an account just for the current session by instantiating the provider with the token.\n\n```python\nfrom qiskit_ibm_provider import IBMProvider\nprovider = IBMProvider(token='MY_API_TOKEN')\n```\n\n## Next Steps\n\nNow you're set up and ready to check out some of the tutorials.\n- [IBM Quantum Learning]\n- [Qiskit]\n\n## Contribution Guidelines\n\nIf you'd like to contribute to qiskit-ibm-provider, please take a look at our\n[contribution guidelines]. This project adheres to Qiskit's [code of conduct].\nBy participating, you are expect to uphold to this code.\n\nWe use [GitHub issues] for tracking requests and bugs. Please use our [slack]\nfor discussion and simple questions. To join our Slack community, use the\ninvite link [here](https://docs.quantum.ibm.com/support#qiskit).\n\n## Authors and Citation\n\nThe Qiskit IBM Quantum Provider is the work of [many people] who contribute to the\nproject at different levels. If you use Qiskit, please cite as per the included\n[BibTeX file].\n\n## License\n\n[Apache License 2.0].\n\n\n[IBM Quantum]: https://www.ibm.com/quantum-computing/\n[IBM Quantum login page]: https://quantum-computing.ibm.com/login\n[IBM Quantum account page]: https://quantum-computing.ibm.com/account\n[contribution guidelines]: https://github.com/Qiskit/qiskit-ibm-provider/blob/main/CONTRIBUTING.md\n[code of conduct]: https://github.com/Qiskit/qiskit-ibm-provider/blob/main/CODE_OF_CONDUCT.md\n[GitHub issues]: https://github.com/Qiskit/qiskit-ibm-provider/issues\n[slack]: https://qiskit.slack.com\n[many people]: https://github.com/Qiskit/qiskit-ibm-provider/graphs/contributors\n[IBM Quantum Learning]: https://learning.quantum.ibm.com/catalog/tutorials\n[Qiskit]: https://github.com/Qiskit/qiskit-tutorial\n[BibTeX file]: https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib\n[Apache License 2.0]: https://github.com/Qiskit/qiskit-ibm-provider/blob/main/LICENSE.txt\n[migration guide]: https://github.com/Qiskit/qiskit-ibm-provider/blob/6be5f3297ede75bb062b20601058b55a397668e3/docs/tutorials/Migration_Guide_from_qiskit-ibmq-provider.ipynb\n[Runtime migration guide]: https://docs.quantum.ibm.com/api/migration-guides/qiskit-runtime\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Qiskit IBM Quantum Provider for accessing the quantum devices and simulators at IBM",
"version": "0.11.0",
"project_urls": {
"Bug Tracker": "https://github.com/Qiskit/qiskit-ibm-provider/issues",
"Documentation": "https://docs.quantum.ibm.com/api/qiskit-ibm-provider/",
"Homepage": "https://github.com/Qiskit/qiskit-ibm-provider",
"Source Code": "https://github.com/Qiskit/qiskit-ibm-provider"
},
"split_keywords": [
"qiskit",
" quantum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a3862f775a9ce2514da2ad2b0a5e52640536cbd6dcc1b5e0f6a48297ede96dcb",
"md5": "9e2c3a216b7bf4631c0684213146ccfa",
"sha256": "3d84aff2df00d0642a9fcb53cf7f7442e62d65d3bbe13e191bc078b2ee474dc6"
},
"downloads": -1,
"filename": "qiskit_ibm_provider-0.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e2c3a216b7bf4631c0684213146ccfa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 249949,
"upload_time": "2024-04-17T14:49:05",
"upload_time_iso_8601": "2024-04-17T14:49:05.691735Z",
"url": "https://files.pythonhosted.org/packages/a3/86/2f775a9ce2514da2ad2b0a5e52640536cbd6dcc1b5e0f6a48297ede96dcb/qiskit_ibm_provider-0.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3b75a3a940de9adbd2c9b85b12e8401a6cbf9b4b6b41d3b65fde64980eaa865e",
"md5": "1b2752d91a03ab13fb478455c8f04b04",
"sha256": "31a29701120dd0b27e1d8e691b4e7262580cda6f85b85610697577920d8c2f0c"
},
"downloads": -1,
"filename": "qiskit_ibm_provider-0.11.0.tar.gz",
"has_sig": false,
"md5_digest": "1b2752d91a03ab13fb478455c8f04b04",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 244845,
"upload_time": "2024-04-17T14:49:07",
"upload_time_iso_8601": "2024-04-17T14:49:07.424652Z",
"url": "https://files.pythonhosted.org/packages/3b/75/a3a940de9adbd2c9b85b12e8401a6cbf9b4b6b41d3b65fde64980eaa865e/qiskit_ibm_provider-0.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 14:49:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Qiskit",
"github_project": "qiskit-ibm-provider",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "qiskit-ibm-provider"
}
JSON
