OpenPathSampling CLI

OpenPathSampling的命令行界面

OpenPathSampling是一个强大且灵活的路径采样模拟库。然而，许多用户更愿意通过命令行与可执行文件交互，而不是在自己的Python脚本中编写所有内容。这就是这个命令行工具，包括一些处理OPS输出文件的实用脚本。

CLI作为单个可执行文件openpathsampling使用，具有多个子命令。我们建议将openpathsampling别名化（可能为ops？）以节省输入！

当前子命令的类别包括模拟运行和OPS输出文件的杂项操作。

模拟命令

• visit-all：运行MD生成初始轨迹
• md：运行MD直到满足给定的集合或固定时间
• equilibrate：运行路径采样的平衡
• pathsampling：运行任何路径采样模拟，包括TIS变体

杂项命令

• contents：列出OPS .nc文件中的命名对象
• append：将INPUT_FILE中的对象添加到另一个文件中

完整文档可在https://openpathsampling-cli.readthedocs.io/找到；以下为简要总结。

安装

可以使用conda或pip安装OPS CLI

conda -c conda-forge install openpathsampling-cli
# or
pip install openpathsampling-cli

请注意，安装CLI将安装OpenPathSampling，如果您尚未安装它。

工作流程

设置，然后模拟！ 整体思路是您首先设置模拟，然后使用这些脚本来运行生成的模拟设置文件。目前，编写Python脚本（或者更好的方法是使用Jupyter笔记本进行交互式设置）是最佳选择。将必要的模拟对象保存到setup.nc文件中，然后使用这些脚本来运行模拟。

创建自己的命令

创建自己的命令非常简单。OPS CLI使用插件架构，因此安装自己的命令就像将Python文件放入~/.openpathsampling/cli-plugins/目录中一样简单。我们提供了一组标准参数作为装饰器，这些参数可以（并且应该）被重用来从存储中加载事物。CLI基于click构建，因此可以通过使用click的功能轻松添加额外的参数。有关详细信息，请参阅我们的开发者文档。