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

refactor readme and remove some duplicated contents #946

Merged
merged 4 commits into from
Nov 11, 2022

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Sep 15, 2022

Note: some documentation links will be available once the devel branch is merged into the master branch.

Note: some documentation links will be available once the devel branch is merged into the master branch.
@codecov-commenter
Copy link

codecov-commenter commented Sep 15, 2022

Codecov Report

Merging #946 (95086c4) into devel (72764d9) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            devel     #946   +/-   ##
=======================================
  Coverage   38.16%   38.16%           
=======================================
  Files          99       99           
  Lines       17885    17885           
=======================================
  Hits         6825     6825           
  Misses      11060    11060           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

&END SUBSYS
&END FORCE_EVAL
```
* [`dpgen run`](https://docs.deepmodeling.com/projects/dpgen/en/latest/run/): Main process of Deep Generator.
Copy link
Contributor

Choose a reason for hiding this comment

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

The link is broken

* [Tutorials](https://tutorials.deepmodeling.com/en/latest/Tutorials/DP-GEN/): basic tutorials for DP-GEN.
* [Examples](examples): input files in [JSON](https://docs.python.org/3/library/json.html) format.
* [Publications](https://deepmodeling.com/blog/papers/dpgen/): Published research articles using DP-GEN.
* [User guide](https://docs.deepmodeling.com/projects/dpgen/en/latest/user-guide/): frequently asked questions listed in troubleshooting.
Copy link
Contributor

Choose a reason for hiding this comment

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

this one is broken. I didn't check every link, could you please do so?

Copy link
Member Author

Choose a reason for hiding this comment

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

These links will be available once the devel branch is merged to the master branch. At present the link can be visited by replacing latest with devel.

Copy link
Collaborator

@HuangJiameng HuangJiameng left a comment

Choose a reason for hiding this comment

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

dpgen package on conda-forge is version 0.9.2. Shall we change the link to https://anaconda.org/deepmodeling/dpgen, which is the latest version?



## About DP-GEN
# DP-GEN: A concurrent learning platform for the generation of reliable deep learning based potential energy models

[![GitHub release](https://img.shields.io/github/release/deepmodeling/dpgen.svg?maxAge=86400)](https://github.com/deepmodeling/dpgen/releases/)
[![doi:10.1016/j.cpc.2020.107206](https://img.shields.io/badge/DOI-10.1016%2Fj.cpc.2020.107206-blue)](https://doi.org/10.1016/j.cpc.2020.107206)
![Citations](https://citations.njzjz.win/10.1016/j.cpc.2020.107206)
[![conda install](https://img.shields.io/conda/dn/conda-forge/dpgen?label=conda%20install)](https://anaconda.org/conda-forge/dpgen)
Copy link
Collaborator

Choose a reason for hiding this comment

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

dpgen package on conda-forge is version 0.9.2. Shall we change the link to https://anaconda.org/deepmodeling/dpgen, which is the latest version?

Copy link
Member Author

Choose a reason for hiding this comment

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

I will resolve the conda-forge issue this month.

Copy link
Member Author

Choose a reason for hiding this comment

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

Resolved.

@wanghan-iapcm wanghan-iapcm merged commit 9811e07 into deepmodeling:devel Nov 11, 2022
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.

None yet

4 participants