PySCIPOpt

本项目提供了一个从Python连接到SCIP优化套件的接口。从v8.0.3版本开始，SCIP采用了Apache2.0许可证。如果您计划使用早期版本的SCIP，请查看SCIP的许可证限制。

文档

请查阅在线文档，或直接在Python中使用help()函数，或在IPython/Jupyter中使用?。

有关新增、移除或修复的功能，请参见CHANGELOG.md。

安装

使用Conda

请勿使用Conda基础环境安装PYSCIPOPT。

Conda将自动安装SCIP，因此可以通过一条命令完成所有安装：

conda install --channel conda-forge pyscipopt

使用PyPI和从源代码安装

请参阅INSTALL.md获取安装说明。请注意，最新版本的PySCIPOpt通常仅与SCIP优化套件的最新主要版本兼容。下表总结了不同SCIP版本所需的PySCIPOpt版本：

SCIP	PySCIPOpt
9.1	5.1+
9.0	5.0.x
8.0	4.x
7.0	3.x
6.0	2.x
5.0	1.4, 1.3
4.0	1.2, 1.1
3.2	1.0

关于特定SCIP版本所需的PySCIPOpt版本信息也可以在INSTALL.md中找到。

构建和求解模型

有几个示例和教程。这些展示了接口的一些功能，可以作为编写更复杂代码的入门点。一些常见用例也可以在recipes子包中找到。您可能还想看看这篇关于PySCIPOpt的文章： https://opus4.kobv.de/opus4-zib/frontdoor/index/index/docId/6045。使用接口时始终需要以下步骤：

需要在代码中导入python-scip。这可以通过包含以下行来实现：

from pyscipopt import Model

创建一个求解器实例。

model = Model("Example")  # 模型名称是可选的

使用求解器/模型实例model访问scip.pxi文件中的方法，例如：

x = model.addVar("x")
y = model.addVar("y", vtype="INTEGER")
model.setObjective(x + y)
model.addCons(2*x - y*y >= 0)
model.optimize()
sol = model.getBestSol()
print("x: {}".format(sol[x]))
print("y: {}".format(sol[y]))

编写新插件

Python接口可用于定义自定义插件来扩展SCIP的功能。您可以使用纯Python代码编写定价器、启发式算法甚至约束处理器，SCIP可以使用回调系统调用它们的方法。每个可用的插件都有一个基类，您需要扩展该基类，重写预定义但为空的回调。请参阅test_pricer.py和test_heur.py两个简单示例。

请注意，在大多数情况下，需要使用字典来指定SCIP所需的返回值。

扩展接口

PySCIPOpt已经涵盖了SCIP可调用库方法中的许多方法。您也可以扩展它以增加此接口的功能。以下将提供一些关于如何实现这一点的指导：

PySCIPOpt中最重要的两个文件是scip.pxd和scip.pxi。这两个文件指定了可以从Python代码访问的SCIP公共函数。

要让PySCIPOpt知道您想要访问的公共函数，必须将它们添加到scip.pxd中。为了正确添加这些函数，必须做两件事：

确保scip.pxd中包含任何enum、struct或SCIP变量类型
将您希望访问的公共函数的原型添加到scip.pxd中

完成上述两个步骤后，就可以在Python中创建引用scip.pxd中包含的SCIP公共函数的函数。这是通过修改scip.pxi文件来添加您需要的功能来实现的。

我们随时欢迎包含补丁或扩展的拉取请求！

请查看我们的贡献指南。

注意事项

范围约束

虽然支持形式为

lhs <= expression <= rhs

的范围约束，但Python语法中的链式比较无法通过运算符重载来劫持。相反，必须使用括号，例如，

lhs <= (expression <= rhs)

或者，您可以在创建单边约束后调用model.chgRhs(cons, newrhs)或model.chgLhs(cons, newlhs)。

变量对象

您不能将Variable对象用作set的元素或dict的键。它们不可哈希和比较。问题在于诸如x == y之类的比较将被解释为线性约束，因为Variable也是Expr对象。

对偶值

虽然PySCIPOpt支持访问解的对偶值，但存在一些限制：

只能在禁用预求解和传播时使用，以确保LP求解器（提供对偶信息的求解器）实际上求解未修改的问题。
也应该禁用启发式算法，以避免在调用LP求解器之前问题就被解决。
不应该有约束条件，即只有一个变量的约束。这可能会导致不正确的值，如#136中所解释的那样。

因此，在尝试使用对偶信息时，应使用以下设置：

model.setPresolve(pyscipopt.SCIP_PARAMSETTING.OFF)
model.setHeuristics(pyscipopt.SCIP_PARAMSETTING.OFF)
model.disablePropagation()

引用PySCIPOpt

请引用此论文

@incollection{MaherMiltenbergerPedrosoRehfeldtSchwarzSerrano2016,
  author = {Stephen Maher and Matthias Miltenberger and Jo{\~{a}}o Pedro Pedroso and Daniel Rehfeldt and Robert Schwarz and Felipe Serrano},
  title = {{PySCIPOpt}: Mathematical Programming in Python with the {SCIP} Optimization Suite},
  booktitle = {Mathematical Software {\textendash} {ICMS} 2016},
  publisher = {Springer International Publishing},
  pages = {301--307},
  year = {2016},
  doi = {10.1007/978-3-319-42432-3_37},
}

以及相应的SCIP优化套件报告，当您将此工具用于出版物或其他科学工作时。