Installation of the R and Python packages
Topics covered in this section:
The Xpress Optimizer can also be installed as an independent module for languages such as R and Python. The following subsections describe their installation process in detail. We refer the reader to the corresponding reference manuals for a description of the usage of these interfaces.
Installation of the R package
The Xpress R Interface is contained as an archive (xpress.tar.gz under Linux and Mac OS, xpress.zip or xpress.tar.gz under Windows) in the installer of the FICO Xpress Optimizer in the R/ subdirectory. It can be installed into an R environment via the R command install.packages. Please refer to the file R/INSTALL.txt for platform-specific installation instructions.
Installation of the Python module
The Xpress Python module can be installed from two Python repositories: The Python Package Index (PyPI) and the Conda repository. Installing the Xpress Python interface does not require installation of the whole Xpress suite, as all necessary libraries are provided.
The install comes with a copy of the Community license, which allows for solving problems with a restricted number of variables and constraints (see Section Community License for details). If you already have an Xpress license, please make sure to set the XPAUTH_PATH environment variable to the full path to the license file, xpauth.xpr.
The manual is located in the xpress/doc subdirectory of the Python installation folder, and its location can be identified by invoking the xpress.manual() function.
For installation using the PyPI server, run the following on a command line:
pip install xpress
Packages for Python 3.6 to 3.9 are available, for Windows, Linux, and MacOS. The package contains the Python interface module, its documentation in PDF format, the Xpress Optimizer's libraries, various examples of use, and a copy of the Community license (see https://content.fico.com/xpress-optimization-community-license). Online documentation can be viewed at the FICO Xpress Optimization Help page.
The above command installs the latest version of the Xpress Python module. Earlier versions of the module can be installed by appending a "==VERSION" string to the module name, for instance
pip install xpress==8.11.2
A Conda package is available for download with the following command:
conda install -c fico-xpress xpress
The content of the Conda package is the same as that of the PyPI package. Similar to the PyPI package, Conda packages for Python 3.6 to 3.9 are available, for Windows, Linux, and MacOS. Similar to PyPI, the Conda installer fetches the latest version of the package but allows for installing earlier versions as in the following example (note that the Conda installer only uses a single "="):
conda install -c fico-xpress xpress=8.11.3
© 2001-2022 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.