gurobi/python-example repository overview

⁠Quick reference

Maintained by: Gurobi Optimization⁠

Where to get help: Gurobi Support⁠, Gurobi Documentation⁠

⁠Supported tags and respective Dockerfile links

See Gurobi's release and support history⁠ for which versions are actively supported. All 11.0.x, 12.0.x, and 13.0.x images below are rebuilt on a regular basis to pick up updated base-image dependencies. Versions before 11.0.0 are no longer supported and are listed below for reference only — those images are not rebuilt, so any base-image vulnerabilities reported against them will not be patched.

• 13.0.3, latest⁠
• 13.0.2⁠
• 13.0.1⁠
• 13.0.0⁠
• 12.0.3⁠
• 12.0.2⁠
• 12.0.1⁠
• 12.0.0⁠
• 11.0.3⁠
• 11.0.2⁠
• 11.0.1⁠
• 11.0.0⁠

Unsupported (no longer rebuilt):

• 10.0.3⁠
• 10.0.2⁠
• 10.0.1⁠
• 10.0.0⁠
• 9.5.2⁠
• 9.5.1⁠
• 9.5.0⁠

When building a production application, we recommend using an explicit version number instead of the latest tag. This way, you are in control of the upgrade process of your application.

⁠Quick reference (cont.)

Supported architectures: linux/amd64, linux/arm64

Published image artifact details: https://github.com/Gurobi/docker-python-example⁠

Gurobi images available on DockerHub:

• gurobi/optimizer⁠: Gurobi Optimizer (full distribution)
• gurobi/python⁠: Gurobi Optimizer (Python API only)
• gurobi/python-example⁠: Gurobi Optimizer example in Python with a WLS license
• gurobi/modeling-examples⁠: Optimization modeling examples (distributed as Jupyter Notebooks)
• gurobi/compute⁠: Gurobi Compute Server
• gurobi/manager⁠: Gurobi Cluster Manager

⁠What is gurobi/python-example?

The Gurobi Optimizer is the fastest and most powerful mathematical programming solver available for your LP, QP and MIP (MILP, MIQP, and MIQCP) problems. More info at the Gurobi Website⁠.

The Gurobi Optimizer comes with a Python extension module called “gurobipy” that offers convenient object-oriented modeling constructs and an API to all Gurobi features. More info in the Quick Start Guide⁠.

The gurobi/python-example image provides a simple example to use gurobi/python as a base Docker image with the Gurobi Web License Service:

• The Dockerfile⁠ shows how to customize the image
• The code⁠ in Python sets up the WLS license
• The optimization example is explained in the getting started⁠

⁠Getting a Gurobi license

This image has been created to work with a Web License. The Web License Service⁠ (WLS) is a Gurobi licensing service for containerized environments (Docker, Kubernetes, ...). Gurobi components can automatically request and renew license tokens to the WLS servers available in several regions worldwide. WLS only requires that your container has access to the Internet. Commercial users can request an evaluation and academic users can request a free license. Please register to access the Web License Manager⁠ and read the documentation⁠.

Please contact your sales representative at [email protected]⁠ to discuss licensing options.

⁠Using the client license

This image has been created to pass the license information in the following environment variables:

• GRB_WLSACCESSID: Access ID for Gurobi Web License Service
• GRB_WLSSECRET: Secret Key for Gurobi Web License Service
• GRB_LICENSEID: License ID for Gurobi Web License Service

⁠How to use this image?

Running the example is quick and easy, you just need to pass the WLS license information as environment variables on the command line of docker.

$ docker run -e GRB_WLSACCESSID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
             -e GRB_WLSSECRET=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
             -e GRB_LICENSEID=99999 \
             gurobi/python-example

In the same way, you can run this image in various containerized environments.

⁠License

By downloading and using this image, you agree with the End-User License Agreement⁠ for the Gurobi software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.