安装

使用MLatom最便捷的方法是无需安装直接在 XACS云平台 上运行。如果您有需要，可以按照以下说明安装MLatom。这里我们提供了一个视频来演示如何安装和使用MLatom。

MLatom is a Python package and can be easily installed and upgraded using pip:

pip install --upgrade mlatom

安装结束后，用户还需要在Python环境中安装所需的依赖项，具体如下所述。

依赖项

最小设置

pip install numpy scipy torch torchani tqdm matplotlib statsmodels h5py pyh5md

有用的可选模块

pip install sgdml rmsd openbabel xgboost scikit-learn pyscf rmsd rdkit pandas \
   ase fortranformat tensorflow geometric

完整的Anaconda环境设置

下载 mlatom.yml 。

然后，

conda create -N mlatom --file mlatom.yml
conda activate mlatom

附加软件包

许多MLatom的功能依赖于其他第三方软件包，这些软件包不是Python模块，需要根据 提示 单独安装和设置。

目前可选的第三方软件包如下所示（按字母顺序排列），用户可根据需要单独安装以启用特定功能。

  • ASE （可用于几何优化和热化学计算）

  • COLUMBUS （使用CASSCF时需要安装）

  • DeePMD-kit （能够实现几个机器学习势）

  • dftd4 （使用D4色散校正时需要安装，使用AIQM1，ANI-2x-D4和ANI-1x-D4时需要安装）

  • GAP and QUIP （使用GAP-SOAP机器学习势时需要安装）

  • Gaussian （可用于QM计算、几何优化、频率和热化学计算，运行IRC和非谐波频率计算时需要安装）

  • hyperopt （可用于超参数优化）

  • MACE （使用MACE势时需要安装）

  • MNDO （可用于/推荐用于AIQM1以及其他半经验QM方法）

  • Newton-X （进行紫外可见光谱模拟时需要安装）

  • Orca （使用CCSD(T)*/CBS时需要安装，可用于DFT计算）

  • PhysNet （使用PhysNet势时需要安装）

  • sGDML （使用sGDML势时需要安装）

  • Sparrow （可用于/推荐用于AIQM1以及其他半经验QM方法）

  • TorchANI （使用AIQM1和ANI势时需要安装）

  • Turbomole （进行ADC(2)计算时需要安装）

COLUMBUS

CASSCF计算需要安装COLUMBUS 7。可以按照 该程序网站 上的说明获取并安装。

必须设置环境变量 COLUMBUS 才能在MLatom上运行，例如：

export COLUMBUS=[使用runc可执行文件到COLUMBUS目录的路径]

Turbomole

进行ADC(2)计算需要安装Turbomole。可以按照 该程序网站 上的说明获取并安装。

必须设置环境变量 TURBODIR 才能在MLatom上运行，例如：

Orca

Orca is required for CCSD(T)*/CBS calculations and can be used for DFT calculations. Here we use Orca 4.2.0. It can be obtained and installed as described on the program website.

必须设置环境变量 orcabin 才能在MLatom上运行，例如：

export orcabin=[Orca可执行文件的路径]

DFTB+

Using the conda command is the recommended installation method:

conda install conda-forge::dftbplus

Alternatively, you can also install it by downloading the binary from https://www.dftbplus.org/download/stable.html or compiling from source:

git clone https://github.com/dftbplus/dftbplus.git
cmake --build _build -- -j
cmake --install _build

After installation, you need to download the DFTB+ parameter files (also called Slater–Koster files). Once downloaded, extract the files and add their path to your environment variable as (in bash):

export skfiles=/path/to/SK/files

Newton-X

计算 ML-NEA 需要 Newton-X 。

  1. 安装 Newton-X （NX，最好是使用我们测试过的2.2版本）

  2. 使用 export NX=/path/to/Newton-X 来定义 $NX

TorchANI

使用AIQM1和ANI系列需要TorchANI。

  1. 安装Numpy和PyTorch的夜间版本（如果您还没有安装）：

pip install numpy tensorboard
pip install --pre torch torchvision -f https://download.pytorch.org/whl/nightly/cu100/torch_nightly.html

  1. 安装TorchANI：

pip install torchani

更多信息请访问 https://aiqm.github.io/torchani/ 。我们测试过的最新版本TorchANI是v2.2，如果使用最新版本的TorchANI运行时有任何问题，您可以通过 pip install torchani==2.2 安装v2.2版本。AIQM1和ANI-1ccx的神经网络部分目前不支持用于AEV计算的CUDA扩展。

DeePMD-kit

使用DPMD和DeepPot-SE需要DeePMD-kit。

  1. 从 GitHub 下载DeePMD-kit安装程序（已测试v1.2.2版本）

  2. 运行安装程序

  3. 添加环境变量 $DeePMDkit ，指向dp二进制文件所在的位置（ bin/ 在你的安装目录中），例如 export DeePMDkit=/export/home/fcge/deepmd-kit-1.2/bin 。

GAP和QUIP

使用GAP-SOAP需要GAP和QUIP

  1. 从源代码编译QUIP和GAP

1.1 安装前提条件

sudo apt-get install gcc gfortran python python-pip libblas-dev liblapack-dev # for system uses apt, do equivalent for your OS
pip install numpy ase f90wrap

1.2 获取QUIP和GAP的源代码

git clone --recursive https://github.com/libAtoms/QUIP.git

从 http://www.libatoms.org/gap/gap_download.html 获取GAP的源代码(需要填写表单)。

然后将源代码放到 QUIP/src/ 中。

1.3 编译

cd QUIP
export QUIP_ARCH=linux_x86_64_gfortran_openmp # enable multi-threading, use 'export QUIP_ARCH=linux_x86_64_gfortran' if no OpenMP thus no MT capability
export QUIPPY_INSTALL_OPTS=--user # omit for a system-wide installation
make config

输入 Y 或用 HAVE_GAP=1 编辑 build/linux_x86_64_gfortran/Makefile.inc ，然后： make 。编译好的二进制文件位于 QUIP/build/linux_x86_64_gfortran/quip 和 QUIP/build/linux_x86_64_gfortran/gap_fit 中。

  1. 为quip和gap-fit添加环境变量 $quip 和 $gap_fit ，例如：

export quip='/export/home/fcge/GAP-SOAP/QUIP/build/linux_x86_64_gfortran_openmp/quip'
export gap_fit='/export/home/fcge/GAP-SOAP/QUIP/build/linux_x86_64_gfortran_openmp/gap_fit'

更多信息请访问 https://libatoms.github.io/GAP/index.html 。

PhysNet

PhysNet模型需要PhysNet。

  1. 从PhysNet的GitHub页面克隆

git clone https://github.com/MMunibas/PhysNet.git

  1. 安装TensorFlow：

pip install tensorflow

  1. 如果您使用的是TensorFlow的v2版本，需要在PhysNet的目录中执行下面的命令，使脚本和TFv2兼容。

for i in `find . -name '*.py'`; do sed -i -e 's/import tensorflow as tf/import tensorflow.compat.v1 as tf\ntf.disable_v2_behavior()/g'
-e 's/import tensorflow as tf/import tensorflow.compat.v1 as tf\ntf.disable_v2_behavior()/g' $i; done

  1. 在目录中添加环境变量 $PhysNet ，例如：

export PhysNet=/export/home/fcge/PhysNet/

sGDML

使用GDML和sGDML模型需要sGDML。

  1. 安装sGDML

pip install sgdml==0.4.4

  1. 将sGDML二进制文件的路径添加到环境变量 $sGDML ，例如：

export sGDML=/export/home/fcge/.linuxbrew/bin/sgdml

更多信息请访问 http://quantum-machine.org/gdml/doc/ 。

备注

在我们的测试中，我们发现使用 pip install scipy==1.7.1 安装会更稳定。

MACE

使用MACE的前提：

pip install --upgrade mace-torch

警告

MLatom versions >3.13 works with MACE-Torch 0.3.8. If you encounter any problem, you can install these versions via pip install mace-torch==0.3.8.

MLatom versions ≤3.13 works with version 0.3.2 of MACE according to our tests. If, for some reason, you need to downgrade MACE, it is not that straightforward because you would need to find the related commit on github. The old installation instructions which will not work but you can try to adjust:

  1. 从GitHub上克隆MACE

git clone https://github.com/ACEsuit/mace.git

  1. 通过pip安装MACE

pip install ./mace

MNDO

AIQM1的ODM2*部分需要MNDO。或者，将来也可以使用 SCINE Sparrow 的 开发版本 （请参见关于Sparrow的一篇 文章 ；Sparrow的开发版本也实现了单点AIQM1计算）。

MNDO程序的免费二进制文件和开源代码可从MNDO官网获取，详情请访问 https://mndo.kofo.mpg.de 。

安装MNDO程序后，需要设置指向MNDO可执行文件(通常为 mndo99 )的环境变量，例如，在bash中：

export mndobin=[path to the executable]/mndo99

Sparrow

SCINE Sparrow 程序可用于提供许多半经验方法。有关安装说明，请参阅其网站。

请注意， 开发版本的Sparrow 也可以代替MNDO程序来提供AIQM1的ODM2*部分，但最大的问题在于它目前没有分析梯度。有关详细信息，请参阅有关 Sparrow的论文 。Sparrow的开发版本也实现了单点AIQM1计算。但由于开发版的Sparrow安装难度较大，所以如果需要使用开发版的Sparrow进行AIQM1单点计算时，我们建议在XACS云平台上进行。

dftd4

AIQM1的D4部分需要dftd4。

dftd4程序可以作为可执行代码和开源代码 获得 。我们建议使用 dftd4 v3.5.0 (MLatom 3.0.1之前的版本使用 dftd4 v2.5.0 )，它可以计算热化学计算所需的Hessian。要从源代码安装dftd4程序，请参阅dftd4 GitHub页面上的README.md文件的更多详细信息。

安装dftd4程序后，需要设置指向 dftd4 可执行文件的环境变量，例如，在bash中：

export dftd4bin=[path to the executable]/dftd4

Gaussian

几何优化、频率分析、搜寻过渡态、IRC、热化学和ML-NEA需要Gaussian 。这些任务也可以使用ASE，见下文。

Gaussian 09和Gaussian 16均支持使用。它是一个商业程序，用户可以单独 获取和安装 。

如需使用高斯接口，请确保环境变量 $GAUSS_EXEDIR 指向正确的位置。

ASE

几何优化，频率和热化学需要ASE。也可以使用Gaussian，见上文。

ASE(原子模拟环境)是Python模块，可以根据 ASE website 网站上的描述进行安装，即：

pip install ase

hyperopt

如果需要启用hyperopt，请执行 pip install hyperopt 命令安装 hyperopt 包。