Fix some minor formatting issue for the input-main.md #6983
Open
zhubonan wants to merge 4 commits intodeepmodeling:developfrom
Open
Fix some minor formatting issue for the input-main.md #6983zhubonan wants to merge 4 commits intodeepmodeling:developfrom
zhubonan wants to merge 4 commits intodeepmodeling:developfrom
Conversation
- Update the type field of parameter item field where multiple values are expected. - Fixed formatting issue in input-main.md where > and < are not escaped correctly.
Fixed some LaTeX issue and unify the description of types.
mohanchen
reviewed
Feb 25, 2026
| - **Availability**: *Used only for plane wave basis set.* | ||
| - **Description**: - 0: it will be set to the number of MPI processes. | ||
| - >0: it specifies the number of processes used for carrying out diagonalization. Must be less than or equal to total number of MPI processes. | ||
| - >0: it specifies the number of processes used for carrying out diagonalization. Must be less than or equal to total number of MPI processes. |
|
|
||
| - **Type**: Real | ||
| - **Description**: Set the smallest allowed spacing between k points, unit in 1/bohr. It should be larger than 0.0, and suggest smaller than 0.25. When you have set this value > 0.0, then the KPT file is unnecessary. The default value 0.0 means that ABACUS will read the applied KPT file. | ||
| - **Description**: Set the smallest allowed spacing between k points, unit in 1/bohr. It should be larger than 0.0, and suggest smaller than 0.25. When you have set this value > 0.0, then the KPT file is unnecessary. The default value 0.0 means that ABACUS will read the applied KPT file. |
|
|
||
| - **Type**: Real | ||
| - **Description**: Only used when you use ks_solver = cg/dav/dav_subspace/bpcg. It indicates the threshold for the first electronic iteration, from the second iteration the pw_diag_thr will be updated automatically. For nscf calculations with planewave basis set, pw_diag_thr should be <= 1e-3. | ||
| - **Description**: Only used when you use ks_solver = cg/dav/dav_subspace/bpcg. It indicates the threshold for the first electronic iteration, from the second iteration the pw_diag_thr will be updated automatically. For nscf calculations with planewave basis set, pw_diag_thr should be <= 1e-3. |
mohanchen
added
Refactor
Author
|
good call, let me scan for a bit more of these unescaped symbols... |
Escaping is performed when the md file is generated.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Some minor fix for the documentation system following #6935
typefield of parameter item field where multiple values are expected.>and<are not escaped correctly. This caused page https://abacus.deepmodeling.com/en/latest/advanced/input_files/input-main.html to render incorrectly.What's changed?
N/A
Any changes of core modules? (ignore if not applicable)
N/A