这是phonopy模块。

导航

验证详情

这些详情已由PyPI验证
维护者
Avatar for atztogo from gravatar.com atztogo Avatar for jochym from gravatar.com jochym Avatar for lan496 from gravatar.com lan496

未验证详情

这些详情尚未由PyPI验证
项目链接
元数据
  • 许可证：版权（c）2014-2024，Phonopy。保留所有权利。源代码和二进制的再分发和使用...
  • 作者： Atsushi Togo
  • 需要： Python >=3.8
  • 提供额外功能： cp2k, seekpath, symfc, pypolymlp, tools

项目描述

Version Badge Downloads Badge PyPI codecov

Phonopy

主要用Python编写的声子代码。Phonopy用户文档可在http://phonopy.github.io/phonopy/找到

安装

查看https://phonopy.github.io/phonopy/install.html。

依赖项

查看requirements.txt。可选地，symfc、scipy和seekpath对于使用附加功能是必需的。

提问邮件列表

通常的Phonopy问题应发送到Phonopy邮件列表（https://sourceforge.net/p/phonopy/mailman/）。

开发

Phonopy的开发在github phonopy仓库的develop分支上管理。

  • Github问题讨论区是讨论Phonopy问题的地点。
  • Github pull request是请求合并源代码的地点。

格式化

格式化规则位于 pyproject.toml 文件中。

pre-commit

Pre-commit (https://pre-commit.git-scm.cn/) 主要用于自动应用格式化规则。因此，强烈建议在或之前使用git-commit。Pre-commit的设置和使用方法如下：

  • 通过 pip install pre-commit、conda install pre_commit 或查阅 https://pre-commit.git-scm.cn/#install 进行安装。
  • 通过 pre-commit install 安装 pre-commit 挂钩。
  • 通过 pre-commit run --all-files 运行 pre-commit 挂钩。

除非运行 pre-commit，否则 pre-commit.ci 可能会通过 github action 在 PR 中推送修复。在这种情况下，修复应该由贡献者的存储库合并。

VSCode 设置

  • 不是严格意义上，但 VSCode 的 settings.json 可能如下所示

    "ruff.lint.args": [
    "--config=${workspaceFolder}/pyproject.toml",
],
"[python]": {
    "editor.defaultFormatter": "charliermarsh.ruff",
    "editor.codeActionsOnSave": {
        "source.organizeImports": "explicit"
    }
},

文档

Phonopy 用户文档使用 python sphinx 编写。源文件存储在 doc 目录中。请参阅 doc/README.md 了解如何编写文档。

如何运行测试

测试使用 pytest 编写。要运行测试，必须安装 pytest。可以通过以下方式运行测试：

% pytest

由以下支持