Skip to content

Commit aa495a6

Browse files
committed
update doc
1 parent 294c0d9 commit aa495a6

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

CMakeLists.txt

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,25 @@ cmake_minimum_required (VERSION 3.18)
5353
!!/
5454
!!/ Configure Compilers
5555
!!/ -------------------
56+
!!/ If we are lucky, we do not need to specify compilers in the *cmake*
57+
!!/ configuration. However, specifying these compilers is preferred because
58+
!!/ programs are not always installed the way we wanted.
5659
!!/ Set *CXX=...*, *CUDACXX=...*, and *FC=...* to specify the non-default C++,
5760
!!/ CUDA, and Fortran compilers, respectively. These environmental variables
5861
!!/ are supported by *cmake*.
62+
!!/ Do not use nvfortran.
5963
!!/
6064
!!/ This cmake script checks a custom environmental variable *ACC=...*
61-
!!/ *only* for the GPU code.
65+
!!/ *only* for the OpenACC GPU code.
6266
!!/ If not set, the building script will take a guess at the OpenACC compiler.
6367
!!/ *ACC* will also be used as the C++ compiler. The value of *CXX* (if set)
6468
!!/ will be neglected.
6569
!!/
70+
!!/ The only place where a C compiler may be used in Tinker9 is on the old Mac
71+
!!/ computers that had Nvidia support. clang is hardwired in the cmake scripts
72+
!!/ to compile the Objective-C and C source files. Thus, *CC=...* is not worth
73+
!!/ setting in the cmake configuration.
74+
!!/
6675
!!/ Configure Tinker9
6776
!!/ -----------------
6877
!!/ The following options are passed to CMake program with their default
@@ -150,6 +159,10 @@ endif ()
150159
!!/ C++ syntax standard. The source code is c++11-compliant, and should have no
151160
!!/ problems compiled with c++14. If set to *14* here, users should make sure
152161
!!/ the compilers are c++14-compliant.
162+
!!/ In general, Users should not worry about the C++ standard for Tinker9.
163+
!!/ Using a more recent C++ standard to write the source code is unlikely
164+
!!/ to speed up the performance of Tinker9 and may harm the availability of
165+
!!/ Tinker9 to older machines.
153166
!!/
154167
]]
155168
if (DEFINED ENV{std})

doc/manual/m/install/buildwithcmake.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,25 @@ above.
4949

5050
Configure Compilers
5151
-------------------
52+
If we are lucky, we do not need to specify compilers in the *cmake*
53+
configuration. However, specifying these compilers is preferred because
54+
programs are not always installed they way we wanted.
5255
Set *CXX=...*, *CUDACXX=...*, and *FC=...* to specify the non-default C++,
5356
CUDA, and Fortran compilers, respectively. These environmental variables
5457
are supported by *cmake*.
58+
Do not use nvfortran.
5559

5660
This cmake script checks a custom environmental variable *ACC=...*
57-
*only* for the GPU code.
61+
*only* for the OpenACC GPU code.
5862
If not set, the building script will take a guess at the OpenACC compiler.
5963
*ACC* will also be used as the C++ compiler. The value of *CXX* (if set)
6064
will be neglected.
6165

66+
The only place where a C compiler may be used in Tinker9 is on the old Mac
67+
computers that had Nvidia support. clang is hardwired in the cmake scripts
68+
to compile the Objective-C and C source files. Thus, *CC=...* is not worth
69+
setting in the cmake configuration.
70+
6271
Configure Tinker9
6372
-----------------
6473
The following options are passed to CMake program with their default
@@ -90,6 +99,9 @@ different from the default cmake behavior to install the program under */usr/loc
9099
C++ syntax standard. The source code is c++11-compliant, and should have no
91100
problems compiled with c++14. If set to *14* here, users should make sure
92101
the compilers are c++14-compliant.
102+
In general, Users should not worry about the C++ standard for Tinker9.
103+
Using a more recent C++ standard is unlikely to speed up the performance of
104+
Tinker9 and may harm the availablity of Tinker9 to older machines.
93105

94106
**-DPREC (prec) = mixed**
95107

0 commit comments

Comments
 (0)