pyframe:基于片段的多尺度嵌入的python工具
PyFraME的Python项目详细描述
pyframe:用于基于片段的多尺度嵌入计算的python工具
版权所有(c)2017-2018 Jógvan Magnus Haugaard Olsen
pyframe是免费软件:您可以重新分发和/或修改它 根据由 自由软件基金会,或者许可证的第3版,或者 (由您选择)任何更高版本。
PyFrame的发布是希望它能有用, 但没有任何保证;甚至没有 适销性或适合某一特定目的的适销性。见 GNU通用公共许可证了解更多详细信息。
你应该收到GNU通用公共许可证的副本 还有皮弗雷姆。如果没有,请参阅https://www.gnu.org/licenses/。
说明
pyframe是一个python包,它提供了设置 基于片段的多尺度嵌入计算。目的是 提供工具,使此类计算的工作流自动化 以灵活的方式。
典型的工作流程如下:
- 选择部分分子体系作为核心区 它通常被视为一个高水平的理论
- 剩余部分被分成若干个区域,每个区域可以是 在不同的理论层次上处理
- 每个区域(核心区域除外)被划分成碎片 小分子或大分子的一部分 分成更小的可计算的片段
- 对每个片段运行计算以获得片段参数 (如有必要)
- 所有区域的所有片段参数被组合并构成 嵌入势
- 最后在核心区域使用嵌入进行计算 从分子的其余部分模拟效应的潜力 系统
pyframe包可用于自动化步骤1-5。
如何引用
要引用pyframe,请使用类似于以下格式的格式
“j.m.h.olsen,pyframe:python工具,用于基于片段的多尺度 嵌入(0.2.0版),2018, https://doi.org/10.5281/zenodo.1443314“
其中版本和doi应该与实际使用的版本相对应。 注意doi10.5281/zenodo.775113 表示所有版本,并始终解析为最新版本。 可能的bibtex条目可以在CITATION file中找到。
或者,bibtex和其他格式可以由Zenodo生成。
要求
要使用pyframe,您需要:
对于某些功能,您需要以下一项或多项:
要运行测试套件,您需要:
安装
源代码可以从 GitLab或 Zenodo,或直接安装 从PyPI,如下所示
pip install pyframe
要克隆存储库,请运行以下命令
git clone https://gitlab.com/FraME-projects/PyFraME.git
然后可以通过键入
python setup.py install
从pyframe根目录。您可能希望将--user
添加到
最后一行,如果您没有根访问/sudo权限。注意这个
将安装numpy和numba(如果尚未安装)。
测试
要执行完整的测试套件(单元测试和集成测试),请运行
pytest
从pyframe根目录,或者,如果从pypi安装,则 可以通过键入
pytest --pyargs pyframe