结构多样性指数

该存储库包含用于快速数值计算结构多样性指数的代码

内容

该存储库包含四个 python 脚本：MeetingTimesUI、RandomWalkSimulatorCUDA、RandomWalkSimulator和MeetingTimeEstimator 以下是简要说明：

• MeetingTimeUI 为脚本提供用户界面
• RandomWalkSimulator 计算图上随机游走的会面时间。
• RandomWalkSimulatorCUDA 使用 CUDA 和 GPU 计算随机游走在图上的会面时间（对于大型图要快得多）。它需要 Cudatoolkit 才能运行。
• MeetingTimeEstimator 是一个类，它根据已经相遇的步行的会议时间，对两次未相遇的步行的会议时间进行有根据的猜测。

此处提供的文档中详细描述了每个脚本。如果您对快速入门教程感兴趣，请参阅下面的教程部分。

安装

这些脚本以名为structure_diversity_index的 python 包的形式提供。将包及其依赖项类型安装到终端中

pip install structural_diversity_index==0.0.5

这将在您的 python 包目录中安装包的 0.0.5 版本（最新）。

警告：通过 pip 安装包将不允许您使用在 GPU 上运行计算的脚本。有关如何在 GPU 上运行脚本计算的详细信息，请参见下文。

GPU 的安装

如果您对在 GPU 上运行计算不感兴趣，可以忽略此部分。

通过 pip 安装structure_diversity_index 包不能让您在 GPU 上运行计算。原因是Cudatoolkit不能通过pip安装（因为它不是python包）。

为了规避这个问题，可以使用包安装程序，例如conda。在计算机上安装 conda 后，从GitHub下载文件environment.yml。在终端中，转到包含您下载的 environment.yml 文件的目录并输入：

conda env create -f environment.yml

这将创建一个名为sd_index的 conda 环境，并安装在 GPU 上进行计算所需的所有依赖项。现在您可以设置 on_cuda=True （参见GitHub中的 Examples.ipynb ），计算将在 GPU 上运行。

教程

Jupyter 笔记本Example.ipynb（可在此处获得）包含详细教程，说明如何使用包结构多样性索引。

扩展代码

如果您对扩展、修改或简单地使用代码感兴趣，我已经使用 ReadTheDocs 创建了一个详细的文档，可在此处获得。玩得开心！