pyprodrisk

地位：

ProdRisk 最好的 python 接口！

ProdRisk 是由位于挪威特隆赫姆的 SINTEF Energy Research 开发的用于中期水电运营规划的建模工具。ProdRisk 用于科学和商业目的，请访问ProdRisk 主页以获取有关访问和使用的更多信息和查询。

pyprodrisk 包是 ProdRisk 的开源 python 包装器，需要正确的 ProdRisk 二进制文件才能运行（参见步骤 2）。

1 安装pyprodrisk

pyprodrisk 包可以使用 pip 安装，python 的包安装程序。请访问pip 主页以了解安装和任何 pip 相关问题。您可以通过终端命令安装官方 pyprodrisk 版本：

pip install pyprodrisk

您还可以克隆此存储库并安装最新的开发版本。为此，请在克隆的 pyProdRisk 目录中打开一个终端并输入以下命令：

pip install .

您现在应该会看到 pyprodrisk 在键入时出现在已安装的 python 模块列表中：

pip list

2 为您的系统下载所需的 ProdRisk 二进制文件

注意：您不能分发 cplex 库，因为它需要最终用户许可证

ProdRisk 核心和 API 与 pyprodrisk 包是分开的，必须单独下载。最新的 ProdRisk 二进制文件可在ProdRisk 门户网站上找到。必须由 SINTEF Energy Research 授予对门户的访问权限。

pyprodrisk 需要以下二进制文件才能运行：

视窗：

• 一个 ltm_core_bin 文件夹，其中包含 prodrisk 和 genpris 二进制文件以及 cplex2010.dll（仅当您拥有 HPO 许可证时才需要）。
• ProdRisk API 二进制 prodrisk_pybind.pyd

Linux：

• 一个 ltm_core_bin 文件夹，其中包含 prodrisk- 和 genpris 二进制文件以及 cplex2010.dll（仅当您拥有 HPO 许可证时才需要）。
• ProdRisk API 二进制 prodrisk_pybind.so

求解器特定的二进制文件在此处列为 cplex2010，但会随着新 CPLEX 版本的可用而更改。

通过在 ProdRisk 会话对象上设置属性 use_coin_osi=True，也可以将 OSI 硬币求解器与 ProdRisk 一起使用。

3 环境和许可文件

要使用许可证文件访问您的 ProdRisk 许可证，环境变量LTM_LICENSE_CONTROL_SYSTEM应设置为 TRUE（注意：所有大写字母！）。

ProdRisk 许可证文件LTM_license.dat必须始终位于环境变量 指定的目录中LTM_LICENSE_PATH。可以以LTM_LICENSE_PATH常规方式添加为持久环境变量，也可以由 pyprodrisk 在会话基础上设置。license_path如果在创建 ProdriskSession 类的实例时指定 了关键字参数（参见步骤 4），则环境变量LTM_LICENSE_CONTROL_SYSTEM设置为 TRUE，并LTM_LICENSE_PATH在执行进程的本地环境中被覆盖。如果 ProdRisk 抱怨找不到许可证文件，则可能是没有正确指定 LTM_LICENSE_PATH 和/或 LTM_LICENSE_CONTROL_SYSTEM 的问题。

这LTM_LICENSE_PATH也是 pyprodrisk 查找步骤 2 中提到的 ProdRisk API 二进制文件 prodrisk_pybind 的默认位置。如果二进制文件放在其他位置，solver_path则在创建 ProdriskSession 实例时必须使用关键字参数，以确保加载正确的二进制文件。

设置属性 prodrisk_path 应在 ProdriskSession 上设置为安装步骤 2 中提到的 ltm_core_bin（prodrisk 和 genpris 二进制文件）的目录，例如 prodrisk.prodrisk_path = "/path/to/ltm_core_bin/"

请注意，在 Linux 环境中运行 pyprodrisk 时，libcplex2010.so 也可能放在“/lib”目录中。

4 运行 ProdRisk

现在已经安装了 pyprodrisk，下载了 ProdRisk 二进制文件，并且找到了许可证文件和二进制路径，可以使用 pyProdRisk 在 python 中运行 ProdRisk：

import pyprodrisk as pys

prodrisk = pys.ProdriskSession(license_path="C:/License/File/Path", solver_path="C:/ProdRisk/versions/10.3.0")
prodrisk.prodrisk_path = "C:/ProdRisk/versions/10.3.0/ltm_core_bin/"

#If you have a HPO license you may use the cplex solver:
prodrisk.use_coin_osi = False

#Set time resolution
#Build topolgy
#Add temporal input
#Run model
#Retreive results

请访问 ProdRisk 门户获取详细教程和使用 pyprodrisk的几个示例。