Skip to content

Commit

Permalink
update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
YuuuXie committed Oct 5, 2020
1 parent 0edd0e4 commit 15184bb
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Hierarchical/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Hierarchical training of stanene force field

After the OTF training is complete, we use MGP force field in LAMMPS for long time-scale simulations.
Snapshots are picked up from the LAMMPS trajectory and calculated in DFT for validation and re-training.

1. `add_snap` in mgp-"n": Add snapshots from DFT calculations in mgp-"n-1"
2. `train_hyps`: Train hyperparameters of GP
3. `build_mgp`: Use optimized hyps to build MGP
4. `lmp`: Run LAMMPS with MGP
5. `uncertainties`: Predict uncertainties
6. `dft`: Pick up three snapshots for DFT
12 changes: 12 additions & 0 deletions OTF/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# On-the-fly training of the stanene force field

1. `atom_setup.py` constructs the supercell of stanene
2. `flare_setup.py` initializes parameters for FLARE force field
3. `qe_setup.py` sets input parameters of Quantum Espresso (QE). Set to use 288 CPUs in total.
4. `otf_run.py` sets parameters for OTF training and molecular dynamics. Set to run 100 ps in total.
5. `postprocess.py` analyzes the OTF trajectory and generate a figure of mean square displacement

To launch the training, use
```
python otf_run.py
```
3 changes: 3 additions & 0 deletions flare/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## FLARE source code

This is the FLARE package folked from [flare](https://github.com/mir-group/flare)

0 comments on commit 15184bb

Please sign in to comment.