{"id":13751750,"url":"https://github.com/Qiskit/qiskit-ibm-provider","last_synced_at":"2025-05-09T18:32:16.499Z","repository":{"id":38446802,"uuid":"349112062","full_name":"Qiskit/qiskit-ibm-provider","owner":"Qiskit","description":"Qiskit Provider for accessing the IBM Quantum Services: Online Systems and Simulators","archived":false,"fork":false,"pushed_at":"2024-04-18T17:20:05.000Z","size":3910,"stargazers_count":77,"open_issues_count":2,"forks_count":69,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-07-23T19:58:02.279Z","etag":null,"topics":["qiskit"],"latest_commit_sha":null,"homepage":"https://qiskit.org/ecosystem/ibm-provider/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Qiskit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-18T14:52:04.000Z","updated_at":"2024-07-08T16:21:10.000Z","dependencies_parsed_at":"2024-02-12T21:30:53.331Z","dependency_job_id":"ad61afb6-0ee6-4d32-9545-ce3330d7cc1a","html_url":"https://github.com/Qiskit/qiskit-ibm-provider","commit_stats":{"total_commits":861,"total_committers":46,"mean_commits":"18.717391304347824","dds":0.6295005807200929,"last_synced_commit":"52b16e6c62dfca2645fe450c055786a2ce5d51df"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qiskit%2Fqiskit-ibm-provider","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qiskit%2Fqiskit-ibm-provider/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qiskit%2Fqiskit-ibm-provider/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qiskit%2Fqiskit-ibm-provider/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Qiskit","download_url":"https://codeload.github.com/Qiskit/qiskit-ibm-provider/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213786220,"owners_count":15638379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["qiskit"],"created_at":"2024-08-03T09:00:53.931Z","updated_at":"2024-08-03T09:02:39.649Z","avatar_url":"https://github.com/Qiskit.png","language":"Python","funding_links":[],"categories":["Main"],"sub_categories":[],"readme":"# Qiskit IBM Quantum Provider (_NOW DEPRECATED_)\n\n[![License](https://img.shields.io/github/license/Qiskit/qiskit-ibm-provider.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)\n[![CI](https://github.com/Qiskit/qiskit-ibm-provider/actions/workflows/ci.yml/badge.svg)](https://github.com/Qiskit/qiskit-ibm-provider/actions/workflows/ci.yml)\n[![](https://img.shields.io/github/release/Qiskit/qiskit-ibm-provider.svg?style=popout-square)](https://github.com/Qiskit/qiskit-ibm-provider/releases)\n[![](https://img.shields.io/pypi/dm/qiskit-ibm-provider.svg?style=popout-square)](https://pypi.org/project/qiskit-ibm-provider/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Coverage Status](https://coveralls.io/repos/github/Qiskit/qiskit-ibm-provider/badge.svg?branch=main)](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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FQiskit%2Fqiskit-ibm-provider","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FQiskit%2Fqiskit-ibm-provider","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FQiskit%2Fqiskit-ibm-provider/lists"}