{ "info": { "author": "Qiskit Development Team", "author_email": "qiskit@qiskit.org", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: Apache Software License", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Scientific/Engineering" ], "description": "# Qiskit IBMQ Provider\n\n[![License](https://img.shields.io/github/license/Qiskit/qiskit-ibmq-provider.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)[![Build Status](https://img.shields.io/travis/com/Qiskit/qiskit-ibmq-provider/master.svg?style=popout-square)](https://travis-ci.com/Qiskit/qiskit-ibmq-provider)[![](https://img.shields.io/github/release/Qiskit/qiskit-ibmq-provider.svg?style=popout-square)](https://github.com/Qiskit/qiskit-ibmq-provider/releases)[![](https://img.shields.io/pypi/dm/qiskit-ibmq-provider.svg?style=popout-square)](https://pypi.org/project/qiskit-ibmq-provider/)\n\nQiskit is an open-source framework for working with noisy intermediate-scale\nquantum computers (NISQ) at the level of pulses, circuits, and algorithms.\n\nThis module contains a provider that allows accessing the **[IBM Q]** quantum\ndevices and simulators.\n\n## Installation\n\nWe encourage installing Qiskit via the PIP tool (a python package manager),\nwhich installs all Qiskit elements and components, including this one.\n\n```bash\npip install qiskit\n```\n\nPIP will handle all dependencies automatically for us and you will always\ninstall the latest (and well-tested) version.\n\nTo install from source, follow the instructions in the\n[contribution guidelines].\n\n## Setting up the IBMQ provider\n\nOnce the package is installed, you can access the provider from Qiskit.\n\n> **Note**: Since July 2019 (and with version `0.3` of this\n> `qiskit-ibmq-provider` package / version `0.11` of the `qiskit` package),\n> using the new IBM Q Experience (v2) is the default behavior. If you have\n> been using an account for the legacy Quantum Experience or QConsole (v1),\n> please check the [update instructions](#updating-to-the-new-IBM-Q-Experience).\n\n### Configure your IBMQ credentials\n\n1. Create an IBM Q account or log in to your existing account by visiting\n the [IBM Q Experience login page].\n\n2. Copy (and/or optionally regenerate) your API token from your\n [IBM Q Experience account page].\n\n3. Take your token from step 2, here called `MY_API_TOKEN`, and run:\n\n ```python\n from qiskit import IBMQ\n IBMQ.save_account('MY_API_TOKEN')\n ```\n\n### Accessing your IBMQ backends\n\nAfter calling `IBMQ.save_account()`, your credentials will be stored on disk.\nOnce they are stored, at any point in the future you can load and use them\nin your program simply via:\n\n```python\nfrom qiskit import IBMQ\n\nprovider = IBMQ.load_account()\nprovider.get_backend('ibmq_qasm_simulator')\n```\n\nAlternatively, if you do not want to save your credentials to disk and only\nintend to use them during the current session, you can use:\n\n```python\nfrom qiskit import IBMQ\n\nprovider = IBMQ.enable_account('MY_API_TOKEN')\nprovider.get_backend('ibmq_qasm_simulator')\n```\n\nBy default, all IBM Q accounts have access to the same, open project\n(hub: `ibm-q`, group: `open`, project: `main`). For convenience, the\n`IBMQ.load_account()` and `IBMQ.enable_account()` methods will return a provider\nfor that project. If you have access to other projects, you can use:\n\n```python\nprovider_2 = IBMQ.get_provider(hub='MY_HUB', group='MY_GROUP', project='MY_PROJECT')\n```\n\n## Updating to the new IBM Q Experience\n\nSince July 2019 (and with version `0.3` of this `qiskit-ibmq-provider` package),\nthe IBMQProvider defaults to using the new [IBM Q Experience], which supersedes\nthe legacy Quantum Experience and Qconsole. The new IBM Q Experience is also\nreferred as `v2`, whereas the legacy one and Qconsole as `v1`.\n\nThis section includes instructions for updating your accounts and programs.\nPlease note that:\n * the IBM Q Experience `v1` credentials and the programs written for pre-0.3\n versions will still be working during the `0.3.x` series. It is not\n mandatory to update your accounts and programs, but recommended in order\n to take advantage of the new features.\n * updating your credentials to the IBM Q Experience `v2` implies that you\n will need to update your programs. The sections below contain instructions\n on how to perform the transition.\n\n### Updating your IBM Q Experience credentials\n\nIf you have credentials for the legacy Quantum Experience or Qconsole stored in\ndisk, you can make use of `IBMQ.update_account()` helper. This helper will read\nyour current credentials stored in disk and attempt to convert them:\n\n```python\nfrom qiskit import IBMQ\n\nIBMQ.update_account()\n```\n\n```\nFound 2 credentials.\nThe credentials stored will be replaced with a single entry with token \"MYTOKEN\"\nand the new IBM Q Experience v2 URL (https://auth.quantum-computing.ibm.com/api).\n\nIn order to access the provider, please use the new \"IBMQ.get_provider()\" methods:\n\n provider0 = IBMQ.load_account()\n provider1 = IBMQ.get_provider(hub='A', group='B', project='C')\n\nNote you need to update your programs in order to retrieve backends from a\nspecific provider directly:\n\n backends = provider0.backends()\n backend = provider0.get_backend('ibmq_qasm_simulator')\n\nUpdate the credentials? [y/N]\n```\n\nUpon confirmation, your credentials will be overwritten with a valid IBM Q\nExperience v2 set of credentials. For more complex cases, consider deleting your\nprevious credentials via `IBMQ.delete_accounts()` and follow the instructions\nin the [IBM Q Experience account page].\n\n### Updating your programs\n\nWith the introduction of support for the new IBM Q Experience support, a more\nstructured approach for accessing backends has been introduced. Previously,\naccess to all backends was centralized through:\n\n```python\nIBMQ.backends()\nIBMQ.get_backend('ibmq_qasm_simulator')\n```\n\nIn version `0.3` onwards, the preferred way to access the backends is via a\n`Provider` for one of your projects instead of via the global `IBMQ` instance\ndirectly, allowing for more granular control over\nthe project you are using:\n\n```python\nmy_provider = IBMQ.get_provider()\nmy_provider.backends()\nmy_provider.get_backend('ibmq_qasm_simulator')\n```\n\nIn a similar spirit, you can check the providers that you have access to via:\n```python\nIBMQ.providers()\n```\n\nIn addition, since the new IBM Q Experience provides only one set of\ncredentials, the account management methods in IBMQ are now in singular form.\nFor example, you should use `IBMQ.load_account()` instead of\n`IBMQ.load_accounts()`. An `IBMQAccountError` exception is raised if you\nattempt to use the legacy methods with an IBM Q Experience v2 account.\n\nThe following tables contains a quick reference for the differences between the\ntwo versions. Please refer to the documentation of each method for more in\ndepth details:\n\n### Account management\n\n| <0.3 / v1 credentials | >=0.3 and v2 credentials |\n| --- | --- |\n| N/A | `IBMQ.update_account()` |\n| `IBMQ.save_account(token, url)` | `IBMQ.save_account(token)`\n| `IBMQ.load_accounts()` | `provider = IBMQ.load_account()`\n| `IBMQ.enable_account()` | `provider = IBMQ.enable_account()`\n| `IBMQ.disable_accounts()` | `IBMQ.disable_account()`\n| `IBMQ.active_accounts()` | `IBMQ.active_account()`\n| `IBMQ.stored_accounts()` | `IBMQ.stored_account()`\n| `IBMQ.delete_accounts()` | `IBMQ.delete_account()`\n\n### Using backends\n\n| <0.3 / v1 credentials | >=0.3 and v2 credentials |\n| --- | --- |\n| N/A | `providers = IBMQ.providers()` |\n| `backend = IBMQ.get_backend(name, hub='HUB')` | `provider = IBMQ.get_provider(hub='HUB')` |\n| | `backend = provider.get_backend(name)` |\n| `backends = IBMQ.backends(hub='HUB')` | `provider = IBMQ.get_provider(hub='HUB')` |\n| | `backends = provider.backends()` |\n\n\n## Contribution Guidelines\n\nIf you'd like to contribute to IBM Q 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 at [Qiskit.org]. For questions that are more suited for a forum we\nuse the `Qiskit` tag in [Stack Exchange].\n\n## Next Steps\n\nNow you're set up and ready to check out some of the other examples from our\n[Qiskit Tutorial] repository.\n\n## Authors and Citation\n\nThe Qiskit IBM Q 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 Q]: https://www.research.ibm.com/ibm-q/\n[IBM Q Experience]: https://quantum-computing.ibm.com\n[IBM Q Experience login page]: https://quantum-computing.ibm.com/login\n[IBM Q Experience account page]: https://quantum-computing.ibm.com/account\n[contribution guidelines]: https://github.com/Qiskit/qiskit-ibmq-provider/blob/master/CONTRIBUTING.md\n[code of conduct]: https://github.com/Qiskit/qiskit-ibmq-provider/blob/master/CODE_OF_CONDUCT.md\n[GitHub issues]: https://github.com/Qiskit/qiskit-ibmq-provider/issues\n[slack]: https://qiskit.slack.com\n[Qiskit.org]: https://qiskit.org\n[Stack Exchange]: https://quantumcomputing.stackexchange.com/questions/tagged/qiskit\n[Qiskit Tutorial]: https://github.com/Qiskit/qiskit-tutorial\n[many people]: https://github.com/Qiskit/qiskit-ibmq-provider/graphs/contributors\n[BibTeX file]: https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib\n[Apache License 2.0]: https://github.com/Qiskit/qiskit-ibmq-provider/blob/master/LICENSE.txt", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Qiskit/qiskit-ibmq-provider", "keywords": "qiskit sdk quantum api ibmq", "license": "Apache 2.0", "maintainer": "", "maintainer_email": "", "name": "qiskit-ibmq-provider", "package_url": "https://pypi.org/project/qiskit-ibmq-provider/", "platform": "", "project_url": "https://pypi.org/project/qiskit-ibmq-provider/", "project_urls": { "Homepage": "https://github.com/Qiskit/qiskit-ibmq-provider" }, "release_url": "https://pypi.org/project/qiskit-ibmq-provider/0.3.3/", "requires_dist": null, "requires_python": ">=3.5", "summary": "Qiskit provider for accessing the quantum devices and simulators at IBMQ", "version": "0.3.3" }, "last_serial": 5907336, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "b3b74ceeaa9df6e53d3c53c36d5c29b5", "sha256": "3320eea09fd375f43cd3bf3aaf288562280cfafdb9afed48b95484a5dbd5f112" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.1.tar.gz", "has_sig": false, "md5_digest": "b3b74ceeaa9df6e53d3c53c36d5c29b5", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 32492, "upload_time": "2019-04-17T12:21:25", "url": "https://files.pythonhosted.org/packages/ab/9a/25935f86ebb2fb2236f6cd8ed76d9f96d4bc89700003aa3693d18a24576d/qiskit-ibmq-provider-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "a4aea131d93e67bb7412109cdccebbf7", "sha256": "b56c3459b7c5bc94d816f27463d353e8fee14801fed27ec398d39859994f2629" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.1.1.tar.gz", "has_sig": false, "md5_digest": "a4aea131d93e67bb7412109cdccebbf7", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 32385, "upload_time": "2019-05-01T15:27:35", "url": "https://files.pythonhosted.org/packages/2b/37/d4b08060dd1f4a0fcc67545da74f2c2c2931b65ce3c31791712d0af2974a/qiskit-ibmq-provider-0.1.1.tar.gz" } ], "0.1rc1": [ { "comment_text": "", "digests": { "md5": "da8b1787daaf21a49344767f1bb31589", "sha256": "a06b38aabf35cc86adf06decdbe82d402f01752377de896bdef2c0245748d605" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.1rc1.tar.gz", "has_sig": false, "md5_digest": "da8b1787daaf21a49344767f1bb31589", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 31122, "upload_time": "2019-01-21T10:20:06", "url": "https://files.pythonhosted.org/packages/3a/ff/471ce62b235a8e718945dc2f3f9f78e5fca91e3c41a7b3e92dd9138e3aad/qiskit-ibmq-provider-0.1rc1.tar.gz" } ], "0.1rc2": [ { "comment_text": "", "digests": { "md5": "02132f63f2f371115fd48275856c8d4a", "sha256": "7054eac439a5cfc2ccecab2656588605042f16fbee39ffc9064b221f2d7dbf14" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.1rc2.tar.gz", "has_sig": false, "md5_digest": "02132f63f2f371115fd48275856c8d4a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 29679, "upload_time": "2019-02-19T09:45:57", "url": "https://files.pythonhosted.org/packages/18/22/e1bf4ee002f1b9aab063fc7b0dc0f88e5bf7e1defdd3645146841016159d/qiskit-ibmq-provider-0.1rc2.tar.gz" } ], "0.1rc3": [ { "comment_text": "", "digests": { "md5": "f02b0edce70677674ecb314072b19960", "sha256": "7923fbfda2919ff5b7a4684b4e279a2686d7eb2adbe4ee62d38125993ad44f80" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.1rc3.tar.gz", "has_sig": false, "md5_digest": "f02b0edce70677674ecb314072b19960", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 30195, "upload_time": "2019-04-03T14:26:59", "url": "https://files.pythonhosted.org/packages/03/93/94117388972d36a9460aaa82988028d38051f5872c7d45c01ab571b619c4/qiskit-ibmq-provider-0.1rc3.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "3fa7cc1d5ab22d3414c0c78066ffcc9b", "sha256": "1042ac97890e227ce5addb967f7c447d4c8629f1ff3bc936871a682dd3885f14" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.2.0.tar.gz", "has_sig": false, "md5_digest": "3fa7cc1d5ab22d3414c0c78066ffcc9b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 54359, "upload_time": "2019-05-06T15:25:10", "url": "https://files.pythonhosted.org/packages/00/9f/05e9433042574132923db1b1f6be68967766c46ed1fe439eb60d3054b3d8/qiskit-ibmq-provider-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "40e6ef9561d1d342865346a38ea3bb24", "sha256": "66ae98ce0376f3a8cccaa5d9f9afb1b00e58ee8ad692364e2fcad6ecc82999a6" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.2.1.tar.gz", "has_sig": false, "md5_digest": "40e6ef9561d1d342865346a38ea3bb24", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 40471, "upload_time": "2019-05-06T17:57:25", "url": "https://files.pythonhosted.org/packages/b4/f2/5c9cb0c80f2fd26739c4a026851af92c43d91b1d77a95da874b761111a3a/qiskit-ibmq-provider-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "9db46a7eb1666fad8d2f79981856fe93", "sha256": "5fc05803ead012ed38601ae7fab5846ee23806929b1056a243c53ef615f92986" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.2.2.tar.gz", "has_sig": false, "md5_digest": "9db46a7eb1666fad8d2f79981856fe93", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 40429, "upload_time": "2019-05-07T18:05:46", "url": "https://files.pythonhosted.org/packages/5f/46/5d950ad9ca8db2029104438967c6a29f66645a23fd8e8764e7df01f1dbcf/qiskit-ibmq-provider-0.2.2.tar.gz" } ], "0.2.3rc1": [ { "comment_text": "", "digests": { "md5": "17719d836a011b63a7a700f7aff29c47", "sha256": "936577474ebea705d2a581072047404abb07c1e28c9f0231271aab10017d1054" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.2.3rc1.tar.gz", "has_sig": false, "md5_digest": "17719d836a011b63a7a700f7aff29c47", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 41263, "upload_time": "2019-05-10T15:23:21", "url": "https://files.pythonhosted.org/packages/c3/5a/6eaef8d48d4f2873ecf22415ec6686c3d712706c772a25f880443febd5c7/qiskit-ibmq-provider-0.2.3rc1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "1fb3966533c666d92b0f72148d243c0f", "sha256": "ecc8cad60d9e6cafbb8fe18d0538c082a4d50858bd12ac102e4fa1b6d5f319d6" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.3.0.tar.gz", "has_sig": false, "md5_digest": "1fb3966533c666d92b0f72148d243c0f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 56762, "upload_time": "2019-07-15T14:11:01", "url": "https://files.pythonhosted.org/packages/90/b9/fd1997a20bc26e689b2987e196779ae8ce8c8052fc2a49baa50edfda8d99/qiskit-ibmq-provider-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "a70fb26055d5225345b058c7e3b47ee3", "sha256": "0fb0241b244639336a32491ddc564745bfd4b8cc33035c634339d42b64fb6ddc" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.3.1.tar.gz", "has_sig": false, "md5_digest": "a70fb26055d5225345b058c7e3b47ee3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 57465, "upload_time": "2019-07-23T17:08:11", "url": "https://files.pythonhosted.org/packages/b7/8b/dca61d15a0bb0640e261d913779b86e4386a00bc25499ed8aad12b6657a6/qiskit-ibmq-provider-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "968fed954e7648a413ed29342d97655e", "sha256": "18101450a5dafb1583e4c24552f5c40867188fb4359abff15f6955bca0f483f6" }, "downloads": -1, "filename": "qiskit_ibmq_provider-0.3.2-py3-none-any.whl", "has_sig": false, "md5_digest": "968fed954e7648a413ed29342d97655e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 85640, "upload_time": "2019-08-20T16:17:11", "url": "https://files.pythonhosted.org/packages/bb/eb/9c3e007c625b136c66a3f6da73f682f6ec32f6ee8274d998d84ec51cf3be/qiskit_ibmq_provider-0.3.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d764ac1d42d037936483e9442880ad2f", "sha256": "afcc7ea4a1578a61316d1d32eb9a5111e459ddb222f6023c7db9f13887a645cc" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.3.2.tar.gz", "has_sig": false, "md5_digest": "d764ac1d42d037936483e9442880ad2f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 57229, "upload_time": "2019-08-20T16:17:13", "url": "https://files.pythonhosted.org/packages/f1/94/241a4b06be0d24fcacda640b87528ee231c428ac00229613983c0cb6cd5f/qiskit-ibmq-provider-0.3.2.tar.gz" } ], "0.3.3": [ { "comment_text": "", "digests": { "md5": "9a7d09f26025deba8c7615cf4a0536ce", "sha256": "7da57c34a2d4779d4354369205bb92aad89f1d9ac5634b35e6ac6ef74afb532d" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.3.3.tar.gz", "has_sig": false, "md5_digest": "9a7d09f26025deba8c7615cf4a0536ce", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 57175, "upload_time": "2019-09-30T15:08:03", "url": "https://files.pythonhosted.org/packages/cb/6a/ae5f648a565492dd6a39d2472e8940434f2df36c9c4422a39bc9535bfe01/qiskit-ibmq-provider-0.3.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9a7d09f26025deba8c7615cf4a0536ce", "sha256": "7da57c34a2d4779d4354369205bb92aad89f1d9ac5634b35e6ac6ef74afb532d" }, "downloads": -1, "filename": "qiskit-ibmq-provider-0.3.3.tar.gz", "has_sig": false, "md5_digest": "9a7d09f26025deba8c7615cf4a0536ce", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 57175, "upload_time": "2019-09-30T15:08:03", "url": "https://files.pythonhosted.org/packages/cb/6a/ae5f648a565492dd6a39d2472e8940434f2df36c9c4422a39bc9535bfe01/qiskit-ibmq-provider-0.3.3.tar.gz" } ] }