fix typos and optimize autotest part in README #899
Conversation
kevinwenminion
commented
Aug 21, 2022
kevinwenminion
commented
- README is updated especially for the autotest part.
- We change the default deformation parameters in Elastic to 1e-2 which is more reasonable for calculating elastic constants.
new README.md
…arameters in Elastic
kevinwenminion
requested review from
wanghan-iapcm,
Vibsteamer and
pxlxingliang
Codecov Report
@@ Coverage Diff @@
## devel #899 +/- ##
=======================================
Coverage 38.14% 38.14%
=======================================
Files 99 99
Lines 17766 17767 +1
=======================================
+ Hits 6777 6778 +1
Misses 10989 10989
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
|
What do you think about the connection between README and wiki on autotest? Could you help to combine their content into one document and put it on DPGEN’s documentation? |
This PR intends to replace the autotest doc in the wiki. All information in the wiki is supposed to be moved to README |
README.md
Outdated
| ### The content of the auto_test | ||
| To know what actually will dpgen autotest do, including the lammps and vasp script, the input file and atom configuration file auto_test will generate, please refer to https://hackmd.io/@yeql5ephQLaGJGgFgpvIDw/rJY1FO92B | ||
| ### More Information of Autotest | ||
| For more information of autotest, please refer to [dpgen wiki](https://github.com/deepmodeling/dpgen/wiki). |
There was a problem hiding this comment.
This PR intends to replace the autotest doc in the wiki. All information in the wiki is supposed to be moved to README
But the wiki is cited here. Should we keep the wiki separate or move it to the documentation site?
There was a problem hiding this comment.
@kevinwenminion plz move it to the documentation site
There was a problem hiding this comment.
#891 this pr move the wiki to the documentation site
There was a problem hiding this comment.
I have removed the citation of wiki in README. Users can learn how to use autotest very quickly by reading the updated autotest part in README.
