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

Add DP-GEN Structure.md to doc #844

Merged
merged 4 commits into from
Aug 12, 2022

Conversation

HuangJiameng
Copy link
Collaborator

A basic user guide.

@HuangJiameng HuangJiameng changed the title Create DP-GEN Structure.md Add DP-GEN Structure.md to doc Aug 5, 2022
@codecov-commenter
Copy link

codecov-commenter commented Aug 5, 2022

Codecov Report

Merging #844 (a2ae0f1) into devel (40f66fd) will decrease coverage by 0.07%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##            devel     #844      +/-   ##
==========================================
- Coverage   36.08%   36.01%   -0.08%     
==========================================
  Files          97       97              
  Lines       17169    17279     +110     
==========================================
+ Hits         6196     6223      +27     
- Misses      10973    11056      +83     
Impacted Files Coverage Δ
dpgen/generator/lib/make_calypso.py 70.06% <0.00%> (-7.46%) ⬇️
dpgen/generator/run.py 62.50% <0.00%> (-0.61%) ⬇️
dpgen/data/gen.py 47.88% <0.00%> (-0.60%) ⬇️
dpgen/generator/lib/run_calypso.py 10.00% <0.00%> (ø)
dpgen/generator/lib/calypso_run_opt.py 0.00% <0.00%> (ø)
dpgen/generator/lib/calypso_check_outcar.py 0.00% <0.00%> (ø)
dpgen/generator/lib/calypso_run_model_devi.py 0.00% <0.00%> (ø)
dpgen/generator/arginfo.py 99.25% <0.00%> (+0.05%) ⬆️
dpgen/generator/lib/abacus_scf.py 86.41% <0.00%> (+0.34%) ⬆️
dpgen/generator/lib/parse_calypso.py 84.84% <0.00%> (+0.47%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

Copy link
Member

@njzjz njzjz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file needs to be added to TOC in index.rst, otherwise it will not be shown in the website.

@HuangJiameng
Copy link
Collaborator Author

The file needs to be added to TOC in index.rst, otherwise it will not be shown in the website.

OK, it is added.

doc/overview/DP-GEN-structure.md Outdated Show resolved Hide resolved
doc/overview/DP-GEN-structure.md Outdated Show resolved Hide resolved
@wanghan-iapcm wanghan-iapcm merged commit 9692541 into deepmodeling:devel Aug 12, 2022
@HuangJiameng HuangJiameng deleted the doc_overview branch September 26, 2022 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants