py4vasp

请注意，本文档主要面向希望使用 Github 上提供的 py4vasp 版本的开发人员。如果你只是想安装 py4vasp 使用它，请按照官方文档。

安装

我们使用诗歌依赖管理器来处理所有依赖关系并维护一个虚拟环境来检查代码。如果您想在虚拟环境中测试某些东西，只需使用 eg poetry run jupyter-notebook。

使用诗歌安装和代码需要以下步骤。最后一步将测试一切是否正常

git clone git@github.com:vasp-dev/py4vasp.git
pip install poetry
poetry install
poetry run pytest

请注意，这会将 py4vasp 安装到由诗歌管理的虚拟环境中。这会将代码与您安装的所有其他软件包隔离开来，并确保在您修改代码时跟踪所有相关的依赖项。

有时，我们在以这种方式安装mdtraj依赖项时遇到错误，尤其是在 MacOS 和 Windows 上。如果您发现相同的行为，我们建议您使用 conda 管理您的环境并按以下方式安装py4vasp

git clone git@github.com:vasp-dev/py4vasp.git
conda create --name py4vasp-env python=3.8
conda activate py4vasp-env
conda install -c conda-forge poetry
conda install -c conda-forge mdtraj
poetry config virtualenvs.create false --local
poetry install
poetry run pytest

代码风格

代码风格是强制的，但开发人员不应该花时间在上面，所以我们决定使用黑色格式化程序。请black .在提交代码之前运行。

为 py4vasp 做贡献

我们欢迎对 py4vasp 的贡献。要改进代码，请遵循此工作流程

• 为您计划处理的错误修复或功能创建一个问题，这提供了在投入工作之前提供一些输入的选项。
• 在存储库的分支中实施您的工作并为其创建拉取请求。请确保彻底测试您的代码并在测试目录的拉取请求中提交测试。
• 在您的合并请求消息中提及代码试图解决的问题。
• 当所有测试都通过并且您的代码被测试覆盖时，我们将尝试快速包含您的合并请求。

请将拉取请求的大小限制为大约 200 行代码，否则审查更改会变得笨拙。如有必要，最好将工作分成多个较小的块。