From 5165c2afa69df17c8d9e17d28f28bbac273a81aa Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Thu, 3 Dec 2020 01:21:08 -0500 Subject: [PATCH] add documentation link to readme --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cdec110a92..778277ffe9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ DeePMD-kit Manual ======== - +[![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) @@ -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.