# The TitanQ SDK for Python
 
TitanQ is the InfinityQ Software Development Kit (SDK) for Python. The SDK facilitates and opens the way for faster implementation
of the TitanQ solver without having to deal directly with the [TitanQ API](https://docs.titanq.infinityq.io).
This TitanQ package is maintained and published by [InfinityQ](https://www.infinityq.tech/)
## API Key
In order to use the TitanQ service, a user needs an API key.
The API key can be obtained by contacting [InfinityQ support](mailto:support@infinityq.tech)
## Installation
The following steps assume that you have:
- A **valid** and **active** API Key
- A supported Python version installed
## Setting up an environment
``` bash
python -m venv .venv
.venv/bin/activate
```
## Install TitanQ
``` bash
pip install titanq
```
## Using TitanQ
The TitanQ solver is designed to support very large problems and therefore very large files. To simplify the user experience, TitanQ will instead use cloud storage set up and managed by the end users.
Currently, the SDK only supports two types of storage
| Storage options | Vector variables limit |
|--------------------------------|----------------------------------|
| S3 Buckets | ✅ Up to 100k vector variables |
| Managed storage | ⚠️ Up to 10k vector variables |
Both options are documented with examples at the TitanQ's [Quickstart documentation](https://docs.titanq.infinityq.io/user-guide/quickstart/sdk-quickstart)
## Problem construction
TitanQ is an optimization solver for highly non-convex optimization problems. Information on problem construction can be found in the [User Guide](https://docs.titanq.infinityq.io/user-guide), and the [SDK Documentation](https://sdk.titanq.infinityq.io/).
Additional parameters are available to tune the problem:
- beta
- coupling_mult
- num_chains
- num_engines
For more informations how to use theses parameters, please refer to the [API documentation](https://docs.titanq.infinityq.io)
## Getting support or help
Further help can be obtained by contacting [InfinityQ support](mailto:support@infinityq.tech)
Raw data
{
"_id": null,
"home_page": null,
"name": "titanq",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "InfinityQ <support@infinityq.tech>",
"keywords": "titan, titanq, optimization, platform, infinity, infinityq",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/28/db/54552e141f1a2d98c4207d8bde14abedf1b7ff993ca0bf67539d79bb355e/titanq-0.24.0.tar.gz",
"platform": null,
"description": "# The TitanQ SDK for Python\n\n \n\nTitanQ is the InfinityQ Software Development Kit (SDK) for Python. The SDK facilitates and opens the way for faster implementation\nof the TitanQ solver without having to deal directly with the [TitanQ API](https://docs.titanq.infinityq.io).\n\nThis TitanQ package is maintained and published by [InfinityQ](https://www.infinityq.tech/)\n\n\n## API Key\n\nIn order to use the TitanQ service, a user needs an API key.\nThe API key can be obtained by contacting [InfinityQ support](mailto:support@infinityq.tech)\n\n\n## Installation\n\nThe following steps assume that you have:\n\n- A **valid** and **active** API Key\n- A supported Python version installed\n\n\n## Setting up an environment\n\n``` bash\npython -m venv .venv\n.venv/bin/activate\n```\n\n\n## Install TitanQ\n\n``` bash\npip install titanq\n```\n\n\n## Using TitanQ\n\nThe TitanQ solver is designed to support very large problems and therefore very large files. To simplify the user experience, TitanQ will instead use cloud storage set up and managed by the end users.\n\nCurrently, the SDK only supports two types of storage\n\n| Storage options | Vector variables limit |\n|--------------------------------|----------------------------------|\n| S3 Buckets | \u2705 Up to 100k vector variables |\n| Managed storage | \u26a0\ufe0f Up to 10k vector variables |\n\nBoth options are documented with examples at the TitanQ's [Quickstart documentation](https://docs.titanq.infinityq.io/user-guide/quickstart/sdk-quickstart)\n\n## Problem construction\n\n\nTitanQ is an optimization solver for highly non-convex optimization problems. Information on problem construction can be found in the [User Guide](https://docs.titanq.infinityq.io/user-guide), and the [SDK Documentation](https://sdk.titanq.infinityq.io/). \n\nAdditional parameters are available to tune the problem:\n- beta\n- coupling_mult\n- num_chains\n- num_engines\n\nFor more informations how to use theses parameters, please refer to the [API documentation](https://docs.titanq.infinityq.io)\n\n\n## Getting support or help\n\n\nFurther help can be obtained by contacting [InfinityQ support](mailto:support@infinityq.tech)\n",
"bugtrack_url": null,
"license": "Apache 2.0 - Copyright (c) 2024, InfinityQ Technology, Inc.",
"summary": "The TitanQ SDK for python",
"version": "0.24.0",
"project_urls": {
"Documentation": "https://sdk.titanq.infinityq.io",
"Examples": "https://github.com/infinityq-tech/titanq-examples",
"Homepage": "https://www.infinityq.tech"
},
"split_keywords": [
"titan",
" titanq",
" optimization",
" platform",
" infinity",
" infinityq"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8583d1f591299598ad6b689dedb78d1291f161141971aa228f0e8522c32be0f",
"md5": "5f3527aa099fec6d869b8d3ea63f84b6",
"sha256": "1b9056b2a47924336053663193f41f4cfbdab1c95fe5b1c7f8b0863dad353aa3"
},
"downloads": -1,
"filename": "titanq-0.24.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f3527aa099fec6d869b8d3ea63f84b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 61266,
"upload_time": "2024-11-04T20:15:32",
"upload_time_iso_8601": "2024-11-04T20:15:32.234768Z",
"url": "https://files.pythonhosted.org/packages/f8/58/3d1f591299598ad6b689dedb78d1291f161141971aa228f0e8522c32be0f/titanq-0.24.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "28db54552e141f1a2d98c4207d8bde14abedf1b7ff993ca0bf67539d79bb355e",
"md5": "5697af3a618f023d57481c2e6aaee5c1",
"sha256": "eea71f1f88527c56246ac92de8b6cea4217527c1e254d01852ccb0993e576c7c"
},
"downloads": -1,
"filename": "titanq-0.24.0.tar.gz",
"has_sig": false,
"md5_digest": "5697af3a618f023d57481c2e6aaee5c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 47530,
"upload_time": "2024-11-04T20:15:33",
"upload_time_iso_8601": "2024-11-04T20:15:33.756280Z",
"url": "https://files.pythonhosted.org/packages/28/db/54552e141f1a2d98c4207d8bde14abedf1b7ff993ca0bf67539d79bb355e/titanq-0.24.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 20:15:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "infinityq-tech",
"github_project": "titanq-examples",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "titanq"
}
JSON
