# opti-extensions
[](https://github.com/samarthmistry/opti-extensions/blob/main/LICENSE)
[](https://pypi.python.org/pypi/opti-extensions)
[](https://pypi.python.org/pypi/opti-extensions)
[](https://github.com/samarthmistry/opti-extensions/blob/main/.github/workflows/ci.yaml)
[](https://github.com/samarthmistry/opti-extensions/blob/main/.github/workflows/tests.yaml)
[](https://github.com/samarthmistry/opti-extensions/tree/main/tests/unit_tests)
A collection of custom data structures and user-friendly functions for mathematical optimization modeling with [DOcplex](https://ibmdecisionoptimization.github.io/docplex-doc), [gurobipy](https://docs.gurobi.com/projects/optimizer/en/current/reference/python.html), and [Xpress](https://www.fico.com/fico-xpress-optimization/docs/latest/solver/optimizer/python/HTML).
Features
--------
* **Specialized data structures**: For defining index-sets, parameters, and decision variables enabling concise and high-performance algebraic modeling — compatible across different solver APIs.
* **Easy access to additional CPLEX functionality**: Like [tuning tool](https://www.ibm.com/docs/en/icos/latest?topic=programmingconsiderations-tuning-tool), [runseeds](https://www.ibm.com/docs/en/icos/latest?topic=cplex-evaluating-variability), [displaying problem statistics](https://www.ibm.com/docs/en/icos/latest?topic=problem-displaying-statistics), and [displaying solution quality statistics](https://www.ibm.com/docs/en/icos/latest?topic=cplex-evaluating-solution-quality) — not directly available in DOcplex.
* **Type-complete interface**: Enables static type checking and intelligent auto-completion suggestions with modern IDEs — reducing type errors and improving development speed.
* **Robust codebase**: 100% coverage spanning 2750+ test cases and fully type-checked with mypy under [strict mode](https://mypy.readthedocs.io/en/stable/getting_started.html#strict-mode-and-configuration).
Links
-----
* [Documentation](https://opti-extensions.readthedocs.io/en/stable)
* [Installation](https://opti-extensions.readthedocs.io/en/stable/installation/index.html)
* [Source code](https://github.com/samarthmistry/opti-extensions)
* [Changelog](https://github.com/samarthmistry/opti-extensions/releases)
Development
-----------
Dev dependencies can be installed with the pip [extras](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-extras) `dev`.
* Create HTML documentation locally with: `docs/make html`.
* Run unit tests and functional tests with: `pytest tests`.
* Run doctests with: `pytest src`.
* Run static typing tests with: `mypy tests/typing_tests`.
License
-------
*opti-extensions* is an open-source project developed by [Samarth Mistry](https://www.linkedin.com/in/samarthmistry) and released under the Apache 2.0 License. See the [LICENSE](https://github.com/samarthmistry/opti-extensions/blob/main/LICENSE) and [NOTICE](https://github.com/samarthmistry/opti-extensions/blob/main/NOTICE) for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "opti-extensions",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "CPLEX, DOcplex, Gurobi, gurobipy, Xpress, linear programming, mixed integer programming, optimization model",
"author": null,
"author_email": "Samarth Mistry <samarth.mistry@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ec/fa/8b2c49158078f2455722d650fc227324dd5ef87f241fa86df734c7121938/opti_extensions-1.2.0.tar.gz",
"platform": null,
"description": "# opti-extensions\n\n[](https://github.com/samarthmistry/opti-extensions/blob/main/LICENSE)\n[](https://pypi.python.org/pypi/opti-extensions)\n[](https://pypi.python.org/pypi/opti-extensions)\n\n[](https://github.com/samarthmistry/opti-extensions/blob/main/.github/workflows/ci.yaml)\n[](https://github.com/samarthmistry/opti-extensions/blob/main/.github/workflows/tests.yaml)\n[](https://github.com/samarthmistry/opti-extensions/tree/main/tests/unit_tests)\n\nA collection of custom data structures and user-friendly functions for mathematical optimization modeling with [DOcplex](https://ibmdecisionoptimization.github.io/docplex-doc), [gurobipy](https://docs.gurobi.com/projects/optimizer/en/current/reference/python.html), and [Xpress](https://www.fico.com/fico-xpress-optimization/docs/latest/solver/optimizer/python/HTML).\n\nFeatures\n--------\n\n* **Specialized data structures**: For defining index-sets, parameters, and decision variables enabling concise and high-performance algebraic modeling \u2014 compatible across different solver APIs.\n* **Easy access to additional CPLEX functionality**: Like [tuning tool](https://www.ibm.com/docs/en/icos/latest?topic=programmingconsiderations-tuning-tool), [runseeds](https://www.ibm.com/docs/en/icos/latest?topic=cplex-evaluating-variability), [displaying problem statistics](https://www.ibm.com/docs/en/icos/latest?topic=problem-displaying-statistics), and [displaying solution quality statistics](https://www.ibm.com/docs/en/icos/latest?topic=cplex-evaluating-solution-quality) \u2014 not directly available in DOcplex.\n* **Type-complete interface**: Enables static type checking and intelligent auto-completion suggestions with modern IDEs \u2014 reducing type errors and improving development speed.\n* **Robust codebase**: 100% coverage spanning 2750+ test cases and fully type-checked with mypy under [strict mode](https://mypy.readthedocs.io/en/stable/getting_started.html#strict-mode-and-configuration).\n\nLinks\n-----\n\n* [Documentation](https://opti-extensions.readthedocs.io/en/stable)\n* [Installation](https://opti-extensions.readthedocs.io/en/stable/installation/index.html)\n* [Source code](https://github.com/samarthmistry/opti-extensions)\n* [Changelog](https://github.com/samarthmistry/opti-extensions/releases)\n\nDevelopment\n-----------\n\nDev dependencies can be installed with the pip [extras](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-extras) `dev`.\n\n* Create HTML documentation locally with: `docs/make html`.\n* Run unit tests and functional tests with: `pytest tests`.\n* Run doctests with: `pytest src`.\n* Run static typing tests with: `mypy tests/typing_tests`.\n\nLicense\n-------\n\n*opti-extensions* is an open-source project developed by [Samarth Mistry](https://www.linkedin.com/in/samarthmistry) and released under the Apache 2.0 License. See the [LICENSE](https://github.com/samarthmistry/opti-extensions/blob/main/LICENSE) and [NOTICE](https://github.com/samarthmistry/opti-extensions/blob/main/NOTICE) for more details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A collection of custom data structures and user-friendly functions for mathematical optimization modeling with DOcplex, gurobipy, and Xpress.",
"version": "1.2.0",
"project_urls": {
"Changelog": "https://github.com/samarthmistry/opti-extensions/releases",
"Documentation": "https://opti-extensions.readthedocs.io/en/stable/#documentation",
"Homepage": "https://opti-extensions.readthedocs.io/",
"Source code": "https://github.com/samarthmistry/opti-extensions/tree/main/src/opti_extensions"
},
"split_keywords": [
"cplex",
" docplex",
" gurobi",
" gurobipy",
" xpress",
" linear programming",
" mixed integer programming",
" optimization model"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "53d18bd1dd6cec7a7be2414e6774e6cc3041d8797000e4117fa874991fbbb487",
"md5": "9eed932a82e99317df235e3cb6b4820c",
"sha256": "855314a626cfc62d25377a89e0603e3c0b9c57111eee3f83d9aee3aca0fa1820"
},
"downloads": -1,
"filename": "opti_extensions-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9eed932a82e99317df235e3cb6b4820c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 60889,
"upload_time": "2025-07-28T06:19:28",
"upload_time_iso_8601": "2025-07-28T06:19:28.706090Z",
"url": "https://files.pythonhosted.org/packages/53/d1/8bd1dd6cec7a7be2414e6774e6cc3041d8797000e4117fa874991fbbb487/opti_extensions-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ecfa8b2c49158078f2455722d650fc227324dd5ef87f241fa86df734c7121938",
"md5": "417315cea334b53887740904f932313b",
"sha256": "81f5ef89244f35a5da63412210ec410ff41470a183af8ef79f1a3fd1636ebca1"
},
"downloads": -1,
"filename": "opti_extensions-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "417315cea334b53887740904f932313b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 52462,
"upload_time": "2025-07-28T06:19:30",
"upload_time_iso_8601": "2025-07-28T06:19:30.412217Z",
"url": "https://files.pythonhosted.org/packages/ec/fa/8b2c49158078f2455722d650fc227324dd5ef87f241fa86df734c7121938/opti_extensions-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-28 06:19:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "samarthmistry",
"github_project": "opti-extensions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "opti-extensions"
}
JSON
