# Oqtant API (OqtAPI)
Oqtant offers a Python package that works with Jupyter notebooks to provide access to more complex experiments, fine-tuned control over job inputs, and more in-depth data analysis tooling.
With [Oqtant Quantum Matter Service](https://oqtant.infleqtion.com), create a form of quantum matter called a Bose-Einstein condensate (BEC), wherein quantum phenomena are visible on a macroscopic scale. Using light, programmatically manipulate BECs to explore a multitude of phenomena: superposition, interference, tunneling, superfluidity, and more!
[](https://opensource.org/licenses/Apache-2.0)
[](https://pypi.python.org/pypi/oqtant)
[](https://pypi.python.org/pypi/bert-schemas)
[](https://twitter.com/Infleqtion)
## 🚀 Installation
The easiest way to install Oqtant's Python API is via pip:
```shell
pip install oqtant
```
### Update
From a terminal, run:
```shell
pip install --upgrade oqtant
```
Or from within a Jupyter notebook, run:
```shell
%pip install --upgrade oqtant
```
To submit jobs, you will need an Oqtant account. [Register and start for free!](https://oqtant.infleqtion.com)
For more details, see the [Quick Start Guide](https://oqtant-docs.infleqtion.com/INSTALL)
## 🧠Introduction
After installing Oqtant's Python API, you can explore the [Example Jupyter Notebooks](https://oqtant-docs.infleqtion.com/examples/hello_world/). These notebooks will walk you through the functionality and capabilities of using the Oqtant API. Additionally, there is a growing library of [Demonstration Jupyter Notebooks](https://oqtant-docs.infleqtion.com/examples/demos/demo_1_quantum_interference/) for showing specific quantum phenomena on Oqtant (e.g. interference).
Oqtant's Python API contains tools to:
- Have the programmatic equivalent of the same job functionality as the [Oqtant Web App](https://oqtant.infleqtion.com), and more
- Build parameterized (i.e. optimization) experiments using OqtantJobs
- Submit and retrieve OqtantJob results
- Analyze OqtantJob results
## 📓 Documentation
- [Quick Start Guide](https://oqtant-docs.infleqtion.com/INSTALL)
- [Oqtant API docs](https://oqtant-docs.infleqtion.com/oqtant_client_docs)
- [Oqtant REST API docs](https://oqtant-docs.infleqtion.com/oqtant_rest_api_docs)
- [Example Notebooks](https://oqtant-docs.infleqtion.com/examples/hello_world)
Raw data
{
"_id": null,
"home_page": "https://oqtant.infleqtion.com/",
"name": "oqtant",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Larry Buza",
"author_email": "lawrence.buza@coldquanta.com",
"download_url": "https://files.pythonhosted.org/packages/2d/13/a27a06e1d40a35890b27f68ad513f0d901cf04adfeb3df9b86cd11068a8b/oqtant-2.0.1.tar.gz",
"platform": null,
"description": "# Oqtant API (OqtAPI)\n\nOqtant offers a Python package that works with Jupyter notebooks to provide access to more complex experiments, fine-tuned control over job inputs, and more in-depth data analysis tooling.\n\nWith [Oqtant Quantum Matter Service](https://oqtant.infleqtion.com), create a form of quantum matter called a Bose-Einstein condensate (BEC), wherein quantum phenomena are visible on a macroscopic scale. Using light, programmatically manipulate BECs to explore a multitude of phenomena: superposition, interference, tunneling, superfluidity, and more!\n\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://pypi.python.org/pypi/oqtant)\n[](https://pypi.python.org/pypi/bert-schemas)\n[](https://twitter.com/Infleqtion)\n\n## \ud83d\ude80 Installation\n\nThe easiest way to install Oqtant's Python API is via pip:\n\n```shell\npip install oqtant\n```\n\n### Update\n\nFrom a terminal, run:\n\n```shell\npip install --upgrade oqtant\n```\n\nOr from within a Jupyter notebook, run:\n\n```shell\n%pip install --upgrade oqtant\n```\n\nTo submit jobs, you will need an Oqtant account. [Register and start for free!](https://oqtant.infleqtion.com)\nFor more details, see the [Quick Start Guide](https://oqtant-docs.infleqtion.com/INSTALL)\n\n## \ud83e\udded Introduction\n\nAfter installing Oqtant's Python API, you can explore the [Example Jupyter Notebooks](https://oqtant-docs.infleqtion.com/examples/hello_world/). These notebooks will walk you through the functionality and capabilities of using the Oqtant API. Additionally, there is a growing library of [Demonstration Jupyter Notebooks](https://oqtant-docs.infleqtion.com/examples/demos/demo_1_quantum_interference/) for showing specific quantum phenomena on Oqtant (e.g. interference).\n\nOqtant's Python API contains tools to:\n\n- Have the programmatic equivalent of the same job functionality as the [Oqtant Web App](https://oqtant.infleqtion.com), and more\n\n- Build parameterized (i.e. optimization) experiments using OqtantJobs\n\n- Submit and retrieve OqtantJob results\n\n- Analyze OqtantJob results\n\n## \ud83d\udcd3 Documentation\n\n- [Quick Start Guide](https://oqtant-docs.infleqtion.com/INSTALL)\n- [Oqtant API docs](https://oqtant-docs.infleqtion.com/oqtant_client_docs)\n- [Oqtant REST API docs](https://oqtant-docs.infleqtion.com/oqtant_rest_api_docs)\n- [Example Notebooks](https://oqtant-docs.infleqtion.com/examples/hello_world)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Oqtant Desktop Suite",
"version": "2.0.1",
"project_urls": {
"Homepage": "https://oqtant.infleqtion.com/",
"Repository": "https://gitlab.com/infleqtion/albert/oqtant"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d773b8c886041c1fe53f52bef69e7badd9b9f8b6a0e8dee4520515bb50bfba3",
"md5": "5fef8c796b85fa8b230e0a46e49ea16b",
"sha256": "ef241d6943030dd446df712c8b5eae4516d1dfaaeba97fd07f9d046b2f0b8268"
},
"downloads": -1,
"filename": "oqtant-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5fef8c796b85fa8b230e0a46e49ea16b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.10",
"size": 67070,
"upload_time": "2024-06-07T17:11:10",
"upload_time_iso_8601": "2024-06-07T17:11:10.483514Z",
"url": "https://files.pythonhosted.org/packages/6d/77/3b8c886041c1fe53f52bef69e7badd9b9f8b6a0e8dee4520515bb50bfba3/oqtant-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2d13a27a06e1d40a35890b27f68ad513f0d901cf04adfeb3df9b86cd11068a8b",
"md5": "6bf57f6f64f302b7034a958959cfcc4d",
"sha256": "9bb952a3ea70ea106a6e98a9cd9fea6a4d55391ac127856032733dea71fa00fc"
},
"downloads": -1,
"filename": "oqtant-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "6bf57f6f64f302b7034a958959cfcc4d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.10",
"size": 79007,
"upload_time": "2024-06-07T17:11:12",
"upload_time_iso_8601": "2024-06-07T17:11:12.590245Z",
"url": "https://files.pythonhosted.org/packages/2d/13/a27a06e1d40a35890b27f68ad513f0d901cf04adfeb3df9b86cd11068a8b/oqtant-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-07 17:11:12",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "infleqtion",
"gitlab_project": "albert",
"lcname": "oqtant"
}
JSON