comp-chem/cp2k
1
0
Fork 0
mirror of https://github.com/cp2k/cp2k.git synced 2026-07-29 06:35:28 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Toolchain: Replace "scripts/generate_cmake_options.sh" with "build_cp2k.sh" (#5080)

Browse source 
Co-authored-by: HE Zilong <159878975+he-zilong@users.noreply.github.com>
This commit is contained in:
SY Wang 2026-04-26 18:40:37 +08:00 • committed by GitHub
parent c92e8381f7
commit f577188f47
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
49 changed files with 407 additions and 395 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/getting-started/build-from-source.md
View file

@ -3,14 +3,23 @@
CP2K uses the [CMake](https://cmake.org) build system, which detects dependencies and controls the
compilation process. The dependencies have to be installed in advance.
Currently, CP2K offers two convenient ways for building CP2K from source with its dependencies. One
is to use the classic toolchain scripts to customize and install the required dependencies in a
single step, thereby preparing the environment for compiling CP2K.
Currently, CP2K offers two convenient ways for building CP2K from source with its dependencies:
A more modern and automated approach is via the `make_cp2k.sh` script, which leverages
[Spack](https://spack.readthedocs.io) to install the dependencies and subsequently build CP2K. The
latter approach is only available for the current [CP2K master branch](https://github.com/cp2k/cp2k)
and CP2K release versions `2026.02` and newer.
- The toolchain scripts, which customize and install the required dependencies in a single step,
thereby preparing the environment for compiling CP2K. Run `install_cp2k_toolchain.sh` under
`cp2k/tools/toolchain` to perform the toolchain steps; for detailed information, see
<https://github.com/cp2k/cp2k/blob/master/tools/toolchain/README.md>. After building toolchain,
you can use `build_cp2k.sh` to build and install CP2K with prepared toolchain environment.
- The `make_cp2k.sh` script, a more modern and automated approach which leverages
[Spack](https://spack.readthedocs.io) to install the dependencies and subsequently build CP2K.
```{note}
- The toolchain does not cover all optional dependencies due to their complicated dependencies
requirements, such as DLA-Future. SIRIUS with complete support (including DFT-D4 and NLCG) is
also unavailable via toolchain due to the same reason.
- The latter approach with Spack is only available for the current
[CP2K master branch](https://github.com/cp2k/cp2k) and CP2K release versions `2026.02` and newer.
```
## make_cp2k.sh
@ -105,8 +114,8 @@ Features: cray_pm_accel_energy | cusolver_mp | dbm_gpu | elpa_gpu | grid_gpu | p
</details>
The first run will take longer as it will build all CP2K dependencies with Spack. The Spack
installation is kept fully local in the subfolder `cp2k/spack` which corresponds to the
The first run will take longer as it will build all requested CP2K dependencies with Spack. The
Spack installation is kept fully local in the subfolder `cp2k/spack` which corresponds to the
`tools/toolchain/install` folder created by the CP2K toolchain.
Subsequent runs of the `make_cp2k.sh` script will use the software stack from that `cp2k/spack`

6
docs/getting-started/distributions.md
View file

@ -2,6 +2,12 @@
The easiest way to get started with CP2K is to install it from a distribution.
```{note}
The pre-compiled package from distributions may not performs as well as package
built from source, as it usually adopts a conservative compilation strategy to
ensure broad compatibility.
```
## Arch
```shell