gurobipy-pandas: Convenience wrapper for building optimization models from pandas data

gurobipy-pandas is a convenient (optional) wrapper to connect pandas with gurobipy. It enables users to more easily and efficiently build mathematical optimization models from data stored in DataFrames and Series, and to read solutions back directly as pandas objects.

gurobipy-pandas is aimed at experienced pandas users who are familiar with methods to transform, group, and aggregate data stored in dataframes. It expects some familiarity with optimization modelling, but does not require deep experience with gurobipy.

Features

gurobipy-pandas allows users to:

• create gurobipy variables tied to the index of a series or dataframe
• construct constraints row-wise using algebraic expressions
• read model solutions and constraint slacks natively as pandas series

Installation

pip install gurobipy-pandas

Dependencies

• gurobipy: Python modelling interface for the Gurobi Optimizer
• pandas: powerful Python data analysis toolkit

Documentation

Full documentation for gurobipy-pandas is hosted on readthedocs.

License

gurobipy-pandas is distributed under the terms of the Apache License 2.0.

Contact Us

For questions related to using gurobipy-pandas please use the Gurobi Community Forum.

For reporting bugs, issues and feature requests, specific to gurobipy-pandas, please open an issue.

If you encounter issues with Gurobi or gurobipy please contact Gurobi Support.

Contributors

• Simon Bowly (maintainer)
• Robert Luce (maintainer)
• Irv Lustig Princeton Consultants
• Robert Randall Princeton Consultants

Webinar

Slides for the 2023 webinars presenting this package can be found at webinar/webinar.ipynb. The notebook will be presented as RISE slides, but can also be executed in Jupyter.