# Quantum Inspire
[](https://opensource.org/licenses/Apache-2.0)
Welcome to the repository for the Quantum Inspire tool. The goal of this project to offer basic support for interacting with the Quantum Inspire platform.
Currently, functionality of the tool is still limited, but the tool is required for logging in to the Quantum Inspire systems. For example, if you would like to use the QI [Qiskit](https://github.com/QuTech-Delft/qiskit-quantuminspire) or [Pennylane](https://github.com/QuTech-Delft/pennylane-quantuminspire) plugins.
## Installation
The recommended way of installing the CLI is to use pipx. After following the [pipx installation instructions](https://github.com/pypa/pipx), clone this repository and run the following command in the repository root:
```bash
pipx install .
```
Afterwards, running `qi --help` should show a help menu.
## Using the CLI to login
In order to login to the platform, run the following command:
```bash
qi login
```
This will open a browser window that will allow you to login or create an account. By default this command will login to the production environment, but the command accepts an argument for a different host URL if needed (e.g. for beta testing purposes).
## Upload files
The CLI can be used to upload files to Quantum Inspire. These files can both be hybrid and quantum circuits.
```bash
qi files upload <filename> <backend_id>
```
The CLI will assume that files with the extension `.cq` are quantum circuits, while files with a `.py` extension are python files. The list of backends (and their properties)
can be retrieved using the following command, from which id field can be read.
```bash
qi backends list
```
## Get results
The previous command outputs a job ID for the job that was just started. Use this job ID when querying for results.
```bash
qi results get <job_id>
```
**Note**: Mostly useful for quantum circuits.
## Get final results
A job also always contains a final result. This object can be queried with the following command.
```bash
qi final_results get <job_id>
```
**Note**: This object will always be generated. In the case of a quantum circuit, the result and final result will be the same. For hybrid algorithms, the final result is a free form datastructure that could for example be used for the aggregation of data. This is generated in the `finalize` step.
Raw data
{
"_id": null,
"home_page": "https://www.quantum-inspire.com",
"name": "quantuminspire",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Quantum Inspire",
"author_email": "support@quantum-inspire.com",
"download_url": "https://files.pythonhosted.org/packages/8f/b6/6632c657ef87c90679cc13fc84774d29a030267ad4f530cc1d26fd9e1550/quantuminspire-3.0.1.tar.gz",
"platform": null,
"description": "# Quantum Inspire\n\n[](https://opensource.org/licenses/Apache-2.0)\n\nWelcome to the repository for the Quantum Inspire tool. The goal of this project to offer basic support for interacting with the Quantum Inspire platform.\nCurrently, functionality of the tool is still limited, but the tool is required for logging in to the Quantum Inspire systems. For example, if you would like to use the QI [Qiskit](https://github.com/QuTech-Delft/qiskit-quantuminspire) or [Pennylane](https://github.com/QuTech-Delft/pennylane-quantuminspire) plugins.\n\n## Installation\n\nThe recommended way of installing the CLI is to use pipx. After following the [pipx installation instructions](https://github.com/pypa/pipx), clone this repository and run the following command in the repository root:\n\n```bash\npipx install .\n```\n\nAfterwards, running `qi --help` should show a help menu.\n\n## Using the CLI to login\n\nIn order to login to the platform, run the following command:\n\n```bash\nqi login\n```\n\nThis will open a browser window that will allow you to login or create an account. By default this command will login to the production environment, but the command accepts an argument for a different host URL if needed (e.g. for beta testing purposes).\n\n## Upload files\n\nThe CLI can be used to upload files to Quantum Inspire. These files can both be hybrid and quantum circuits.\n\n```bash\nqi files upload <filename> <backend_id>\n```\n\nThe CLI will assume that files with the extension `.cq` are quantum circuits, while files with a `.py` extension are python files. The list of backends (and their properties)\ncan be retrieved using the following command, from which id field can be read.\n\n```bash\nqi backends list\n```\n\n## Get results\n\nThe previous command outputs a job ID for the job that was just started. Use this job ID when querying for results.\n\n```bash\nqi results get <job_id>\n```\n\n**Note**: Mostly useful for quantum circuits.\n\n## Get final results\n\nA job also always contains a final result. This object can be queried with the following command.\n\n```bash\nqi final_results get <job_id>\n```\n\n**Note**: This object will always be generated. In the case of a quantum circuit, the result and final result will be the same. For hybrid algorithms, the final result is a free form datastructure that could for example be used for the aggregation of data. This is generated in the `finalize` step.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "SDK for the Quantum Inspire platform.",
"version": "3.0.1",
"project_urls": {
"Homepage": "https://www.quantum-inspire.com",
"Repository": "https://github.com/qutech-delft/quantuminspire"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "31aa81a8d72b3a3c6996ee39db39338e22724e41048879a8af6267d5c16d1a9b",
"md5": "8b4a000a184a8e55d0c7a59d44c70faf",
"sha256": "7a2c26ab031603fdf929e825d30dcb8006269a0c9a68d489d2d7f2fbd62a4640"
},
"downloads": -1,
"filename": "quantuminspire-3.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b4a000a184a8e55d0c7a59d44c70faf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 25067,
"upload_time": "2025-02-05T14:09:07",
"upload_time_iso_8601": "2025-02-05T14:09:07.986082Z",
"url": "https://files.pythonhosted.org/packages/31/aa/81a8d72b3a3c6996ee39db39338e22724e41048879a8af6267d5c16d1a9b/quantuminspire-3.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8fb66632c657ef87c90679cc13fc84774d29a030267ad4f530cc1d26fd9e1550",
"md5": "f8c8a1b3cf656346bc375153fa6880ed",
"sha256": "3d1e85e1448e87daeec5c750cf052e990bd50b5cd702b4c15b8739698db252b2"
},
"downloads": -1,
"filename": "quantuminspire-3.0.1.tar.gz",
"has_sig": false,
"md5_digest": "f8c8a1b3cf656346bc375153fa6880ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 18672,
"upload_time": "2025-02-05T14:09:09",
"upload_time_iso_8601": "2025-02-05T14:09:09.656193Z",
"url": "https://files.pythonhosted.org/packages/8f/b6/6632c657ef87c90679cc13fc84774d29a030267ad4f530cc1d26fd9e1550/quantuminspire-3.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-05 14:09:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qutech-delft",
"github_project": "quantuminspire",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "quantuminspire"
}
JSON
