Cython Based Fast FES Calculation Toolkit.
Project description
CyFES:GPU加速高性能数据透视工具
介绍
这是一个使用Cython+CUDA+Python编写的高性能FES计算软件,可以用于加速数据透视的计算:
$$ E(x)=-kT\log\left(\frac{\sum_{j=1}^Ne^{\frac{V_j}{kT}}e^{-\frac{(x-n_j)^2}{2}}}{N\Pi_i\sqrt{2\pi}\sigma_i}\right) $$
安装
pip安装
本项目可以直接使用pip进行安装:
$ python3 -m pip install cyfes --user --upgrade -i https://pypi.org/simple
源码安装
首先将本仓库clone到本地:
$ git clone https://gitee.com/dechin/cy-fes.git && cd cy-fes/
然后直接运行setup.py
进行安装:
$ python3 -m pip install .
安装测试
在本仓库的test路径下存放了一个测试用例,用于测试cyfes是否安装成功。用户可以直接简单的运行:
$ python3 tests/test_path_fes.py
[0.00892185 0. 0.09578881 0.01997518]
[0.06397188 0. 0.09973657 0.04956698]
[0.04098002 0.10183226 0.03498954 0. ]
若输出为多个数组,则表示安装成功。也可以使用单元测试运行,但是这需要在本地先安装pytest
:
$ python3 -m pip install pytest
然后直接在仓库的根目录下运行:
$ py.test
=================================== test session starts ====================================
platform linux -- Python 3.7.5, pytest-7.4.4, pluggy-1.2.0
rootdir: /home/cy-fes
collected 3 items
tests/test_path_fes.py ... [100%]
==================================== 3 passed in 5.39s =====================================
没有报错,则表示安装成功。
使用方法
在安装成功后,可以直接在Python脚本中调用:
import numpy as np
from cyfes import PathFES
np.random.seed(0)
def test_path_fes():
atoms = 4
cvs = 10000
crd = np.random.random((atoms, 3))
cv = np.random.random((cvs, 3))
bw = np.random.random(3)
bias = np.random.random(cvs)-1
fes = np.asarray(PathFES(crd, cv, bw, bias))
print (fes)
if __name__ == '__main__':
test_path_fes()
还可以使用命令行模式:
$ python3 -m cyfes --help
usage: __main__.py [-h] [-i I] [-ic IC] [-ib IB] [-s S] [-e E] [-g G] [-o O]
[-f32 F32] [-sigma SIGMA]
optional arguments:
-h, --help show this help message and exit
-i I Set the input record file path.
-ic IC Set the cv index of input record file. Default: 0,1,2
-ib IB Set the bias index of input record file. Default: 3
-s S CV length. Default: None
-e E Edge length. Default: 1.0
-g G Grid numbers. Default: 10,10,10
-o O Set the output FES file path.
-f32 F32 Use float32. Default: false
-sigma SIGMA Sigma value when calculating FES. Default: 0.3
假如我们有一个三维的CV,那么最简单的运行方式为:
$ python3 -m cyfes -i /home/Data/xyz_bias.txt -o ./work_dir/z.cub
那么最后产生的文件内容为:
$ head -n 10 work_dir/z.cub
Generated by CyFES
Total 1000 grids
1 21.6622 19.8498 42.3652
10 6.40465 0 0
10 0 7.02147 0
10 0 0 6.33118
1 1.000000 53.6854 54.9571 74.0211
450 450 450 450 450 450
450 450 450 450 450 450
450 450 70.0855 70.848 450 450
该cube格式的文件可以在支持的软件(如VMD)中进行可视化操作。
已知问题
- 使用numpy==1.22.2的版本中会出现
ImportError: numpy.core.multiarray failed to import
问题。解决方案:升级numpy版本:python3 -m pip install numpy --upgrade
。 - 执行
python3 -m cyfes --help
报错ModuleNotFoundError: No module named 'cyfes.wrapper'
,这是因为执行命令的目录下存在名为cyfes
的文件夹,需要切换执行命令的位置。 - 使用cyfes出现
Segmentation fault
段错误问题,是因为找不到编译好的动态链接库文件,大概率是系统环境下权限不足,没有site路径的权限,可以使用如下脚本进行检查:
# check_dynamics.py
import os
import site
from pathlib import Path
site_path = Path(site.getsitepackages()[0])
site_file_path = site_path.parent.parent.parent / 'cyfes' / 'libcufes.so'
site_dynamics_path = str(site_file_path)
user_site_path = Path(site.USER_SITE)
user_file_path = user_site_path.parent.parent.parent / 'cyfes' / 'libcufes.so'
user_dynamics_path = str(user_file_path)
if not os.path.exists(site_dynamics_path) and not os.path.exists(user_dynamics_path):
print ('Check dynamics complete, no libcufes.so file founded!')
else:
print ('Installation of CyFES success!')
使用python3运行该脚本,即可判断动态链接库是否被正确安装。
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
CyFES-2.7.tar.gz
(345.4 kB
view hashes)
Built Distributions
Close
Hashes for CyFES-2.7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c7a27665ee191dcbbae4a2316ddcecd004b16e6b5b1d43894925dc79315dcb8 |
|
MD5 | f8b07d703cfc8dd9d7093ab387804fed |
|
BLAKE2b-256 | 7353db88ecb6b77af1f5e8a6a898850ce228f2ba7e4cebe001ed2cd72a2368f7 |
Close
Hashes for CyFES-2.7-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1567e06fea883b4dba01d8ef4fff54cc7565a460ae94c7fc3d9761c78b7fbd4 |
|
MD5 | 78fc1d42245fc53b2822f622484872ed |
|
BLAKE2b-256 | 54493e76513a6005de743b6678dccedd6b5eb11efdce99a7f3b188e28af0b536 |
Close
Hashes for CyFES-2.7-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e14c359ec516475cf7695d46cd7da00c886608ac965024c7fe03e38a482f8d7e |
|
MD5 | bb20f19e11471f42353c67b0cf4f33be |
|
BLAKE2b-256 | d81122bb35b1bb44cff3c11ef9e04a24811a048f44732356019c9e96d2fe3209 |
Close
Hashes for CyFES-2.7-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6fd400d2811c9368dd3e232bffcfd423ba6757ec39e90e43ea967f896e276a38 |
|
MD5 | 7791139c2abb35dcbb9a3b5613705f42 |
|
BLAKE2b-256 | 27355c192d9ce312963731495eaad21bf59c5bb10d81d13c800ee316639a1fbf |