目录 由DocToc生成

• e3psi
  • 关于
  • 开发
    • 首先
    • 入门
    • 测试
    • 贡献

e3psi

关于

电子结构学习等变机器学习库

开发

首先

您可以在Windows、GNU/Linux或Mac OS X上开发。您需要

• Python 3.6及以上版本和python虚拟环境。
• Git

入门

首先，Fork此仓库，然后启动您的命令提示符并...

1. 克隆Forked仓库
2. 导航到克隆的项目目录：cd e3psi
3. 激活您的python虚拟环境并pip install -r requirements.txt。
4. pre-commit安装
5. pre-commit install --hook-type commit-msg
6. pre-commit run --all-files

现在您可以开始编写代码了。

测试

只需运行pytest。对于更详细的信息，包括测试覆盖率

pytest -vv --cov=. --cov-report term-missing

贡献

如果您想为项目做出贡献

• 如果您正在贡献代码，请尝试为您的代码编写一些测试，并确保测试通过。
• 通过 cz commit 提交您的更改。按照提示操作。完成后，将调用 pre-commit 来确保您的贡献和提交遵循定义的约定。有关更多信息，请参阅 pre-commit-config.yaml。
• 您的提交消息应遵循此处描述的约定 （此处）。请用祈使句编写提交消息：“修复错误”而不是“已修复错误”或“修复错误”。此约定与 git merge 和 git revert 等命令生成的提交消息相匹配。完成后，请创建一个 拉取请求。