Kwant导联自适应带结构分析仪
kwantspectrum的Python项目详细描述
宽谱是Kwant的一个扩展 自适应分析无限准一维系统的能带结构。这个 用分段三次逼近能带结构的任意精度 多项式。处理特殊点、间隔和 给出了光谱的周期性。在
宽谱分布在2-clause BSD license下
网址:https://kwant-project.org/extensions/kwantspectrum
源代码:https://gitlab.kwant-project.org/kwant/kwantspectrum
安装
本节介绍在GNU/Linux上安装kwantSpectrum 系统名为Debian和Ubuntu。在
要求
kwantSpectrum具有以下非Python依赖性:
可以使用以下命令安装Kwant:
sudo apt-add-repository -s ppa:kwant-project/ppa sudo apt-get update sudo apt-get install python3-kwant
kwantSpectrum至少需要Python3.5。以下包装必须 安装以建立广谱:
大多数软件包都可以从命令行安装 通过标准Python包管理器pip通过:
^{pr2}$测试要求
kwantSpectrum测试套件需要以下Python包:
这些包可以通过标准的pip命令安装:
sudo pip3 install pytest pytest-cov pytest-flake8
文件要求
构建文档需要以下Python包:
这些包可以通过标准的pip命令安装:
sudo pip3 install matplotlib sphinx jupyter-sphinx
建设广谱
kwantSpectrum可以从PyPI安装,并带有:
sudo pip3 install kwantspectrum
或者,也可以直接从源代码存储库安装:
sudo pip3 install git+https://gitlab.kwant-project.org/kwant/kwantspectrum.git
为便于开发,可从官方存储库克隆kwantSpectrum:
git clone https://gitlab.kwant-project.org/kwant/kwantspectrum.git
测试套件
可以从命令行直接在本地源存储库中运行单元测试:
pytest
构建文档
文档可以直接构建在 从命令行执行本地源存储库:
make html
生成的html文档可以浏览 通过使用web浏览器打开文件doc/build/html/index.html。在
贡献
我们欢迎大家提供意见和反馈。 报告错误并通过项目存储库跟踪开发。 可以通过电子邮件联系作者 或者合并请求可以在项目的网站上打开。 请确保测试套件在打开之前运行无错误 新的合并请求。在
许可证
kwantSpectrum是根据BSD许可证分发的,请参阅文件LICENSE.rst 在项目存储库中。在
- 项目
标签: