Skip to content

samarthmistry/opti-extensions

Repository files navigation

opti-extensions

license pypi pyversions

CI Tests Coverage

A collection of custom data structures and user-friendly functions for mathematical optimization modeling with DOcplex, gurobipy, Xpress, and highspy.

Features

  • Specialized data structures: For defining index-sets, parameters, and decision variables enabling concise and high-performance algebraic modeling.
  • Cross-solver compatibility: Comprehensively tested with:
    • CPLEX versions: 20.1.0, 22.1.0, 22.1.1, 22.1.2
    • Gurobi versions: 12.0, 13.0
    • Xpress versions: 9.4, 9.5, 9.6, 9.7, 9.8
    • HiGHS versions: 1.11, 1.12, 1.13, 1.14
  • Easy access to additional CPLEX functionality: Like tuning tool, runseeds, displaying problem statistics, and displaying solution quality statistics — 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.

Links

Development

Dev dependencies can be installed with the pip 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 and released under the Apache 2.0 License. See the LICENSE and NOTICE for more details.

About

A collection of custom data structures and user-friendly functions for mathematical optimization modeling with DOcplex, gurobipy, Xpress, and highspy.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages