1 Star 0 Fork 0

索鹏飞/xDeepH

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
LGPL-3.0

xDeepH


The current code is the implementation of the xDeepH (extended Deep Hamiltonian) method described in the paper Deep-learning electronic-structure calculation of magnetic superstructures (accepted by Nature Computational Science).

The current xDeepH repository is based on DeepH-E3 and will be integrated into DeepH-pack in the future.

Requirements

To train the xDeepH model, Python 3.9 interpreter and following packages are required:

  • NumPy
  • SciPy
  • PyTorch = 1.9.1
  • PyTorch Geometric = 1.7.2
  • e3nn = 0.3.5
  • pymatgen
  • h5py
  • TensorBoard
  • pathos
  • psutil

In Linux, you can quickly achieve the requirements by running

# install miniconda with python 3.9
wget https://repo.anaconda.com/miniconda/Miniconda3-py39_4.10.3-Linux-x86_64.sh
bash Miniconda3-py39_4.10.3-Linux-x86_64.sh

# install packages by conda
conda install numpy
conda install scipy
conda install pytorch==1.9.1 ${pytorch_config}
conda install pytorch-geometric=1.7.2 -c rusty1s -c conda-forge
conda install pymatgen -c conda-forge

# install packages by pip
pip install e3nn==0.3.5
pip install h5py
pip install tensorboard
pip install pathos
pip install psutil

with ${pytorch_config} replaced by your own configuration. You can find how to set it in the official website of PyTorch.

Demo: xDeepH study on monolayer CrI3

The usage of xDeepH is similar to that of DeepH-pack (https://github.com/mzjb/DeepH-pack).

Prepare the dataset

Download the processed dataset from Zenodo and unzip it to the directory data/monolayer_CrI3/.

Alternatively, you can also use OpenMX to perform the spin-constrained DFT calculation, and then convert the output of DFT codes to the format that can be directly read by xDeepH using the deeph-preprocess command of DeepH-pack (https://github.com/mzjb/DeepH-pack/#prepare-the-dataset) to obtain a dataset. You should set parse_magnetic_moment to True and local_coordinate to False in the config file of deeph-preprocess (https://github.com/mzjb/DeepH-pack/blob/1130ad648d8b02be96e9de0144f8f8cff886a178/deeph/preprocess/preprocess_default.ini#L19).

Train your model

Based on the downloaded data, you can train an xDeepH model. Run the following command:

python -u xdeeph-train.py examples/CrI3_monolayer.ini

The config CrI3_monolayer.ini includes a description of each input variables.

Model inference

Once you have a trained model, you can use that model to predict the Hamiltonian of some material structures and get hamiltonians_pred.h5.

Like DeepH-pack, you should first calculate the overlap for the desired materials using 'overlap only' OpenMX (https://github.com/mzjb/overlap-only-OpenMX), and then convert it to our format using the deeph-inference command of DeepH-pack (https://github.com/mzjb/DeepH-pack#inference-with-your-model). Please note that the deeph-inference command is only used for converting the overlap format and not for performing model inference. You should set task to [1] in the config file of deeph-inference (https://github.com/mzjb/DeepH-pack/blob/1130ad648d8b02be96e9de0144f8f8cff886a178/deeph/inference/inference_default.ini#L6).

After obtaining the converted overlaps.h5 file, you should create a magmom.txt file to specify the magnetic structure of the material you want to predict. This is a text file where each line corresponds to an atom. The first column indicates whether the atom is magnetic, with 1 for yes and 0 for no. The second column indicates the magnitude of the magnetic moment. The third column indicates the polar angle of the magnetic moment in spherical coordinates. The fourth column indicates the azimuthal angle of the magnetic moment in spherical coordinates, with angles in degrees. Here is an example of a magmom.txt file:

1.0e+00  3.46e+00  3.23e+01 -5.62e+01
1.0e+00  3.45e+00  4.39e+01  7.07e+01
0.0e+00  7.75e-02  9.43e+01  1.11e+02
0.0e+00  1.43e-02  1.58e+02  8.73e+01
0.0e+00  4.68e-02  1.32e+02 -3.16e+01
0.0e+00  1.41e-01  1.48e+02  3.06e+01
0.0e+00  7.55e-02  8.40e+01  1.11e+02
0.0e+00  9.92e-03  1.20e+02  8.54e+01

Inference of xDeepH can be done by the command:

python -u xdeeph-eval.py examples/CrI3_monolayer_inference.ini

This config also includes a description of each input variables.

Band structure calculation

The band structure of the material can be calculated from the predicted Hamiltonian. The calculation is also based on the sparse calculation script from DeepH-pack (https://github.com/mzjb/DeepH-pack/blob/main/deeph/inference/sparse_calc.jl). The required Julia environment is also identical to that of DeepH-pack (https://github.com/mzjb/DeepH-pack#julia).

Run the following command:

julia sparse_calc.jl -i ${predicted_hamiltonian_path} -o ${output_path} --config config.json

where config.json is the config for the sparse calculation. The description of parameters in this config can be found in https://deeph-pack.deepmodeling.com/en/latest/keyword/inference.html#json-configuration-file. The predicted hamiltonians_pred.h5 and files generated by deeph-inference (overlap.h5, info.json, rlat.dat, orbital_types.dat, site_positions.dat) must be placed in the ${predicted_hamiltonian_path} directory.

GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

简介

清华大学徐勇、段文晖组 xDeepH 展开 收起
Python 等 2 种语言
LGPL-3.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/pfsuo/xDeepH.git
git@gitee.com:pfsuo/xDeepH.git
pfsuo
xDeepH
xDeepH
main

搜索帮助