Skip to content

Commit 2efc624

Browse files
committed
update instal
1 parent 5e39bfd commit 2efc624

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,4 @@ The library was initially designed thanks to several projects funded under the H
5656
pages/fft.rst
5757
pages/api.rst
5858
pages/benchmarks.rst
59+
pages/publications.rst

docs/source/pages/installation.rst

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
Installation
33
============
44

5-
# Bulding and installing 2decomp-fft
5+
Bulding and installing 2decomp-fft
6+
==================================
67

7-
## Building
8+
Building
9+
===========
810

911
The build system is driven by `cmake`. It is good practice to directly point to the MPI Fortran wrapper that you would like to use to guarantee consistency between Fortran compiler and MPI. This can be done by setting the default Fortran environmental variable
1012
```
@@ -56,7 +58,8 @@ Occasionally a clean build is required, this can be performed by running
5658
cmake --build $path_to_build_directory --target clean
5759
```
5860

59-
## GPU compilation
61+
GPU compilation
62+
===============
6063

6164
The library can perform multi GPU offoloading using the NVHPC compiler suite for NVIDIA hardware.
6265
The implementation is based on CUDA-aware MPI and NVIDIA Collective Communication Library (NCCL).
@@ -83,9 +86,11 @@ It is possible that your default C compiler is too recent and not supported by `
8386

8487
At the moment the supported CUDA host compilers are `gcc11` and earlier.
8588

86-
## Linking from external codes
89+
Linking from external codes
90+
==============================
8791

88-
### Codes using Makefiles
92+
Codes using Makefiles
93+
=========================
8994

9095
When building a code that links 2decomp-fft using a Makefile you will need to add the include and link paths as appropriate (`inlude/` and `lib/` under the installation directory, respectively).
9196
```
@@ -144,7 +149,8 @@ clean-decomp:
144149
rm -f $(DECOMP_INSTALL_DIR)/lib/libdecomp.a
145150
```
146151

147-
## Profiling
152+
Profiling
153+
=========
148154

149155
Profiling can be activated via `cmake` configuration, the recommended approach is to run the initial configuration as follows:
150156
```
@@ -155,9 +161,11 @@ cmake -S $path_to_sources -B $path_to_build_directory -DENABLE_PROFILER=caliper
155161
where `ENABLE_PROFILER` is set to the profiling tool desired, currently supported values are: `caliper`.
156162
Note that when using `caliper` a C++ compiler is required as indicated in the above command line.
157163

158-
## Miscellaneous
164+
Miscellaneous
165+
=============
159166

160-
### List of preprocessor variables
167+
List of preprocessor variables
168+
==============================
161169

162170
#### DEBUG
163171

@@ -223,7 +231,8 @@ or modify the build configuration using `ccmake`.
223231

224232
Note the legacy `fftw` interface lacks interface definitions and will fail when stricter compilation flags are used (e.g. when `-DCMAKE_BUILD_TYPE=Dev`) for this it is recommended to use `fftw_f03` which provides proper interfaces.
225233

226-
### Caliper
234+
Caliper
235+
========
227236

228237
The library [caliper](https://github.com/LLNL/Caliper) can be used to profile the execution of the code. The version 2.9.1 was tested and is supported, version 2.8.0 has also been tested and is still expected to work. Please note that one must build caliper and decomp2d against the same C/C++/Fortran compilers and MPI libray. For build instructions, please check [here](https://github.com/LLNL/Caliper#building-and-installing) and [here](https://software.llnl.gov/Caliper/CaliperBasics.html#build-and-install). Below is a suggestion for the compilation of the library using the GNU compilers:
229238

0 commit comments

Comments
 (0)