aiida-ssh2win

一个允许AiiDA在Windows机器上运行计算的传输插件。

此插件是AiiDA插件切割器的默认输出，旨在帮助开发人员开始他们的AiiDA插件。

仓库内容

• .github/: Github Actions配置
  • ci.yml: 在每次新提交时运行测试、检查测试覆盖率和构建文档
  • publish-on-pypi.yml: 自动将git标签部署到PyPI - 只需为您的PyPI账户生成一个PyPI API令牌并将其添加到github仓库的pypi_token秘密中
• aiida_ssh2win/: 插件包的主要源代码
  • transport.py: 包含SshToWindowsTransport - AiiDA的Transport接口的具体实现
• docs/: 准备在Read the Docs上发布的文档模板
• tests/: 使用pytest框架进行单元测试。安装pip install -e .[testing]并运行pytest。
• .gitignore: 告诉git忽略哪些文件
• .pre-commit-config.yaml：预提交钩子的配置，用于清理代码风格和检查语法错误。预提交钩子。通过以下命令启用：pip install -e .[pre-commit] && pre-commit install
• .readthedocs.yml：为Read the Docs的文档构建配置
• LICENSE：您插件的许可证
• README.md：此文件
• conftest.py：pytest的固定配置
• pyproject.toml：用于在PyPI和AiiDA插件注册表（包括入口点）注册的Python包元数据

安装

pip install aiida-ssh2win
verdi quicksetup  # better to set up a new profile
verdi plugin list aiida.transports  # should now show the `ssh2win` plugins

用法

许可证

MIT

联系

edan.bainglass@gmail.com