Metadata-Version: 2.1
Name: gurobipy-pandas
Version: 1.0.0
Summary: Pandas accessors for gurobipy interaction
Project-URL: Documentation, https://gurobi-optimization-gurobipy-pandas.readthedocs-hosted.com/en/latest
Project-URL: Issues, https://github.com/Gurobi/gurobipy-pandas/issues
Project-URL: Source, https://github.com/Gurobi/gurobipy-pandas
Author-email: Simon Bowly <bowly@gurobi.com>, Robert Luce <luce@gurobi.com>
License-File: LICENSE
Keywords: gurobipy,optimization,pandas
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.8
Requires-Dist: gurobipy>=9.1
Requires-Dist: pandas>=1.0
Description-Content-Type: text/markdown

[![PyPI - Version](https://img.shields.io/pypi/v/gurobipy-pandas.svg)](https://pypi.org/project/gurobipy-pandas)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/gurobipy-pandas.svg)](https://pypi.org/project/gurobipy-pandas)
[![Tests](https://github.com/Gurobi/gurobipy-pandas/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Gurobi/gurobipy-pandas/actions/workflows/test.yml?query=branch%3Amain++)
[![Docs](https://readthedocs.com/projects/gurobi-optimization-gurobipy-pandas/badge/?version=latest)](https://gurobi-optimization-gurobipy-pandas.readthedocs-hosted.com/en/latest)

# 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

```console
pip install gurobipy-pandas
```

## Dependencies

- [gurobipy: Python modelling interface for the Gurobi Optimizer](https://pypi.org/project/gurobipy/)
- [pandas: powerful Python data analysis toolkit](https://pypi.org/project/pandas/)

## Documentation

Full documentation for `gurobipy-pandas` is hosted on [readthedocs](https://gurobi-optimization-gurobipy-pandas.readthedocs-hosted.com/en/latest).

## License

`gurobipy-pandas` is distributed under the terms of the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html).

## Contact Us

For questions related to using gurobipy-pandas please use the [Gurobi Community Forum](https://support.gurobi.com/hc/en-us/community/topics/10373864542609-GitHub-Projects>).

For reporting bugs, issues and feature requests, specific to `gurobipy-pandas`, please [open an issue](https://github.com/Gurobi/gurobipy-pandas/issues).

If you encounter issues with Gurobi or `gurobipy` please contact [Gurobi Support](https://support.gurobi.com/hc/en-us).

## Contributors

- Simon Bowly (maintainer)
- Robert Luce (maintainer)
- Irv Lustig
- Robert Randall
