tkwant 1.1.0

源代码

官方tkwant仓库是

• 源代码仓库： https://gitlab.kwant-project.org/kwant/tkwant.git

“master”分支包含当前的开发版本。

测试套件

可以直接在本地tkwant源代码仓库中通过命令行运行单元测试

pytest

需要更多时间运行的集成测试可以通过以下命令启动

pytest --integtest

涉及MPI的测试可以通过以下命令运行

pytest --mpitest

测试套件需要安装Python包pytest并编译tkwant。请访问安装说明。当安装了可选的pytest-flake8包时，可以激活额外的pep8合规性检查。

pytest --flake8

。

构建文档

可以从本地tkwant源存储库的doc文件夹中使用命令行直接构建文档。

make html

生成的HTML文档可以通过打开文件doc/build/html/index.html并在网页浏览器中浏览。要构建文档，需要安装额外的Python包。请访问安装说明。

贡献

我们始终欢迎对tkwant的贡献和反馈。如果您对文档有任何建议或发现新的错误，我们也表示感激。如果您想贡献新功能，请在提交合并请求之前，在邮件列表上自由讨论您的想法。此外，请确保在提交新的合并请求之前，tkwant测试套件没有错误。有关编码风格和一般建议，请参阅kwant的贡献部分。

作者

Tkwant是由以下作者开发的。

许可证

Tkwant在2-clause BSD许可证下分发。许可证也可以在项目存储库中的文件LICENSE.rst中找到。

文档

官方用户和开发者文档可以在以下位置找到：

• 稳定版：https://tkwant.kwant-project.org/doc/stable

• 开发版（master分支）：https://tkwant.kwant-project.org/doc/dev

沟通

kwant-discuss邮件列表是关于tkwant问题的主要沟通渠道。搜索和使用邮件列表的说明在邮件列表部分。

• 邮件列表：kwant-discuss@kwant-project.org

报告错误

如果您遇到可能是tkwant错误的问题，您可以使用问题跟踪器打开一个工单。

• 问题跟踪器：https://gitlab.kwant-project.org/kwant/tkwant/issues

请确保该问题尚未在已知tkwant错误列表中报告。您也可以在打开新的工单之前搜索邮件列表。有关一般建议，请参阅kwant的报告错误部分。

引用

如果您使用tkwant进行了导致科学出版物的工作，我们希望您引用介绍tkwant的出版物。

T. Kloss, J. Weston, B. Gaury, B. Rossignol, C. Groth和X. Waintal, Tkwant：一个用于时间依赖性量子传输的软件包 新物理杂志 23，023025 (2021)，arXiv:2009.03132 [cond-mat.mes-hall]。