Skip to content

Docs: Correct intro to output in quickstart #6095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 2, 2025
Merged

Docs: Correct intro to output in quickstart #6095

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b30eb9
Correct docs/quik_start/output to show the actual case
Cstandardlib Apr 1, 2025
a0face6
Update output.md
Cstandardlib Apr 1, 2025
c75a729
Update output.md
Cstandardlib Apr 1, 2025
abd9504
Merge branch 'develop' into docs/outdir-input
Cstandardlib Apr 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/quick_start/output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ The following files are the central output files for ABACUS. After executing the

Different from `INPUT` given by the users, `OUT.suffix/INPUT` contains all parameters in ABACUS.

> **Note:** `OUT.suffix/INPUT` contain the initial default of ABACUS instead of the real parameters used in calculations. This file is stored for reproduction in case the default value is changed during development. If you want to figure out the real parameters used in calculations, you can open `OUT.suffix/runing_scf.log` and research corresponding parameter you are interested.
> **Note:** `OUT.suffix/INPUT` contains the **actual parameters used in the calculation**, including:
> 1. **User-specified parameters** (explicitly defined in your input file or command-line arguments, overriding default parameters).
> 2. **System default parameters** (automatically applied when not explicitly provided by the user).


This file ensures calculations can be fully reproduced, even if default values change in future ABACUS versions.
Also notice that in rare cases, a small number of parameters may be dynamically reset to appropriate values during runtime.

For a complete list of input parameters, please consult this [instruction](../advanced/input_files/input-main.md).

Expand Down
Loading