Skip to content

Commit

Permalink
Merge pull request #303 from njzjz/njzjz-patch-3
Browse files Browse the repository at this point in the history
add documentation link to readme
  • Loading branch information
amcadmus committed Dec 11, 2020
2 parents a741845 + 5165c2a commit 698cf3a
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<span style="font-size:larger;">DeePMD-kit Manual</span>
========

[![GitHub release](https://img.shields.io/github/release/deepmodeling/deepmd-kit.svg?maxAge=86400)](https://github.com/deepmodeling/deepmd-kit/releases)
[![Documentation Status](https://readthedocs.org/projects/deepmd/badge/?version=latest)](https://deepmd.readthedocs.io/en/latest/?badge=latest)

# Table of contents
- [About DeePMD-kit](#about-deepmd-kit)
Expand All @@ -15,6 +16,8 @@
# About DeePMD-kit
DeePMD-kit is a package written in Python/C++, designed to minimize the effort required to build deep learning based model of interatomic potential energy and force field and to perform molecular dynamics (MD). This brings new hopes to addressing the accuracy-versus-efficiency dilemma in molecular simulations. Applications of DeePMD-kit span from finite molecules to extended systems and from metallic systems to chemically bonded systems.

For more information, check the [documentation](https://deepmd.readthedocs.io/).

## Highlighted features
* **interfaced with TensorFlow**, one of the most popular deep learning frameworks, making the training process highly automatic and efficient.
* **interfaced with high-performance classical MD and quantum (path-integral) MD packages**, i.e., LAMMPS and i-PI, respectively.
Expand Down

0 comments on commit 698cf3a

Please sign in to comment.