From a3974229197cd65b65c8a8dd37cc8945266a281c Mon Sep 17 00:00:00 2001 From: Chun Cai Date: Tue, 28 Dec 2021 17:53:58 +0800 Subject: [PATCH 1/4] Add support to gitpod. Will use default dev kit docker image. --- .gitpod.yml | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitpod.yml diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 00000000000..8b23ee5a40c --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1 @@ +image: "ghcr.io/deepmodeling/abacus-development-kit:gnu" From 32a68fbdb42b29f62ab3c199308e33e13df8bddf Mon Sep 17 00:00:00 2001 From: Chun Cai Date: Wed, 29 Dec 2021 12:01:56 +0800 Subject: [PATCH 2/4] Add link for configuration files. --- .gitpod.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitpod.yml b/.gitpod.yml index 8b23ee5a40c..9203c42a71a 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1 +1,2 @@ +# https://www.gitpod.io/docs/configure image: "ghcr.io/deepmodeling/abacus-development-kit:gnu" From af09bdbef34179c1aa6f397f72778d9c07033c30 Mon Sep 17 00:00:00 2001 From: Chun Cai Date: Wed, 29 Dec 2021 12:21:14 +0800 Subject: [PATCH 3/4] Add doc for docker, VS Code Container, and gitpod. --- doc/install.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/install.md b/doc/install.md index ff1222835e6..a69d4535f7a 100644 --- a/doc/install.md +++ b/doc/install.md @@ -7,8 +7,6 @@ - [Link LIBXC](#link-libxc) - [Structure of the package](#structure-of-the-package) - [Structure of source code](#structure-of-source-code) - - - [Building the program](#building-the-program) - [Installation with DeePKS](#installation-with-deepks) - [Extra prerequisites](#extra-prerequisites) - [Extra settings for building](#extra-settings-for-building) @@ -78,6 +76,15 @@ If you use Intel toolchain, don't forget to [set environment variables](https:// [back to top](#download-and-install) +### Container Deployment + +We offer a pre-built docker image containing all the requirements - you only need to clone and compile `abacus` in the container. Please refer to our [Package Page](https://github.com/deepmodeling/abacus-develop/pkgs/container/abacus-development-kit). + +The project is ready for VS Code development container. Please refer to [Developing inside a Container](https://code.visualstudio.com/docs/remote/containers#_quick-start-try-a-development-container). Choose `Open a Remote Window -> Clone a Repository in Container Volume` in VS Code command palette, and put the [git address](https://github.com/hongriTianqi/abacus-develop.git) of `ABACUS` when prompted. + +We also support [gitpod](https://www.gitpod.io/) to offer an ready-to-use online development environment. +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/hongriTianqi/abacus-develop) + ### Build and install ABACUS with CMake #### Configure From d6d89408ce461b1936a4f410b688520fecc612c8 Mon Sep 17 00:00:00 2001 From: Chun Cai Date: Wed, 29 Dec 2021 12:23:49 +0800 Subject: [PATCH 4/4] Fix typo of git address. --- doc/install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/install.md b/doc/install.md index a69d4535f7a..ab3db7e5994 100644 --- a/doc/install.md +++ b/doc/install.md @@ -80,10 +80,10 @@ If you use Intel toolchain, don't forget to [set environment variables](https:// We offer a pre-built docker image containing all the requirements - you only need to clone and compile `abacus` in the container. Please refer to our [Package Page](https://github.com/deepmodeling/abacus-develop/pkgs/container/abacus-development-kit). -The project is ready for VS Code development container. Please refer to [Developing inside a Container](https://code.visualstudio.com/docs/remote/containers#_quick-start-try-a-development-container). Choose `Open a Remote Window -> Clone a Repository in Container Volume` in VS Code command palette, and put the [git address](https://github.com/hongriTianqi/abacus-develop.git) of `ABACUS` when prompted. +The project is ready for VS Code development container. Please refer to [Developing inside a Container](https://code.visualstudio.com/docs/remote/containers#_quick-start-try-a-development-container). Choose `Open a Remote Window -> Clone a Repository in Container Volume` in VS Code command palette, and put the [git address](https://github.com/deepmodeling/abacus-develop.git) of `ABACUS` when prompted. We also support [gitpod](https://www.gitpod.io/) to offer an ready-to-use online development environment. -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/hongriTianqi/abacus-develop) +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/deepmodeling/abacus-develop) ### Build and install ABACUS with CMake