Vesin: 原子系统的快速邻近列表

英语 🇺🇸⁠/⁠🇬🇧	奥克语	法语 🇫🇷	阿尔普语	加洛-意大利语	加泰罗尼亚语	西班牙语 🇪🇸	意大利语 🇮🇹
邻近者	vesin	voisin	vesin	visin	veí	vecino	vicino

Vesin是一个C库，用于计算原子系统的邻近列表，并力求快速且易于使用。我们还提供了一个Python包来调用C库。

安装

要从Python使用代码，您可以使用pip安装它

pip install vesin

有关如何将代码安装到C或C++以使用的更多信息，请参阅文档

使用说明

您可以使用NeighborList计算器类

import numpy as np
from vesin import NeighborList

# positions can be anything compatible with numpy's ndarray
positions = [
    (0, 0, 0),
    (0, 1.3, 1.3),
]
box = 3.2 * np.eye(3)

calculator = NeighborList(cutoff=4.2, full_list=True)
i, j, S, d = calculator.compute(
    points=points,
    box=box,
    periodic=True,
    quantities="ijSd"
)

我们还提供了一种与ASE邻接列表兼容的函数。

import ase
from vesin import ase_neighbor_list

atoms = ase.Atoms(...)

i, j, S, d = ase_neighbor_list("ijSd", atoms, cutoff=4.2)

有关如何使用C或C++代码的更多信息，请参阅文档。

基准测试

以下基准测试结果计算了用于越来越大钻石超原胞的邻接列表，使用AMD 3955WX CPU和NVIDIA 4070 Ti SUPER GPU。您可以使用位于benchmarks/benchmark.py的脚本在您的系统上运行此基准测试。缺失的点表示特定的代码无法进行计算（例如，NNPOps需要单元格大小是截止值的两倍，因此无法与大型截止值和小型单元格一起运行）。

许可证

Vesin是在3条款BSD许可下分发的。通过为该代码做出贡献，您同意在相同的许可下分发您的贡献。