ficoxpress/xpress-solver-python repository overview

⁠Docker Image for FICO Xpress Solver with Python

FICO® Xpress Solver provides the widest breadth of industry-leading optimization algorithms and technologies to solve linear, mixed integer, nonlinear, global and constraint programming problems to help users solve their most difficult and complex challenges.

The following images are available on DockerHub:

• xpress-solver-python⁠: For use of FICO® Xpress with Python
• xpress-solver⁠: For use of FICO® Xpress with non-Python APIs

If you are interested to build your own images from scratch, the Dockerfiles are available on GitHub: https://github.com/fico-xpress/xpress-dockerfiles⁠

⁠Help & documentation

This page purely focuses on the usage of the docker images. The online help documentation for FICO® Xpress can be found here⁠.

⁠Using This Image

⁠Instructions to start up a container from the image (RUN)

an interactive container can be created with the following command:

docker run \
    --interactive --tty --name xpress_ctn \
    --hostname xpressmp \
    ficoxpress/xpress-solver-python /bin/bash

The option for hostname can be omitted. It is useful when communicating between containers.

FICO Xpress is pre-installed in /opt/xpressmp The binaries can be found in /opt/xpressmp/bin/ Several example models can be found in /opt/xpressmp/examples

⁠Instructions to run Python with Xpress

Follow the instructions provided here: https://hub.docker.com/_/python⁠ We recommend copying a requirements.txt file using latest version of Xpress into the working directory of your image. Example Python files can be found on the image in /opt/xpressmp/examples/python

⁠Instructions to run Xpress from command line

Ssh into the container, open console and run:

> optimizer

[xpress]> readprob /opt/xpressmp/examples/python/prob1.lp
[xpress]> optimize

⁠Instructions to run Xpress Mosel from command line

Ssh into the container, open console and run:

> mosel /opt/xpressmp/examples/mosel/Modeling/burglar.mos

Hint: For some other examples in this directory, you may need to execute Xpress Mosel from within the folder.

Note: Before running xprmsrv for the first time, "xprmsrv -key new" needs to be executed once, to initialize the server.

⁠Using a Full License

By default, the image is shipped with a time-limited community version of FICO(R) Xpress allowing execution of Xpress for small problem sizes. The community license is available inside the image in /opt.

To purchase a full license, contact [email protected]⁠.

Web Floating Licenses can be attached to a running container by following the instructions from Xpress Online documentation about Licensing⁠.

⁠Instructions to create an image with security updates

It is the image user's responsibility to regularly run security updates and to upgrade to the latest updates from FICO when available. In particular, this image is based on a public image with underlying OS and software outside of FICO software. We recommend using the following procedure.

Create your own image by building the below Dockerfile by running, based on the public image and running a security update afterwards by running the following command on the below Dockerfile:

docker image build --tag ficoxpress-solver-python-latest

Dockerfile:

FROM ficoxpress/xpress-solver-python

USER root
RUN echo "Running security updates on xpress-optimizer" \
 && apt-get update -y \
 && apt-get upgrade -y \
 && apt-get install --no-install-recommends -y ca-certificates \
 && update-ca-certificates \
 && rm -rf /var/lib/apt/lists/*

Afterwards, you can create a docker container based on your security-up-to-date image by running

docker run --interactive --tty ficoxpress-solver-python-latest /bin/bash

⁠Licensing

This image includes FICO® Xpress software, which is subject to the Xpress Shrinkwrap License Agreement⁠. By downloading this image, you agree to the Community License terms of the Xpress Shrinkwrap License Agreement with respect to the included FICO Xpress software. See the licensing options overview⁠ for additional details and information about obtaining a paid license.

This image has been built on top of a base image with its own licensing restriction: see slimbullseye-Python-3-license-info⁠ and ubuntu-license-info⁠.

As with most any Docker image, this download also contains other, separate, distinct software which may be subject to other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained). It is the image user's responsibility to ensure that any use of this image complies with the relevant licenses for all software contained within.