# 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/de/f6/3066fd7b11edaf0b340c84e24bb85aef481b6c72537b2c4b140637bbae01/oqtant-3.3.3.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": "3.3.3",
"project_urls": {
"Homepage": "https://oqtant.infleqtion.com/",
"Repository": "https://gitlab.com/infleqtion/albert/oqtant"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "86520ad580fc9cb45331c905a00a77c0139ad177954f86a2fe252737a5708a4a",
"md5": "15c97d595213fe9889ded9505ff34d19",
"sha256": "d3779892b813191acbe67aa61676bb3d93b6a7482b900be98cee362cfc7ca3f6"
},
"downloads": -1,
"filename": "oqtant-3.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15c97d595213fe9889ded9505ff34d19",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.10",
"size": 66331,
"upload_time": "2024-11-12T23:13:26",
"upload_time_iso_8601": "2024-11-12T23:13:26.500253Z",
"url": "https://files.pythonhosted.org/packages/86/52/0ad580fc9cb45331c905a00a77c0139ad177954f86a2fe252737a5708a4a/oqtant-3.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "def63066fd7b11edaf0b340c84e24bb85aef481b6c72537b2c4b140637bbae01",
"md5": "610ddbd2aeecc0fe56ff9b0c197717d1",
"sha256": "b42bdaa47d4c79deb414e3b1049e7d7d2ea47a9017e0e86535fc3a04e8506cdf"
},
"downloads": -1,
"filename": "oqtant-3.3.3.tar.gz",
"has_sig": false,
"md5_digest": "610ddbd2aeecc0fe56ff9b0c197717d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.10",
"size": 79219,
"upload_time": "2024-11-12T23:13:27",
"upload_time_iso_8601": "2024-11-12T23:13:27.584247Z",
"url": "https://files.pythonhosted.org/packages/de/f6/3066fd7b11edaf0b340c84e24bb85aef481b6c72537b2c4b140637bbae01/oqtant-3.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 23:13:27",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "infleqtion",
"gitlab_project": "albert",
"lcname": "oqtant"
}
JSON