oqtant


Nameoqtant JSON
Version 1.9.0 PyPI version JSON
download
home_pagehttps://oqtant.infleqtion.com/
SummaryOqtant Desktop Suite
upload_time2024-02-07 22:05:35
maintainer
docs_urlNone
authorLarry Buza
requires_python>=3.10,<3.12
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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!

[![License: Apache](https://img.shields.io/badge/License-Apache-yellow.svg)](https://opensource.org/licenses/Apache-2.0)
[![pypi](https://img.shields.io/pypi/v/oqtant.svg)](https://pypi.python.org/pypi/oqtant)
[![versions](https://img.shields.io/pypi/pyversions/bert-schemas.svg)](https://pypi.python.org/pypi/bert-schemas)
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/Infleqtion.svg?style=social&label=Follow%20%40Infleqtion)](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://gitlab.com/infleqtion/albert/oqtant/-/blob/main/documentation/INSTALL.md)

## 🧭 Introduction

After installing Oqtant's Python API, you can explore the [Example Jupyter Notebooks](https://gitlab.com/infleqtion/albert/oqtant/-/tree/main/documentation/examples). 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://gitlab.com/infleqtion/albert/oqtant/-/tree/main/documentation/examples/demos) 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://gitlab.com/infleqtion/albert/oqtant/-/blob/main/documentation/INSTALL.md)
- [Example Notebooks](https://gitlab.com/infleqtion/albert/oqtant/-/tree/main/documentation/examples)
- [Oqtant API docs](https://gitlab.com/infleqtion/albert/oqtant/-/blob/main/documentation/api/oqtant_api_overview.md)
- [Oqtant REST API docs](https://gitlab.com/infleqtion/albert/oqtant/-/blob/main/documentation/oqtant_rest_api_docs.md)
- [Oqtant Client docs](https://gitlab.com/infleqtion/albert/oqtant/-/blob/main/documentation/oqtant_client_docs.md)

            

Raw data

            {
    "_id": null,
    "home_page": "https://oqtant.infleqtion.com/",
    "name": "oqtant",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<3.12",
    "maintainer_email": "",
    "keywords": "",
    "author": "Larry Buza",
    "author_email": "lawrence.buza@coldquanta.com",
    "download_url": "https://files.pythonhosted.org/packages/37/ed/8073b52ecbe6bdb1688e19a82203d69d9a44c50167f450f3cbdbe806cddc/oqtant-1.9.0.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[![License: Apache](https://img.shields.io/badge/License-Apache-yellow.svg)](https://opensource.org/licenses/Apache-2.0)\n[![pypi](https://img.shields.io/pypi/v/oqtant.svg)](https://pypi.python.org/pypi/oqtant)\n[![versions](https://img.shields.io/pypi/pyversions/bert-schemas.svg)](https://pypi.python.org/pypi/bert-schemas)\n[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/Infleqtion.svg?style=social&label=Follow%20%40Infleqtion)](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://gitlab.com/infleqtion/albert/oqtant/-/blob/main/documentation/INSTALL.md)\n\n## \ud83e\udded Introduction\n\nAfter installing Oqtant's Python API, you can explore the [Example Jupyter Notebooks](https://gitlab.com/infleqtion/albert/oqtant/-/tree/main/documentation/examples). 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://gitlab.com/infleqtion/albert/oqtant/-/tree/main/documentation/examples/demos) 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://gitlab.com/infleqtion/albert/oqtant/-/blob/main/documentation/INSTALL.md)\n- [Example Notebooks](https://gitlab.com/infleqtion/albert/oqtant/-/tree/main/documentation/examples)\n- [Oqtant API docs](https://gitlab.com/infleqtion/albert/oqtant/-/blob/main/documentation/api/oqtant_api_overview.md)\n- [Oqtant REST API docs](https://gitlab.com/infleqtion/albert/oqtant/-/blob/main/documentation/oqtant_rest_api_docs.md)\n- [Oqtant Client docs](https://gitlab.com/infleqtion/albert/oqtant/-/blob/main/documentation/oqtant_client_docs.md)\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Oqtant Desktop Suite",
    "version": "1.9.0",
    "project_urls": {
        "Homepage": "https://oqtant.infleqtion.com/",
        "Repository": "https://gitlab.com/infleqtion/albert/oqtant"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "026e914be0b50150dc3ea70e767a44ce749ec9779d2d09130cad984d0ca00c14",
                "md5": "aa3a88b3b6c3c44462f79b29e5fb9057",
                "sha256": "a353e2b1dcf39b77749f8b0f4ade27ae87f950639cd7d772e15701894bb6ad52"
            },
            "downloads": -1,
            "filename": "oqtant-1.9.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aa3a88b3b6c3c44462f79b29e5fb9057",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<3.12",
            "size": 63036,
            "upload_time": "2024-02-07T22:05:34",
            "upload_time_iso_8601": "2024-02-07T22:05:34.558111Z",
            "url": "https://files.pythonhosted.org/packages/02/6e/914be0b50150dc3ea70e767a44ce749ec9779d2d09130cad984d0ca00c14/oqtant-1.9.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "37ed8073b52ecbe6bdb1688e19a82203d69d9a44c50167f450f3cbdbe806cddc",
                "md5": "42e1023171a2f7091bf5145e7e50cb94",
                "sha256": "a36bfd6971dc4531fbc03850fffd9cf1767160ed566735c9ae8cf7472575cd0f"
            },
            "downloads": -1,
            "filename": "oqtant-1.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "42e1023171a2f7091bf5145e7e50cb94",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<3.12",
            "size": 188459,
            "upload_time": "2024-02-07T22:05:35",
            "upload_time_iso_8601": "2024-02-07T22:05:35.935696Z",
            "url": "https://files.pythonhosted.org/packages/37/ed/8073b52ecbe6bdb1688e19a82203d69d9a44c50167f450f3cbdbe806cddc/oqtant-1.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-07 22:05:35",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "infleqtion",
    "gitlab_project": "albert",
    "lcname": "oqtant"
}
        
Elapsed time: 0.22108s