# 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.
## Installation
The provider can be installed via pip:
```bash
pip install qiskit-ibm-experiment
```
## Provider Setup
1. Create an IBM Quantum account or log in to your existing account by visiting the [IBM Quantum login page].
2. Ensure you have access to the experiment database.
3. Copy (and/or optionally regenerate) your API token from your
[IBM Quantum account page].
4. Take your token from step 2, here called `MY_API_TOKEN`, and save it by calling `IBMExperimentService.save_account()`:
```python
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 `$HOME/.qiskit`, where `$HOME` is your home directory.
Once saved you can then instantiate the experiment service without using the API token:
```python
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:
```python
from qiskit_ibm_experiment import IBMExperimentService
IBMExperimentService.save_account(name='my_config', token='MY_API_TOKEN')
```
And explicitly load it:
```python
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:
```bash
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:
```python
from qiskit_ibm_experiment import IBMExperimentService
service = IBMExperimentService()
```
Environment variable take precedence over the default account saved to disk via `save_account`,
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
```python
from qiskit_ibm_experiment import IBMExperimentService
service = IBMExperimentService(token='MY_API_TOKEN')
```
## Contribution Guidelines
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
use the `Qiskit` tag in [Stack Exchange].
## Next Steps
Now you're set up and ready to check out some of the other examples from our
[Qiskit Tutorial] repository.
## Authors and Citation
The Qiskit IBM Quantum Experiment Service 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-experiment/blob/main/CONTRIBUTING.md
[code of conduct]: https://github.com/Qiskit/qiskit-ibm-experiment/blob/main/CODE_OF_CONDUCT.md
[GitHub issues]: https://github.com/Qiskit/qiskit-ibm-experiment/issues
[slack]: https://qiskit.slack.com
[Qiskit.org]: https://qiskit.org
[Stack Exchange]: https://quantumcomputing.stackexchange.com/questions/tagged/qiskit
[Qiskit Tutorial]: https://github.com/Qiskit/qiskit-tutorial
[many people]: https://github.com/Qiskit/qiskit-ibm-experiment/graphs/contributors
[BibTeX file]: https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib
[Apache License 2.0]: https://github.com/Qiskit/qiskit-ibm-experiment/blob/main/LICENSE.txt
Raw data
{
"_id": null,
"home_page": "https://github.com/Qiskit/qiskit-ibm-experiment",
"name": "qiskit-ibm-experiment",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "qiskit sdk quantum api experiment ibm",
"author": "Qiskit Development Team",
"author_email": "hello@qiskit.org",
"download_url": "https://files.pythonhosted.org/packages/78/87/9d77da2940482a5f10114ed724c1853487dd038ed8319461cd02497fe069/qiskit-ibm-experiment-0.4.6.tar.gz",
"platform": null,
"description": "# Qiskit IBM Experiment service\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 service that allows accessing the **[IBM Quantum]**\nexperiment database.\n\n## Installation\nThe provider can be installed via pip:\n\n```bash\npip install qiskit-ibm-experiment\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\n2. Ensure you have access to the experiment database.\n\n3. Copy (and/or optionally regenerate) your API token from your\n [IBM Quantum account page].\n\n4. Take your token from step 2, here called `MY_API_TOKEN`, and save it by calling `IBMExperimentService.save_account()`:\n\n ```python\n from qiskit_ibm_experiment import IBMExperimentService\n IBMExperimentService.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 \n Once saved you can then instantiate the experiment service without using the API token:\n\n ```python\n from qiskit_ibm_experiment import IBMExperimentService\n service = IBMExperimentService()\n\n # display current supported backends\n print(service.backends())\n\n # get the latest experiments in the DB\n experiment_list = service.experiments()\n ```\n \n You can also save specific configuration under a given name:\n \n ```python\n from qiskit_ibm_experiment import IBMExperimentService\n IBMExperimentService.save_account(name='my_config', token='MY_API_TOKEN')\n ```\n \n And explicitly load it:\n ```python\n from qiskit_ibm_experiment import IBMExperimentService\n service = IBMExperimentService(name='my_config')\n\n # display current supported backends\n print(service.backends())\n\n### Load Account from Environment Variables\nAlternatively, the IBM Provider can discover credentials from environment variables:\n```bash\nexport QISKIT_IBM_EXPERIMENT_TOKEN='MY_API_TOKEN'\nexport QISKIT_IBM_EXPERIMENT_URL='https://auth.quantum-computing.ibm.com/api'\n```\n\nThen instantiate the provider without any arguments and access the backends:\n```python\nfrom qiskit_ibm_experiment import IBMExperimentService\nservice = IBMExperimentService()\n```\n\nEnvironment variable take precedence over the default account saved to disk via `save_account`,\nif one exists; but if the `name` parameter is given, the environment variables are ignored.\n\n### Enable Account for Current Session\nAs another alternative, you can also enable an account just for the current session by instantiating the service with the token\n\n```python\nfrom qiskit_ibm_experiment import IBMExperimentService\nservice = IBMExperimentService(token='MY_API_TOKEN')\n```\n\n## Contribution Guidelines\n\nIf you'd like to contribute to IBM Quantum Experiment Service, 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 Quantum Experiment Service 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[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-experiment/blob/main/CONTRIBUTING.md\n[code of conduct]: https://github.com/Qiskit/qiskit-ibm-experiment/blob/main/CODE_OF_CONDUCT.md\n[GitHub issues]: https://github.com/Qiskit/qiskit-ibm-experiment/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-ibm-experiment/graphs/contributors\n[BibTeX file]: https://github.com/Qiskit/qiskit/blob/master/Qiskit.bib\n[Apache License 2.0]: https://github.com/Qiskit/qiskit-ibm-experiment/blob/main/LICENSE.txt\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Qiskit IBM Experiment service for accessing the quantum experiment interface at IBM",
"version": "0.4.6",
"project_urls": {
"Bug Tracker": "https://github.com/Qiskit/qiskit-ibm-experiment/issues",
"Documentation": "https://qiskit.org/documentation/",
"Homepage": "https://github.com/Qiskit/qiskit-ibm-experiment",
"Source Code": "https://github.com/Qiskit/qiskit-ibm-experiment"
},
"split_keywords": [
"qiskit",
"sdk",
"quantum",
"api",
"experiment",
"ibm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a25e9b302acf9709b7353a5d5de1a68a3efcd561b8112ed200f50de796a76275",
"md5": "ed72204e37b031fa3b67db119a016e9d",
"sha256": "e47f0e5175f82c29d479f2ce1d4688c1ee332009bfe0e738798f4bd8c9c4ca5e"
},
"downloads": -1,
"filename": "qiskit_ibm_experiment-0.4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed72204e37b031fa3b67db119a016e9d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 57183,
"upload_time": "2024-02-05T09:47:47",
"upload_time_iso_8601": "2024-02-05T09:47:47.191422Z",
"url": "https://files.pythonhosted.org/packages/a2/5e/9b302acf9709b7353a5d5de1a68a3efcd561b8112ed200f50de796a76275/qiskit_ibm_experiment-0.4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "78879d77da2940482a5f10114ed724c1853487dd038ed8319461cd02497fe069",
"md5": "387ad15d477405fad9984db5033d322c",
"sha256": "f003c77d47bb5bbe34a513b88714d231cb15471909ec88f0c8349f5ae9a6cb45"
},
"downloads": -1,
"filename": "qiskit-ibm-experiment-0.4.6.tar.gz",
"has_sig": false,
"md5_digest": "387ad15d477405fad9984db5033d322c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 64959,
"upload_time": "2024-02-05T09:47:49",
"upload_time_iso_8601": "2024-02-05T09:47:49.025388Z",
"url": "https://files.pythonhosted.org/packages/78/87/9d77da2940482a5f10114ed724c1853487dd038ed8319461cd02497fe069/qiskit-ibm-experiment-0.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 09:47:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Qiskit",
"github_project": "qiskit-ibm-experiment",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "qiskit",
"specs": [
[
">=",
"0.32"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.19"
]
]
},
{
"name": "requests_ntlm",
"specs": [
[
">=",
"1.1.0"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.13"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.21.1"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
">=",
"2.8.0"
]
]
},
{
"name": "websocket-client",
"specs": [
[
">=",
"1.0.1"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
">=",
"4.0.0"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.3.0"
]
]
},
{
"name": "pyyaml",
"specs": [
[
">=",
"6.0.0"
]
]
}
],
"tox": true,
"lcname": "qiskit-ibm-experiment"
}
JSON
