Skip to content

Commit bc95105

Browse files
committed
improve README.md of SIAB
1 parent b39b5b7 commit bc95105

File tree

1 file changed

+38
-20
lines changed

1 file changed

+38
-20
lines changed

tools/SIAB/README.md

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,57 @@
11
# SIAB Package Description
22

33

4-
(S)ystematically
5-
(I)mprovable
6-
(A)tomic orbital
7-
(B)asis generator based on spillage formula
4+
**S**ystematically
5+
6+
**I**mprovable
7+
8+
**A**tomic orbital
9+
10+
**B**asis generator based on spillage formula
811

912

1013
# HOW TO USE SIAB
1114

12-
The optimization can choose three minimization methods: 'Simulated Annealing', 'PyTorch Gradient' and 'PyTorch Gradient whit dpsi'.
15+
The optimization can choose one of the three minimization methods:
16+
17+
- Simulated Annealing (**SA**),
18+
- PyTorch Gradient (**PTG**),
19+
- PyTorch Gradient with dpsi (**PTG_dpsi**).
20+
21+
The executable files for the three methods are:
22+
23+
- ./SimulatedAnnealing/source/SIA_s.exe,
24+
- ./PyTorchGradient/source/main.py,
25+
- ../opt_orb_pytorch_dpsi/main.py,
1326

14-
The executable files for three methods are './SimulatedAnnealing/source/SIA_s.exe', './PyTorchGradient/source/main.py', '../opt_orb_pytorch_dpsi/main.py', respectively.
27+
respectively.
1528

1629

17-
## (1) write input file
18-
Firstly, write the input file, such as "ORBITAL_INPUT_DZP" in example-directories, for script 'Generate_Orbital_AllInOne.sh'.
19-
Both approachs, 'PyTorch Gradient' and 'Simulated Annealing', work with one bash script and use the same input file.
20-
Please use the absolute path for each each file and directory.
30+
## 1. Write input file
2131

32+
Firstly, write the input file, such as **ORBITAL_INPUT_DZP** in example-directories, for script **Generate_Orbital_AllInOne.sh**.
33+
All three approachs work with the same bash script and use the same input file.
34+
Please use **absolute path** for each file/directory in input file.
2235

23-
## (2) set up dependence env
24-
Then, we set up the dependence env for ABACUS and SIAB, such as:
36+
37+
## 2. Set up dependence environment
38+
39+
Secondly, we set up the dependence environment for ABACUS and SIAB, such as:
2540

2641
```bash
2742
$ module load hpcx/2.9.0/hpcx-intel-2019.update5 mkl/2019.update5 elpa/2019.05.002/hpcx-intel-2019.update5
2843
```
29-
Especially for SIAB with 'PyTorch Gradient' approach, we need pytorch v1.1.0.
44+
45+
Especially for SIAB with **PyTorch Gradient** approach, we need pytorch v1.1.0.
3046

3147

32-
### how to install pytorch:
48+
### How to install pytorch:
49+
3350
Take the HanHai20@USTC system for example:
3451

3552
```bash
36-
$ module load gcc/7.5.0min #:optional, larger version gcc may not be necessary.
37-
$ module load anaconda3
53+
$ module load gcc/7.5.0min #optional, maybe unnecessary.
54+
$ module load anaconda3_nompi
3855
$ module list
3956
Currently Loaded Modulefiles:
4057
1) elpa/2019.05.002/hpcx-intel-2019.update5 4) hpcx/2.9.0/hpcx-intel-2019.update5 7) libxc/4.3.4/hpcx-intel-2019.update5
@@ -44,18 +61,19 @@ $ python3 -V
4461
Python 3.7.4
4562

4663
$ conda create -n pytorch110 python=3.7
47-
$ source activate pytorch110 #or: conda activate pytorch110
64+
$ source activate pytorch110 #or: conda activate pytorch110
4865
$ conda install pytorch torchvision torchaudio cpuonly -c pytorch
49-
$ source deactivate #or: conda deactivate
66+
$ source deactivate #or: conda deactivate
5067

5168
$ source activate pytorch110 #or: conda activate pytorch110
5269
$ pip3 install --user scipy numpy
5370
$ pip3 install --user torch_optimizer
5471
```
5572

5673

57-
## (3) run generation
58-
Finally, 'cd' into an example folder, and run command like this:
74+
## 3. Run generation
75+
76+
Finally, `cd` into an example folder, and run command like this:
5977

6078
```bash
6179
$ ../Generate_Orbital_AllInOne.sh ORBITAL_INPUT_DZP

0 commit comments

Comments
 (0)