Skip to content

Commit 917092e

Browse files
Toolchain and docs modification (#6718)
* repair install_mpich.sh to fix mpich installation * update toolchain_gnu.sh * docs(quick_start): Update easy_install.md - 添加通过git更新到最新版本的详细步骤 - 扩展工具链安装说明,包括GCC-AMD和AOCC-AOCL支持 - 重新组织conda安装部分,增加开发环境配置说明 - 优化文档结构,将手动安装部分后移 * docs: 修正CITATIONS.md中的作者名字拼写错误 * build(Dockerfile): 移除重复的bc依赖项 * docs(community): 在FAQ中添加联系方式 * docs(quick_start): 修正安装指南中的工具链描述和链接 更新工具链部分的标题和描述,使其更准确反映工具链的功能。同时修正文档中的内部链接格式。
1 parent 963edf7 commit 917092e

File tree

7 files changed

+127
-107
lines changed

7 files changed

+127
-107
lines changed

Dockerfile.cuda

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ FROM nvidia/cuda:12.2.0-devel-ubuntu22.04
33
RUN apt update && apt install -y --no-install-recommends \
44
libopenblas-openmp-dev liblapack-dev libscalapack-mpi-dev libfftw3-dev libcereal-dev \
55
libxc-dev libgtest-dev libgmock-dev libbenchmark-dev python3-numpy \
6-
bc cmake git g++ make bc time sudo unzip vim wget libopenmpi-dev gfortran libtool-bin
6+
bc cmake git g++ make time sudo unzip vim wget libopenmpi-dev gfortran libtool-bin
77

88
ENV GIT_SSL_NO_VERIFY=true TERM=xterm-256color \
99
OMPI_ALLOW_RUN_AS_ROOT=1 OMPI_ALLOW_RUN_AS_ROOT_CONFIRM=1 \

Dockerfile.gnu

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ FROM ubuntu:22.04
1111
RUN apt update && apt install -y --no-install-recommends \
1212
libopenblas-openmp-dev liblapack-dev libscalapack-mpi-dev libelpa-dev libfftw3-dev libcereal-dev \
1313
libxc-dev libgtest-dev libgmock-dev libbenchmark-dev python3-numpy \
14-
bc cmake git g++ make bc time sudo unzip vim wget gfortran
14+
bc cmake git g++ make time sudo unzip vim wget gfortran
1515
# If you wish to use the LLVM compiler, replace 'g++' above with 'clang libomp-dev'.
1616

1717
ENV GIT_SSL_NO_VERIFY=true TERM=xterm-256color \

docs/CITATIONS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The following references are required to be cited when using ABACUS. Specificall
1414

1515
*For LCAO and PW basis:*
1616

17-
Weiqing Zhou, Deye Zheng, Qianrui Liu, et al. ABACUS: An Electronic Structure Analysis Package for the AI Era. arXiv preprint arXiv:2501.08697, 2025.
17+
Weiqing Zhou, Daye Zheng, Qianrui Liu, et al. ABACUS: An Electronic Structure Analysis Package for the AI Era. arXiv preprint arXiv:2501.08697, 2025.
1818

1919
- **If Stochastic DFT is used:**
2020

docs/community/faq.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212

1313
Users are referred to the introduction of features of ABACUS in the [feature list](http://abacus.ustc.edu.cn/features/list.htm).
1414

15+
**2. How to contact the ABACUS community?**
16+
17+
Users can contact the ABACUS community by join ABACUS WeChat or QQ group. One can quickly join the QQ group via group ID: 759914681
18+
19+
If users have any questions or suggestions, please feel free to contact us in group or by raising issue in GitHub repo.
20+
1521
## Installation
1622

1723
## Setting up jobs

docs/quick_start/easy_install.md

Lines changed: 97 additions & 89 deletions
Large diffs are not rendered by default.

toolchain/scripts/stage1/install_mpich.sh

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ case "${with_mpich}" in
8181
MPICC="" \
8282
FFLAGS="${FCFLAGS} ${compat_flag}" \
8383
FCFLAGS="${FCFLAGS} ${compat_flag}" \
84+
--without-x \
85+
--enable-gl=no \
8486
--with-device=${MPICH_DEVICE} \
8587
> configure.log 2>&1 || tail -n ${LOG_LINES} configure.log
8688
make -j $(get_nprocs) > make.log 2>&1 || tail -n ${LOG_LINES} make.log
@@ -90,19 +92,19 @@ case "${with_mpich}" in
9092
fi
9193
if [ "${PACK_RUN}" = "__TRUE__" ]; then
9294
echo "--pack-run mode specified, skip system check"
93-
else
94-
check_dir "${pkg_install_dir}/bin"
95-
check_dir "${pkg_install_dir}/lib"
96-
check_dir "${pkg_install_dir}/include"
97-
check_install ${pkg_install_dir}/bin/mpiexec "mpich" && MPIRUN="${pkg_install_dir}/bin/mpiexec" || exit 1
98-
check_install ${pkg_install_dir}/bin/mpicc "mpich" && MPICC="${pkg_install_dir}/bin/mpicc" || exit 1
99-
check_install ${pkg_install_dir}/bin/mpicxx "mpich" && MPICXX="${pkg_install_dir}/bin/mpicxx" || exit 1
100-
check_install ${pkg_install_dir}/bin/mpifort "mpich" && MPIFC="${pkg_install_dir}/bin/mpifort" || exit 1
101-
MPIFORT="${MPIFC}"
102-
MPIF77="${MPIFC}"
103-
MPICH_CFLAGS="-I'${pkg_install_dir}/include'"
104-
MPICH_LDFLAGS="-L'${pkg_install_dir}/lib' -Wl,-rpath,'${pkg_install_dir}/lib'"
95+
exit 0
10596
fi
97+
check_dir "${pkg_install_dir}/bin"
98+
check_dir "${pkg_install_dir}/lib"
99+
check_dir "${pkg_install_dir}/include"
100+
check_install ${pkg_install_dir}/bin/mpiexec "mpich" && MPIRUN="${pkg_install_dir}/bin/mpiexec" || exit 1
101+
check_install ${pkg_install_dir}/bin/mpicc "mpich" && MPICC="${pkg_install_dir}/bin/mpicc" || exit 1
102+
check_install ${pkg_install_dir}/bin/mpicxx "mpich" && MPICXX="${pkg_install_dir}/bin/mpicxx" || exit 1
103+
check_install ${pkg_install_dir}/bin/mpifort "mpich" && MPIFC="${pkg_install_dir}/bin/mpifort" || exit 1
104+
MPIFORT="${MPIFC}"
105+
MPIF77="${MPIFC}"
106+
MPICH_CFLAGS="-I'${pkg_install_dir}/include'"
107+
MPICH_LDFLAGS="-L'${pkg_install_dir}/lib' -Wl,-rpath,'${pkg_install_dir}/lib'"
106108
;;
107109
__SYSTEM__)
108110
echo "==================== Finding MPICH from system paths ===================="
@@ -176,9 +178,9 @@ EOF
176178
prepend_path PATH "${pkg_install_dir}/bin"
177179
export PATH="${pkg_install_dir}/bin":\${PATH}
178180
export LD_LIBRARY_PATH="${pkg_install_dir}/lib":\${LD_LIBRARY_PATH}
179-
export LD_RUN_PATH "${pkg_install_dir}/lib":\${LD_RUN_PATH}
180-
export LIBRARY_PATH "${pkg_install_dir}/lib":\${LIBRARY_PATH}
181-
export CPATH "${pkg_install_dir}/include":\${CPATH}
181+
export LD_RUN_PATH="${pkg_install_dir}/lib":\${LD_RUN_PATH}
182+
export LIBRARY_PATH="${pkg_install_dir}/lib":\${LIBRARY_PATH}
183+
export CPATH="${pkg_install_dir}/include":\${CPATH}
182184
EOF
183185
fi
184186
cat "${BUILDDIR}/setup_mpich" >> ${SETUPFILE}
@@ -189,6 +191,8 @@ cat << EOF >> ${INSTALLDIR}/lsan.supp
189191
# MPICH 3.3.2 with GCC 10.3.0
190192
leak:MPIR_Find_local_and_external
191193
leak:MPIU_Find_local_and_external
194+
# MPICH 4.2.3
195+
leak:MPL_malloc
192196
EOF
193197

194198
load "${BUILDDIR}/setup_mpich"

toolchain/toolchain_gnu.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ PACK_RUN_MODE="no" # Set to "yes" to enable pack-run mode
6666

6767
CMAKE_VERSION="main" # main=3.31.7, alt=3.30.5
6868
OPENMPI_VERSION="main" # main=5.0.8, alt=4.1.6
69+
MPICH_VERSION="main" # main=4.1.6, alt=4.1.5
6970
OPENBLAS_VERSION="main" # main=0.3.30, alt=0.3.27
7071
ELPA_VERSION="main" # main=2025.06.001, alt=2024.05.001
7172
LIBXC_VERSION="main" # main=7.0.0, alt=6.2.2
@@ -104,6 +105,7 @@ exec ./install_abacus_toolchain_new.sh \
104105
--with-4th-openmpi="$WITH_4TH_OPENMPI" \
105106
--package-version cmake:"$CMAKE_VERSION" \
106107
--package-version openmpi:"$OPENMPI_VERSION" \
108+
--package-version mpich:"$MPICH_VERSION" \
107109
--package-version openblas:"$OPENBLAS_VERSION" \
108110
--package-version elpa:"$ELPA_VERSION" \
109111
--package-version libxc:"$LIBXC_VERSION" \

0 commit comments

Comments
 (0)