跳转到主要内容

围绕GROMACS工具的Python包装器。

项目描述

Build Status Code Coverage Documentation Latest release on zenodo (with DOI) black PRs Welcome! Anaconda.org package

一个围绕Gromacs工具的原始Python包装器。库与GROMACS 4.6.5、2018.x、2019.x、2020.x、2021.x、2022.x、2023.x、2024.x(以及5.x和2016.x也应正常工作)进行了测试。它支持Linux和macOS上的Python 3.9–3.12。

郭罗姆克斯包装器还提供了一组常用配方和辅助函数的小型库,用于设置MD模拟。

文档主要通过python文档字符串提供,可在https://gromacswrapper.readthedocs.org找到最新版本。

源代码可在GromacsWrapper git 仓库中获取。

请注意,该软件仅进行最小限度的维护,并且肯定包含错误。确保您使用合理的参数进行模拟是您的责任。

快速入门

给定一个PDB文件1iee.pdb,设置并运行一个简单的模拟(假设您已准备好所有其他输入文件,如MDP文件)

>>> import gromacs
>>> print(gromacs.release)
2018.2
>>> help(gromacs.pdb2gmx)
DESCRIPTION

gmx pdb2gmx reads a .pdb (or .gro) file, reads some database files,
adds hydrogens to the molecules and generates coordinates in GROMACS
...
...
OPTIONS

Options to specify input files:

-f      [<.gro/.g96/...>]  (eiwit.pdb)
          Structure file: gro g96 pdb brk ent esp tpr
...
...
>>> gromacs.pdb2gmx(f="1iee.pdb", o="protein.gro", p="topol.top",
...                 ff="oplsaa", water="tip4p")
>>> gromacs.editconf(f="protein.gro", o="boxed.gro",
...                  bt="dodecahedron", d=1.5, princ=True,
...                  input="Protein")
>>> gromacs.solvate(cp="boxed.gro", cs="tip4p", p="topol.top",
...                 o="solvated.gro")
>>> gromacs.grompp(f="emin.mdp", c="solvated.gro", p="topol.top",
...                o="emin.tpr")
>>> gromacs.mdrun(v=True, deffnm="emin")
>>> gromacs.grompp(f="md.mdp", c="emin.gro", p="topol.top", o="md.tpr")
>>> gromacs.mdrun(v=True, deffnm="md")

许可证

GromacsWrapper软件包根据GNU公共许可证v3(或您选择的任何更高版本)提供,除非以下所述。请参阅COPYING文件以获取所有模块的许可条款。

安装

版本

您可以使用以下方式安装来自PyPi的GromacsWrapper的最新版本:

pip install GromacsWrapper

或作为conda-forge软件包,通过conda从conda-forge通道安装

conda install -c conda-forge gromacswrapper

开发版本

GitHub源代码库中的main分支通常包含有用的代码,但仍然可能会以奇特而美妙的方式出现错误。请通过问题跟踪器报告问题。

要使用开发代码库:检出main分支

git clone https://github.com/Becksteinlab/GromacsWrapper.git

然后安装

pip install GromacsWrapper/

欢迎提交代码贡献。我们使用black进行统一代码格式化,请在您的代码上安装black并运行它。

下载和可用性

GromacsWrapper的主页是http://github.com/Becksteinlab/GromacsWrapper。该软件包的最新版本可通过https://github.com/Becksteinlab/GromacsWrapper/releases提供。

您还可以克隆GromacsWrapper git 仓库或为其自己的开发进行分支。

git clone git://github.com/Becksteinlab/GromacsWrapper.git

问题

请在讨论论坛(而不是私人电子邮件)中提问。

报告错误和为GromacsWrapper做出贡献

请使用问题跟踪器报告错误、安装问题和功能请求。在讨论论坛中提问。

拉取请求非常欢迎。有关如何提交拉取请求和为开源项目做出贡献的介绍,请参阅http://makeapullrequest.com

构建文档

安装Sphinx

pip install sphinx

然后编译

cd GromacsWrapper
python setup.py build_sphinx

引用

Latest release on zenodo (with DOI)

GromacsWrapper由Oliver Beckstein编写,许多其他人也做出了贡献。请参阅文件AUTHORS以获取所有名字。

如果您发现这个软件包很有用,并在已发表的论文中使用它,我将非常感激,如果它在正文中得到认可,如

“…使用GromacsWrapper(Oliver Beckstein等,https://github.com/Becksteinlab/GromacsWrapper doi: 10.5281/zenodo.17901)”

或在致谢部分。

谢谢。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

gromacswrapper-0.9.1.tar.gz (182.1 kB 查看哈希值)

上传时间 源代码

构建分发

GromacsWrapper-0.9.1-py3-none-any.whl (188.7 kB 查看哈希值)

上传时间 Python 3

由以下支持