-
Notifications
You must be signed in to change notification settings - Fork 178
add init-bulk in dpgen documents #907
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
Merged
Merged
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
876f0a9
Update index.rst
baihuyu12 6fdd2cc
Create init-bulk.md
baihuyu12 2cd92b5
Update index.rst
baihuyu12 93d7f8b
Update init-bulk.md
baihuyu12 c3f2ca7
Update init-bulk.md
baihuyu12 f0b2d7d
Update init-bulk.md
baihuyu12 9325e6a
Update init-bulk.md
baihuyu12 f0b57cb
Update init-bulk.md
baihuyu12 d8bcf45
Update init-bulk.md
baihuyu12 4771a0c
Update init-bulk.md
baihuyu12 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
## Init_bulk | ||
|
||
You may prepare initial data for bulk systems with VASP by: | ||
|
||
```bash | ||
dpgen init_bulk 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. | ||
|
||
Basically `init_bulk` can be divided into four parts , denoted as `stages` in `PARAM`: | ||
1. Relax in folder `00.place_ele` | ||
2. Perturb and scale in folder `01.scale_pert` | ||
3. Run a short AIMD in folder `02.md` | ||
4. Collect data in folder `02.md`. | ||
|
||
All stages must be **in order**. One doesn't need to run all stages. For example, you may run stage 1 and 2, generating supercells as starting point of exploration in `dpgen run`. | ||
|
||
If MACHINE is None, there should be only one stage in stages. Corresponding tasks will be generated, but user's intervention should be involved in, to manually run the scripts. | ||
|
||
Following is an example for `PARAM`, which generates data from a typical structure hcp. | ||
```json | ||
{ | ||
"stages" : [1,2,3,4], | ||
"cell_type": "hcp", | ||
"latt": 4.479, | ||
"super_cell": [2, 2, 2], | ||
"elements": ["Mg"], | ||
"potcars": ["....../POTCAR"], | ||
"relax_incar": "....../INCAR_metal_rlx", | ||
"md_incar" : "....../INCAR_metal_md", | ||
"scale": [1.00], | ||
"skip_relax": false, | ||
"pert_numb": 2, | ||
"md_nstep" : 5, | ||
"pert_box": 0.03, | ||
"pert_atom": 0.01, | ||
"coll_ndata": 5000, | ||
"type_map" : [ "Mg", "Al"], | ||
"_comment": "that's all" | ||
} | ||
``` | ||
|
||
If you want to specify a structure as starting point for `init_bulk`, you may set in `PARAM` as follows. | ||
|
||
```json | ||
"from_poscar": true, | ||
"from_poscar_path": "....../C_mp-47_conventional.POSCAR", | ||
``` | ||
`init_bulk` support both VASP and ABACUS for first-principle calculation. You can choose the software by specifying the key `init_fp_style`. If `init_fp_style` is not specified, the default software will be VASP. | ||
|
||
When using ABACUS for `init_fp_style`, the keys of the paths of `INPUT` files for relaxation and MD simulations are the same as `INCAR` for VASP, which are `relax_incar` and `md_incar` respectively. Use `relax_kpt` and `md_kpt` for the relative path for `KPT` files of relaxation and MD simulations. They two can be omitted if `kspacing` (in unit of 1/Bohr) or `gamma_only` has been set in corresponding INPUT files. If `from_poscar` is set to `false`, you have to specify `atom_masses` in the same order as `elements`. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
support -> supports