Skip to content

Commit 7cea715

Browse files
QuantumMisakaFisherd99
authored andcommitted
Docs: Gitee repo info and toolchain info update (deepmodeling#5666)
* update toolchain info * git info change in docs * update `abacus_env.sh` usage * mention toolchain in head * fix build scripts in rapidjson
1 parent 7087829 commit 7cea715

File tree

3 files changed

+28
-21
lines changed

3 files changed

+28
-21
lines changed

docs/quick_start/easy_install.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
# Easy Installation
22

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+
415

516
## Prerequisites
617

@@ -43,32 +54,22 @@ Please refer to our [guide](https://github.com/deepmodeling/abacus-develop/wiki/
4354

4455
We offer a set of [toolchain](https://github.com/deepmodeling/abacus-develop/tree/develop/toolchain)
4556
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.
5360

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.
5462

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.
5864
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`
6465

65-
### Update to latest release
66+
## Update to latest release by git
6667

6768
Please check the [release page](https://github.com/deepmodeling/abacus-develop/releases) for the release note of a new version.
6869

6970
It is OK to download the new source code from beginning following the previous step.
7071

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:
7273

7374
```bash
7475
git remote -v
@@ -78,7 +79,7 @@ git remote -v
7879

7980
# Replace "origin" with "upstream" or the remote name corresponding to deepmodeling/abacus-develop if necessary
8081
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
8283
git describe --tags # Verify if the tag has been successfully checked out
8384
```
8485

@@ -158,6 +159,12 @@ If ABACUS is installed into a custom directory using `CMAKE_INSTALL_PREFIX`, ple
158159
export PATH=/my-install-dir/:$PATH
159160
```
160161

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+
161168
Please set OpenMP threads by setting environment variable:
162169

163170
```bash

toolchain/build_abacus_gnu.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ cmake -B $BUILD_DIR -DCMAKE_INSTALL_PREFIX=$PREFIX \
4949
-DUSE_OPENMP=ON \
5050
-DUSE_ELPA=ON \
5151
-DENABLE_RAPIDJSON=ON \
52-
-DRapdidJSON_DIR=$RAPIDJSON \
52+
-DRapidJSON_DIR=$RAPIDJSON \
5353
# -DENABLE_DEEPKS=1 \
5454
# -DTorch_DIR=$LIBTORCH \
5555
# -Dlibnpy_INCLUDE_DIR=$LIBNPY \

toolchain/build_abacus_intel-mpich.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ cmake -B $BUILD_DIR -DCMAKE_INSTALL_PREFIX=$PREFIX \
4545
-DUSE_OPENMP=ON \
4646
-DUSE_ELPA=ON \
4747
-DENABLE_RAPIDJSON=ON \
48-
-DRapdidJSON_DIR=$RAPIDJSON \
48+
-DRapidJSON_DIR=$RAPIDJSON \
4949
# -DENABLE_DEEPKS=1 \
5050
# -DTorch_DIR=$LIBTORCH \
5151
# -Dlibnpy_INCLUDE_DIR=$LIBNPY \

0 commit comments

Comments
 (0)