Skip to content

Commit

Permalink
update documentation to reflected extended compiler support
Browse files Browse the repository at this point in the history
At some point we should stop mentioning supported compilers at multiple
locations and just keep a central list.
  • Loading branch information
tukss committed Dec 21, 2021
1 parent cf75bd9 commit 42c72d9
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
20 changes: 10 additions & 10 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ three commands from within <rayleigh root>:
(4.) Running 'make distclean' will revert <rayleigh root> to it's
pre-configured state.

The configure script automatically supports both GNU and Intel Compilers. An
IBM-compiler example is provided at the end of this document. On many
Intel-based machines, running ./configure or ./configure -mkl will suffice.
In other circumstances, it may be necessary to specify a subset of configure's
options. Some possible variations are illustrated in section III.
The configure script automatically supports the GNU, Intel, AOCC, and Cray
compilers. An IBM-compiler example is provided at the end of this document.
On many Intel-based machines, running ./configure or ./configure -mkl will
suffice. In other circumstances, it may be necessary to specify a subset of
configure's options. Some possible variations are illustrated in section III.

To see a detailed description of all available options, run ./configure -h.

Expand Down Expand Up @@ -167,11 +167,11 @@ FFTWROOT=/software/fftw/3.3.4
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
III.e Configuration using Alternative Compilers / Customized Compiler Flags

For compilers other than GNU or Intel, you will need to manually specify the
optimization, library, and include flags. You may also wish to do this if you
are experimenting with new compilation flags that are not automatically
provided by configure for Intel or GNU. These flags can be set using
--LIBFLAGS, --FFLAGS_OPT, --FFLAGS_DBG, and --INCLUDE. FFLAGS_OPT and
For compilers other than GNU, Intel, AOCC, or Cray, you will need to manually
specify the optimization, library, and include flags. You may also wish to do
this if you are experimenting with new compilation flags that are not
automatically provided by configure for known compilers. These flags can be set
using --LIBFLAGS, --FFLAGS_OPT, --FFLAGS_DBG, and --INCLUDE. FFLAGS_OPT and
FFLAGS_DBG define the optimization flags used for rayleigh.opt and rayleigh.dbg
respectively.

Expand Down
6 changes: 3 additions & 3 deletions doc/source/User_Guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Third-Party Dependencies

In order to compile Rayleigh, you will need to have MPI (Message Passing
Interface) installed along with a Fortran 2003-compliant compiler.
Rayleigh has been successfully compiled with GNU, Intel, and IBM
compilers (PGI has not been tested yet). Rayleigh’s configure script
provides native support for the Intel and GNU compilers. See
Rayleigh has been successfully compiled with GNU, Intel, IBM, AOCC, and
Cray compilers (PGI has not been tested yet). Rayleigh’s configure script
provides native support for the Intel, GNU, AOCC, and Cray compilers. See
Rayleigh/INSTALL for an example of configuration using the IBM compiler.

Rayleigh depends on the following third party libraries:
Expand Down
4 changes: 2 additions & 2 deletions doc/source/User_Guide/running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ Soft-linking is recommended; if you recompile the code, the executable
remains up-to-date. If running on an IBM machine, copy the script named
Rayleigh/etc/make_dirs to your run directory and execute the script.
This will create the directory structure expected by Rayleigh for its
outputs. This step is unnecessary when compiling with the Intel or GNU
compilers.
outputs. This step is unnecessary when compiling with the Intel, GNU,
AOCC, or Cray compilers.

Next, you must create a main_input file. This file contains the
information that describes how your simulation is run. Rayleigh always
Expand Down

0 comments on commit 42c72d9

Please sign in to comment.