Skip to content

Commit c96cd44

Browse files
authored
Update input-main.md
1 parent 4da3c34 commit c96cd44

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/advanced/input_files/input-main.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2142,7 +2142,7 @@ Warning: this function is not robust enough for the current version. Please try
21422142
### deepks_out_labels
21432143

21442144
- **Type**: Integer
2145-
- **Availability**: numerical atomic orbital basis
2145+
- **Availability**: Numerical atomic orbital basis
21462146
- **Description**: Print labels and descriptors for DeePKS in OUT.${suffix}. The names of these files start with "deepks".
21472147
- 0 : No output.
21482148
- 1 : Output intermediate files needed during DeePKS training.
@@ -2163,30 +2163,30 @@ Warning: this function is not robust enough for the current version. Please try
21632163
### deepks_out_freq_elec
21642164

21652165
- **Type**: Integer
2166-
- **Availability**: numerical atomic orbital basis
2166+
- **Availability**: Numerical atomic orbital basis
21672167
- **Description**: When `deepks_out_freq_elec` is greater than 0, print labels and descriptors for DeePKS in OUT.${suffix}/DeePKS_Labels_Elec per `deepks_out_freq_elec` electronic iterations, with suffix `_e*` to distinguish different steps. Often used with `deepks_out_labels` equals 1.
21682168
- **Default**: 0
21692169

21702170
### deepks_scf
21712171

21722172
- **Type**: Boolean
2173-
- **Availability**: numerical atomic orbital basis
2173+
- **Availability**: Numerical atomic orbital basis
21742174
- **Description**: perform self-consistent field iteration in DeePKS method
21752175
- **Note**: A trained, traced model file is needed.
21762176
- **Default**: False
21772177

21782178
### deepks_equiv
21792179

21802180
- **Type**: Boolean
2181-
- **Availability**: numerical atomic orbital basis
2181+
- **Availability**: Numerical atomic orbital basis
21822182
- **Description**: whether to use equivariant version of DeePKS
21832183
- **Note**: the equivariant version of DeePKS-kit is still under development, so this feature is currently only intended for internal usage.
21842184
- **Default**: False
21852185

21862186
### deepks_model
21872187

21882188
- **Type**: String
2189-
- **Availability**: numerical atomic orbital basis and `deepks_scf` is true
2189+
- **Availability**: Numerical atomic orbital basis and `deepks_scf` is true
21902190
- **Description**: the path of the trained, traced neural network model file generated by [deepks-kit](https://github.com/deepmodeling/deepks-kit)
21912191
- **Default**: None
21922192

@@ -2239,7 +2239,7 @@ Warning: this function is not robust enough for the current version. Please try
22392239
### deepks_bandgap
22402240

22412241
- **Type**: Int
2242-
- **Availability**: numerical atomic orbital basis and `deepks_scf` is true
2242+
- **Availability**: Numerical atomic orbital basis and `deepks_scf` is true
22432243
- **Description**: include bandgap label for DeePKS training
22442244
- 0: Don't include bandgap label
22452245
- 1: Include target bandgap label (see [deepks\_band\_range](#deepks_band_range) for more details)
@@ -2250,7 +2250,7 @@ Warning: this function is not robust enough for the current version. Please try
22502250
### deepks_band_range
22512251

22522252
- **Type**: Int*2
2253-
- **Availability**: numerical atomic orbital basis, `deepks_scf` is true, and `deepks_bandgap` is 1 or 2
2253+
- **Availability**: Numerical atomic orbital basis, `deepks_scf` is true, and `deepks_bandgap` is 1 or 2
22542254
- **Description**: The first value should not be larger than the second one and the meaning differs in different cases below
22552255
- `deepks_bandgap` is 1: Bandgap label is the energy between `LUMO + deepks_band_range[0]` and `LUMO + deepks_band_range[1]`. If not set, it will calculate energy between HOMO and LUMO states.
22562256
- `deepks_bandgap` is 2: Bandgap labels are energies between HOMO and all states in range [`LUMO + deepks_band_range[0]`, `LUMO + deepks_band_range[1]`] (Thus there are `deepks_band_range[1] - deepks_band_range[0] + 1` bandgaps in total). If HOMO is included in the setting range, it will be ignored since it will always be zero and has no valuable messages (`deepks_band_range[1] - deepks_band_range[0]` bandgaps in this case). *NOTICE: The set range can be greater than, less than, or include the value of HOMO. In the bandgap label, we always calculate the energy of the state in the set range minus the energy of HOMO state, so the bandgap can be negative if the state is lower than HOMO.*
@@ -2259,7 +2259,7 @@ Warning: this function is not robust enough for the current version. Please try
22592259
### deepks_v_delta
22602260

22612261
- **Type**: int
2262-
- **Availability**: numerical atomic orbital basis
2262+
- **Availability**: Numerical atomic orbital basis
22632263
- **Description**: Include V_delta/V_delta_R (Hamiltonian in k/real space) label for DeePKS training. When `deepks_out_labels` is true and `deepks_v_delta` > 0 (k space), ABACUS will output `deepks_hbase.npy`, `deepks_vdelta.npy` and `deepks_htot.npy`(htot=hbase+vdelta). When `deepks_out_labels` is true and `deepks_v_delta` < 0 (real space), ABACUS will output `deepks_hrtot.csr`, `deepks_hrdelta.csr`. Some more files output for different settings.
22642264
- `deepks_v_delta` = 1: `deepks_vdpre.npy`, which is used to calculate V_delta during DeePKS training.
22652265
- `deepks_v_delta` = 2: `deepks_phialpha.npy` and `deepks_gevdm.npy`, which can be used to calculate `deepks_vdpre.npy`. A recommanded method for memory saving.

0 commit comments

Comments
 (0)