Skip to content

Commit ac9e050

Browse files
authored
Merge pull request #772 from deepmodeling/tryEigen
Doc: update dependencies
2 parents 82b5d36 + b67a5b2 commit ac9e050

File tree

2 files changed

+15
-18
lines changed

2 files changed

+15
-18
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@ on:
44
pull_request_target:
55
branches:
66
- develop
7-
- update_MD
8-
- ABACUS_2.2.0_beta
9-
- deepks
10-
- planewave
7+
- tryEigen
118
jobs:
129

1310
test:

doc/install.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,23 +57,22 @@ The source directory further contains the following folders, where the source fi
5757

5858
### Prerequisites
5959

60-
In order to compile ABACUS, users should make sure that the following prerequisites are
60+
ABACUS current supports Linux. To compile ABACUS, please make sure that the following prerequisites are
6161
present:
6262

63-
- C++ compiler, supporting C++11. For example, [Intel C++ compiler](https://software.intel.com/enus/c-compilers) or [GCC](https://gcc.gnu.org/);
64-
- Fortran compiler;
65-
- MPI compiler. The recommended version are [Intel MPI](https://software.intel.com/enus/mpi-library) or [MPICH](https://www.mpich.org/);
66-
- The ScaLAPACK library. For example, [Intel MKL](https://software.intel.com/en-us/mkl)
67-
or [Netlib ScaLAPACK](http://www.netlib.org/scalapack/);
68-
- The [FFTW library](http://www.fftw.org/). ABACUS now supports both FFTW2 and
69-
FFTW3;
70-
- The [ELPA library](https://elpa.mpcdf.mpg.de/);
71-
- The [CEREAL library](https://uscilab.github.io/cereal/);
63+
- C++ compiler, supporting C++11. You can use [Intel® C++ compiler](https://software.intel.com/enus/c-compilers) or [GCC](https://gcc.gnu.org/).
64+
- MPI compiler. The recommended version are [Intel MPI](https://software.intel.com/enus/mpi-library) or [MPICH](https://www.mpich.org/).
65+
- Fortran compiler for building `BLAS`, `LAPACK` and `ScaLAPACK`. You can use[Intel® Fortran Compiler](https://www.intel.com/content/www/us/en/developer/tools/oneapi/fortran-compiler.html) [GFortran](https://gcc.gnu.org/fortran/).
66+
- [BLAS](http://www.netlib.org/blas/). You can use [OpenBLAS](https://www.openblas.net/).
67+
- [LAPACK](http://www.netlib.org/lapack/).
68+
- [ScaLAPACK](http://www.netlib.org/scalapack/).
69+
- [FFTW](http://www.fftw.org/).
70+
- [ELPA](https://elpa.mpcdf.mpg.de/).
71+
- [CEREAL](https://uscilab.github.io/cereal/).
7272

73-
Alternatively, you can choose [Intel® oneAPI toolkit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/commercial-base-hpc.html) (former Parallel Studio) as toolchain. The [Intel® oneAPI Base Toolkit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/all-toolkits.html#base-kit) contains Intel® oneAPI Math Kernel Library (aka `MKL`), replacing `FFTW3, LAPACK,` and `ScaLAPACK`. The [Intel® oneAPI HPC Toolkit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/all-toolkits.html#hpc-kit) contains Intel® MPI Library, and C++ compiler(including MPI compiler). Please noted that building `elpa` with a different MPI library may cause conflict between MPI libraries.
74-
75-
If you use Intel toolchain, don't forget to [set environment variables](https://software.intel.com/content/www/us/en/develop/documentation/get-started-with-intel-oneapi-render-linux/top/configure-your-system.html) before you start! `cmake` will use Intel MKL if the environment variable `MKLROOT` is set.
73+
Alternatively, you can choose [Intel® oneAPI toolkit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/commercial-base-hpc.html) (former Parallel Studio) as toolchain. The [Intel® oneAPI Base Toolkit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/all-toolkits.html#base-kit) contains Intel® oneAPI Math Kernel Library (aka `MKL`), including `BLAS`, `LAPACK`, `ScaLAPACK` and `FFTW3`, - this means that no Fortran compiler required anymore. The [Intel® oneAPI HPC Toolkit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/all-toolkits.html#hpc-kit) contains Intel® MPI Library, and C++ compiler(including MPI compiler). Please noted that building `elpa` with a different MPI library may cause conflict between MPI libraries. Don't forget to [set environment variables](https://software.intel.com/content/www/us/en/develop/documentation/get-started-with-intel-oneapi-render-linux/top/configure-your-system.html) before you start! `cmake` will use Intel MKL if the environment variable `MKLROOT` is set.
7674

75+
If you have trouble building requirements, our Dockerfiles in root path offer a reference, or read the section below to use a pre-built container.
7776
[back to top](#download-and-install)
7877

7978
### Container Deployment
@@ -87,9 +86,10 @@ We also support [gitpod](https://www.gitpod.io/) to offer an ready-to-use online
8786

8887
### Build and install ABACUS with CMake
8988

89+
We recommend building ABACUS with `cmake` to avoid dependency issues. `Makefile` is deprecated.
90+
9091
#### Configure
9192

92-
We recommend building ABACUS with `cmake` to avoid dependency issues.
9393
ABACUS requires a minimum `cmake` version of `3.18`. Check the version of `cmake` on your machine with:
9494

9595
```bash

0 commit comments

Comments
 (0)