Skip to main content

hafnian 计算的开源库

项目描述

测试 Codecov 覆盖率 CodeFactor 等级 阅读文档 PyPI - Python 版本 JOSS - 开源软件杂志

用于计算 hafnians、Hermite 多项式和高斯玻色子采样的库。有关详细信息,请参阅文档

特征

  • 快速计算一般和某些结构化矩阵的 hafnians、loop hafnians 和 torontonians。

  • 一个易于使用的界面,用于使用循环哈夫尼亚进行高斯量子态计算。

  • 图的 hafnian 和 torontonians 的采样算法。

  • 用于逼近非负矩阵的哈夫尼亚的有效经典方法。

  • 易于使用的多维 Hermite 多项式实现,也可用于计算给定矩阵的所有约简的哈夫尼亚。

安装

海象需要 Python 版本 3.7、3.8、3.9 或 3.10。可以使用 pip 安装海象以及所有依赖项:

pip install thewalrus

从源代码编译

海象有以下依赖关系:

您可以通过克隆 git 存储库并在开发模式下使用 pip 安装来编译最新的开发版本。

$ git clone https://github.com/XanaduAI/thewalrus.git
$ cd thewalrus && python -m pip install -e .

软件测试

为确保 The Walrus 库在安装后正常工作,可以使用 pytest 在本地运行测试套件。

运行测试需要额外的包。这些依赖项可以在 requirements-dev.txt中找到,并且可以使用pip安装:

$ pip install -r requirements-dev.txt

要运行测试,请导航到源代码文件夹并运行命令

$ make test

文档

Walrus 文档可在Read the Docs上在线获取。

如doc/requirements.txt中所指定,需要额外的包来在本地构建文档。可以使用以下方式安装这些软件包:

$ sudo apt install pandoc
$ pip install -r docs/requirements.txt

要构建 HTML 文档,请转到顶级目录并运行命令

$ make doc

然后可以在docs/_build/html/目录中找到该文档。

为海象做贡献

我们欢迎贡献 - 只需 fork The Walrus 存储库,然后发出包含您的贡献的拉取请求。The Walrus 的所有贡献者都将被列为发布的作者。

我们还鼓励错误报告、对新功能和增强功能的建议,甚至是使用 The Walrus 的项目、应用程序或科学出版物的链接。

作者

海象是许多贡献者的作品。

如果您正在使用 The Walrus 进行研究,请引用我们的论文

布拉杰什·古普特、乔什·艾萨克和尼古拉斯·克萨达。The Walrus:用于计算 hafnians、Hermite 多项式和高斯玻色子采样的库。开源软件杂志, 4(44), 1705 (2019)

支持

如果您遇到问题,请通过在我们的 Github 问题跟踪器上发布问题来告知我们。

执照

Walrus 是免费开源的,在 Apache 许可证 2.0 版下发布。

下载文件

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

源分布

thewalrus-0.19.0.tar.gz (106.9 kB 查看哈希)

已上传 source

内置分布

thewalrus-0.19.0-py3-none-any.whl (83.8 kB 查看哈希)

已上传 py3