Skip to content
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.

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

clarify the usage of skip_relax in init_surf #929

Merged
Merged
Changes from all commits
Commits
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: 6 additions & 2 deletions doc/init/init_surf.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@ You may prepare initial data for surface systems with VASP by:
dpgen init_surf PARAM [MACHINE]
```
The MACHINE configure file is optional. If this parameter exists, then the optimization
tasks or MD tasks will be submitted automatically according to MACHINE.json.

tasks or MD tasks will be submitted automatically according to MACHINE.json. That is to say, if one only wants to prepare `surf-xxx/sys-xxx` folders for the second stage but wants to skip relaxation, `dpgen init_surf PARAM` should be used (without `MACHINE`).
"stages" and "skip_relax" in `PARAM` should be set as:
```json
"stages": [1,2],
"skip_relax": true,
```

Basically `init_surf` can be divided into two parts , denoted as `stages` in `PARAM`:
1. Build specific surface in folder `00.place_ele`
Expand Down