跳转到主要内容

适用于Kwant的适应性能带结构分析器

项目描述

kwantSpectrum是Kwant的一个扩展,用于自适应分析无限准一维系统的能带结构。能带结构通过分段三次多项式近似到任意精度。提供处理特殊点、区间和谱的周期性等功能。

kwantSpectrum在2条款BSD许可证下分发

网站: https://kwant-project.org/extensions/kwantspectrum

源代码: https://gitlab.kwant-project.org/kwant/kwantspectrum

Conda包: https://github.com/conda-forge/kwantspectrum-feedstock

安装

kwantSpectrum软件包托管在PyPI和conda上。安装应该适用于Debian和Ubuntu等GNU/Linux系统,以及MacOS和Windows。

PyPI:

python3 -m pip install --user kwantspectrum

conda:

conda install -c conda-forge kwantspectrum

从源代码安装

kwantSpectrum可以直接从源代码仓库安装

python3 -m pip install --user git+https://gitlab.kwant-project.org/kwant/kwantspectrum.git

对于开发,可以使用以下命令从官方仓库克隆kwantSpectrum

git clone https://gitlab.kwant-project.org/kwant/kwantspectrum.git

以下列出的要求必须手动安装。

构建要求

kwantSpectrum有以下非Python依赖项

Kwant可以使用以下命令安装

sudo apt-add-repository -s ppa:kwant-project/ppa
sudo apt-get update
sudo apt-get install python3-kwant

kwantSpectrum至少需要Python 3.5。以下包必须安装以构建kwantSpectrum

这些包可以通过标准 pip 命令进行安装。

python3 -m pip install --user numpy scipy

测试需求

kwantSpectrum 测试套件需要以下 Python 包

这些包可以通过标准 pip 命令进行安装。

python3 -m pip install --user pytest pytest-cov

文档需求

构建文档需要以下 Python 包

这些包可以通过标准 pip 命令进行安装。

python3 -m pip install --user matplotlib sphinx jupyter-sphinx

测试套件

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

pytest

构建文档

可以在本地源代码库的 /doc 文件夹中直接从命令行构建文档

make html

生成的 HTML 文档可以通过打开文件 doc/build/html/index.html 并使用网页浏览器进行浏览。

文档

包括教程在内的完整文档

沟通

kwant-discuss 邮件列表是 kwantSpectrum 问题和讨论的主要沟通渠道。在 邮件列表 部分解释了如何搜索和使用邮件列表。

此外,作者可以通过电子邮件联系,详情如下。

贡献

贡献和反馈始终受到欢迎。通过项目代码库报告错误并跟踪开发。作者可以通过电子邮件联系,或可在项目网站上打开合并请求。在打开新的合并请求之前,请确保测试套件无错误运行。

许可证

kwantSpectrum 在 BSD 许可下分发,请参阅项目代码库中的 LICENSE.rst 文件。

作者

kwantSpectrum 的主要开发者是

项目的贡献者包括

  • 克里斯托夫·格罗特 (CEA 格勒诺布尔)

  • 泽维尔·瓦伊塔尔 (CEA 格勒诺布尔)

  • 本诺特·罗斯诺 (CEA 格勒诺布尔)

  • 巴斯·尼霍尔特 (微软)

(CEA = 原子能和替代能源委员会)

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源代码分发

kwantspectrum-0.1.1.tar.gz (35.6 kB 查看哈希值)

上传时间:

构建分发

kwantspectrum-0.1.1-py3-none-any.whl (21.9 kB 查看哈希值)

上传时间: Python 3

由以下机构支持