You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quick_start/easy_install.md
+26-19Lines changed: 26 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,17 @@
1
1
# Easy Installation
2
2
3
-
This guide helps you install ABACUS with basic features. **For DeePKS, DeePMD and Libxc support, or building with `make`, please refer to [the advanced installation guide](../advanced/install.md)** after going through this page. We recommend building ABACUS with `cmake` to avoid dependency issues. We recommend compiling ABACUS(and possibly its requirements) from the source code using the latest compiler for the best performace. You can also deploy ABACUS **without building** by [Docker](#container-deployment) or [conda](#install-by-conda). Please note that ABACUS only supports Linux; for Windows users, please consider using [WSL](https://learn.microsoft.com/en-us/windows/wsl/) or docker.
3
+
This guide helps you install ABACUS with basic features. **For DeePKS, DeePMD and Libxc support, or building with `make`, please refer to [the advanced installation guide](../advanced/install.md)** after going through this page. We recommend building ABACUS with `cmake` to avoid dependency issues. We recommend compiling ABACUS(and possibly its requirements) from the source code using the latest compiler for the best performace. You can try [toolchain](#install-requirements-by-toolchain) to install ABACUS and dependencies in a source-code compilation way with convience. You can also deploy ABACUS **without building** by [Docker](#container-deployment) or [conda](#install-by-conda). Please note that ABACUS only supports Linux; for Windows users, please consider using [WSL](https://learn.microsoft.com/en-us/windows/wsl/) or docker.
4
+
5
+
## Get ABACUS source code
6
+
7
+
ABACUS source code can be obtained via one of the following choices:
8
+
9
+
- Clone the whole repo with git: `git clone https://github.com/deepmodeling/abacus-develop.git`
10
+
- Clone the minimum required part of repo: `git clone https://github.com/deepmodeling/abacus-develop.git --depth=1`
11
+
- Download the latest source code without git: `wget https://github.com/deepmodeling/abacus-develop/archive/refs/heads/develop.zip`
12
+
- Get the source code of a stable version [here](https://github.com/deepmodeling/abacus-develop/releases)
13
+
- If you have connection issues accessing GitHub, please try out our official [Gitee repo](https://gitee.com/deepmodeling/abacus-develop/): e.g. `git clone https://gitee.com/deepmodeling/abacus-develop.git`. This Gitee repo is updated synchronously with GitHub.
14
+
4
15
5
16
## Prerequisites
6
17
@@ -43,32 +54,22 @@ Please refer to our [guide](https://github.com/deepmodeling/abacus-develop/wiki/
43
54
44
55
We offer a set of [toolchain](https://github.com/deepmodeling/abacus-develop/tree/develop/toolchain)
45
56
scripts to compile and install all the requirements
46
-
automatically and suitable for machine characteristic in an online or offline way.
47
-
The toolchain can be downloaded with ABACUS repo, which is easily used and can
48
-
have a convenient installation under HPC environment in both `GNU` or `Intel-oneAPI` toolchain.
49
-
Sometimes, ABACUS by toolchain installation may have highly efficient performance.
50
-
A Tutorial for using this toolchain can be accessed in [bohrium-notebook](https://nb.bohrium.dp.tech/detail/5215742477)
51
-
52
-
> Notice: the toolchain is under development, please let me know if you encounter any problem in using this toolchain.
57
+
automatically and suitable for machine characteristic in an online or offline way.
58
+
The toolchain can be downloaded with ABACUS repo, and users can easily compile the requirements by running *toolchain_[gnu,intel].sh* and ABACUS itself by running *build_abacus_[gnu,intel].sh* script in the toolchain directory in both `GNU` and `Intel-oneAPI` toolchain.
59
+
Sometimes, ABACUS by toolchain installation may have better efficient performance due to the suitable compiled dependencies.
53
60
61
+
Users should read the README in toolchain directory for most of the information before use, and a tutorial for using this toolchain can be accessed in [bohrium-notebook](https://nb.bohrium.dp.tech/detail/5215742477) as reference.
54
62
55
-
## Get ABACUS source code
56
-
57
-
Of course a copy of ABACUS source code is required, which can be obtained via one of the following choices:
63
+
> Notice: the toolchain is under development, please let we know if you encounter any problem in using this toolchain by raising issue or contacting us.
58
64
59
-
- Clone the whole repo with git: `git clone https://github.com/deepmodeling/abacus-develop.git`
60
-
- Clone the minimum required part of repo: `git clone https://github.com/deepmodeling/abacus-develop.git --depth=1`
61
-
- Download the latest source code without git: `wget https://github.com/deepmodeling/abacus-develop/archive/refs/heads/develop.zip`
62
-
- Get the source code of a stable version [here](https://github.com/deepmodeling/abacus-develop/releases)
63
-
- If you have connection issues accessing GitHub, please try out our official [Gitee repo](https://gitee.com/deepmodeling/abacus-develop/): e.g. `git clone https://gitee.com/deepmodeling/abacus-develop.git`
64
65
65
-
###Update to latest release
66
+
## Update to latest release by git
66
67
67
68
Please check the [release page](https://github.com/deepmodeling/abacus-develop/releases) for the release note of a new version.
68
69
69
70
It is OK to download the new source code from beginning following the previous step.
70
71
71
-
To update your cloned git repo in-place:
72
+
You can update your cloned git repo (from Github or Gitee) in-place with the following commands:
72
73
73
74
```bash
74
75
git remote -v
@@ -78,7 +79,7 @@ git remote -v
78
79
79
80
# Replace "origin" with "upstream" or the remote name corresponding to deepmodeling/abacus-develop if necessary
80
81
git fetch origin
81
-
git checkout v3.2.0# Replace the tag with the latest version
82
+
git checkout v3.8.4# Replace the tag with the latest version
82
83
git describe --tags # Verify if the tag has been successfully checked out
83
84
```
84
85
@@ -158,6 +159,12 @@ If ABACUS is installed into a custom directory using `CMAKE_INSTALL_PREFIX`, ple
158
159
export PATH=/my-install-dir/:$PATH
159
160
```
160
161
162
+
If ABACUS is installed by toolchain, there will be an environment script in the toolchain directory named as *abacus_env.sh*. You can source it to set the environment variables.
163
+
164
+
```bash
165
+
source /path/to/abacus/toolchain/abacus_env.sh
166
+
```
167
+
161
168
Please set OpenMP threads by setting environment variable:
0 commit comments