rustworkx

构建状态

您可以在以下网址查看完整的渲染文档： https://www.rustworkx.org/

一个用Rust编写的高性能、通用的Python图库。

使用方法

安装完成后，只需导入rustworkx即可。所有图类和顶层函数都可以通过单个导入访问。为了说明这一点，以下示例计算了无向图中节点A和C之间的最短路径。

import rustworkx

# Rustworkx的无向图类型
graph = rustworkx.PyGraph()

# 每次调用add_node时，都会返回一个新的节点索引
a = graph.add_node("A")
b = graph.add_node("B")
c = graph.add_node("C")

# add_edges_from接受节点索引和权重的元组，
# 并返回边索引
graph.add_edges_from([(a, b, 1.5), (a, c, 5.0), (b, c, 2.5)])

# 返回路径 A -> B -> C
rustworkx.dijkstra_shortest_paths(graph, a, c, weight_fn=float)

安装rustworkx

rustworkx已发布在PyPI上，因此在x86_64、i686、ppc64le、s390x和aarch64 Linux系统、Mac OSX上的x86_64以及32位和64位Windows上，安装非常简单，只需运行：

pip install rustworkx

这将在您的Python环境中安装一个预编译版本的rustworkx。

在没有预编译二进制文件的平台上安装

如果您的系统没有发布预编译的二进制文件，您需要从源代码构建包。然而，要能够从发布的源代码包构建，您需要安装Rust >= 1.70（以及通常随Rust一起提供的cargo）。您可以使用rustup（一个跨平台的Rust安装程序）来简化这个过程，或者依赖于其他安装方法。源代码包也发布在PyPI上，所以您仍然可以运行上述pip命令来安装它。一旦您正确安装了Rust，运行：

pip install rustworkx

将从源代码包构建适用于您本地系统的rustworkx并安装它，就像有预构建的二进制文件可用一样。

[!注意]
要从源代码构建，您需要确保安装了支持PEP-517的pip 19.0.0或更高版本，或者在运行pip install rustworkx之前手动安装了setuptools-rust。如果您收到有关找不到setuptools-rust的错误，应该使用pip install -U pip升级pip，或者使用pip install setuptools-rust手动安装setuptools-rust，然后重试。

可选依赖

如果您计划使用rustworkx.visualization模块，您需要安装可选依赖项来使用这些函数。基于matplotlib的绘图函数rustworkx.visualization.mpl_draw需要安装matplotlib库。可以通过pip install matplotlib安装，或在安装rustworkx时使用pip install 'rustworkx[mpl]'安装。如果您要使用基于graphviz的绘图函数rustworkx.visualization.graphviz_drawer，首先需要安装graphviz，安装说明可以在这里找到：https://graphviz.org/download/#executable-packages。然后您需要安装[pillow](https://python-pillow.org/) Python库。可以通过pip install pillow安装，或在安装rustworkx时使用pip install 'rustworkx[graphviz]'安装。

如果您想在安装rustworkx时安装所有可选的Python依赖项，可以使用pip install 'rustworkx[all]'来完成。

作者和引用

rustworkx是许多人在不同层面为项目做出贡献的成果。如果您在研究中使用rustworkx，请按照包含的BibTeX文件引用我们的论文。

社区

除了GitHub互动（如提出问题）外，还有两个地方可以与其他rustworkx用户和开发者交流。第一个是Qiskit工作空间中的公共Slack频道#rustworkx。您可以在这里加入Qiskit Slack工作空间。此外，在OFTC IRC网络上还有一个IRC频道#rustworkx。

从源代码构建

从源代码构建rustworkx的第一步是在本地克隆它：

git clone https://github.com/Qiskit/rustworkx.git

rustworkx使用PyO3和setuptools-rust来构建Python接口，这使得可以使用标准的Python工具进行操作。所以，假设您已经安装了rust，您可以轻松地使用pip将rustworkx安装到您的Python环境中。一旦您在本地克隆了仓库，将当前工作目录更改为仓库的根目录。然后，您可以使用以下命令将rustworkx安装到您的Python环境中：

pip install .

假设您的当前工作目录仍然是仓库的根目录。否则，您可以运行：

pip install $PATH_TO_REPO_ROOT

这将以相同的方式安装它。然后rustworkx就安装在您的本地Python环境中了。使用这种方法时需要注意两点：首先，如果您尝试从仓库根目录运行Python，它将无法按预期工作。这是因为在仓库根目录中存在名称冲突，这是由于在构建包时使用了本地Python包垫片。只需在仓库根目录之外运行使用rustworkx的Python脚本或程序即可。第二个问题是，您对rust代码所做的任何本地更改不会立即反映在您的Python环境中，您需要通过重新运行pip install来重新编译rustworkx，以使任何更改反映在您的Python环境中。

开发模式

如果您想在调试模式下构建rustworkx并在进行更改时使用交互式调试器，可以使用python setup.py develop在开发模式下构建和安装rustworkx。这将在不进行优化的情况下构建rustworkx，并包含调试信息，这对调试很有帮助。请注意，以这种方式安装rustworkx的速度将明显慢于使用pip install，应该只用于调试/开发。

[!提示] 值得注意的是，pip install -e不起作用，因为它只会将Python打包垫片链接到您的Python环境，但不会构建rustworkx二进制文件。如果您想在调试模式下构建rustworkx，必须使用python setup.py develop。

项目历史

Rustworkx最初被称为retworkx，最初创建它是为了替代Qiskit之前（及当前）使用的NetworkX（因此有了最初的名字）。这个项目最初是为了构建一个更快的有向图，用作qiskit转译器核心的DAG底层数据结构。然而，自从最初引入以来，这个项目已经大幅发展，现在涵盖了所有需要处理图的应用，包括Qiskit在内。