Skip to content

A collection of custom data structures and user-friendly functions for mathematical optimization modeling with DOcplex — IBM® Decision Optimization CPLEX® Modeling for Python.

License

Notifications You must be signed in to change notification settings

samarthmistry/docplex-extensions

Repository files navigation

docplex-extensions

license pypi pyversions

CI Tests Coverage

A collection of custom data structures and user-friendly functions for mathematical optimization modeling with DOcplex — IBM® Decision Optimization CPLEX® Modeling for Python.

Features

  • Specialized data structures: For defining index-sets, parameters, and decision variables — enabling concise and high-performance algebraic modeling.
  • 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.
  • Robust codebase: 100% coverage spanning 1700+ test cases and fully type-checked with mypy under strict mode.

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

docplex-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 — IBM® Decision Optimization CPLEX® Modeling for Python.

Topics

Resources

License

Stars

Watchers

Forks

Languages