设置 CPLEX 的 Python API

CPLEX 的 Python API 属于 IBM ILOG CPLEX Optimization Studio 的一部分。

注:

CPLEX Python API 是围绕于 C API (CPLEX Callable Library) 的轻量级包装器。 因此,其提供对近乎 CPLEX 必须提供的所有功能的访问。 变量和约束由其在矩阵中的索引进行标识。 本主题阐述如何设置 CPLEX Python API。

DOcplex 是面向对象的建模 Python API,其对于 numpy/pandas 非常友好。 可在本地(在 hood 下使用 CPLEX Python API)或者在云上求解模型。 除了支持访问 CPLEX 以进行数学规划,它还可用于访问 CP Optimizer 约束规划引擎。 有关在 CPLEX 或 CP 优化引擎中使用 DOcplexPythonAPI 的更多信息,请参阅DOcplexPythonModeling API

与 CPLEX Python API 关联的模块驻留在目录 yourCPLEXhome/python/VERSION/PLATFORM 中(或文件夹 yourCPLEXhome\python\VERSION\PLATFORM 中),此处 yourCPLEXhome 指定 CPLEX 安装为 IBM ILOG CPLEX Optimization Studio 一部分的位置,VERSION 指定与 CPLEX 兼容的 Python 版本,而 PLATFORM 表示操作系统与编译器的组合。

有两种可相互替代的方法来设置 CPLEX 的 Python API。
  • 首选且最常用的方法是使用位于目录 yourCPLEXhome/python/VERSION/PLATFORM 中(或文件夹 yourCPLEXhome\python\VERSION\PLATFORM 中)的脚本 setup.py
  • 或者,也可以将环境变量 PYTHONPATH 设置为 yourCPLEXhome/python/VERSION/PLATFORM 并通过 CPLEX 来开始运行 Python 脚本。
在以下段落中对这两种方法均进行了进一步详述。

使用脚本 setup.py

要在系统上安装 CPLEX-Python 模块,请使用位于 yourCplexhome/python/VERSION/PLATFORM 中的脚本 setup.py。 如果要将 CPLEX-Python 模块安装在非缺省位置,请使用选项 --home 识别安装目录。 例如,要将 CPLEX-Python 模块安装在缺省位置,请从命令行使用以下命令:


python setup.py install

要安装在目录 yourPythonPackageshome/cplex 中,请从命令行使用以下命令:


python setup.py install --home yourPythonPackageshome/cplex

这两个命令(缺省和指定主目录)均会调用 Python 包 distutils。 有关适用于该软件包的其他选项,请参考 Python distutils 的文档。

设置环境变量 PYTHONPATH

如果并行运行 CPLEX 的多个版本,那么请使用此方法:通过环境变量 PYTHONPATH 来向 Python 安装声明 CPLEX 及其 Python API 的位置。

要开始使用 CPLEX Python API,请将 Python 路径环境变量 PYTHONPATH 设置为值 yourCplexhome/python/VERSION/PLATFORM。 通过设置此环境变量,该版本的 Python 可以找到其所需的 CPLEX 模块以运行使用 CPLEX Python API 的 Python 命令和脚本。

后续步骤

通过上述方法之一设置好Python环境后,您就可以继续学习 "启动 CPLEXPythonAPI "这一主题了。