Changes between Version 10 and Version 11 of CompilingPdaf

Timestamp:

Jun 1, 2025, 10:41:25 AM (3 days ago)

Author:

lnerger

Comment:

--

CompilingPdaf

@@ -3 +3 @@
 The library file of PDAF can be compiled on its own or in connection with an example implementation from `tutorial/` or `models/`.  In order to build the library file, you need a Fortran-2003 compatible compiler and 'make'. In addition, the libraries 'BLAS', 'LAPACK', and 'MPI' are required. Here, we describe the stand-alone compilation, which one can use for example to compile some model code with added coupling for PDAF.
 
-== Specify the machine-spefic compile settings ==
+== Specify the machine-specific compile settings ==
 
-To compile the PDAF library first choose a suitable include file for the make process and/or edit one. In the directory `make.arch/` several include files are provided. The name of the include files as well as the header comment in the file described the intended architecture. The choice  `linux_gfortran_openmpi.h` is a quite generic choice that should work on a wide range of computers.
+To compile the PDAF library first choose a suitable include file for the make process and/or edit one. In the directory `make.arch/` several include files are provided. The name of the include files as well as the header comment in the file described the intended architecture. The choice  `linux_gfortran.h` is a quite generic choice that should work on a wide range of computers.
 
-The environment variable '''PDAF_ARCH''' specifies for which architecture you compile PDAF according to your choice above. You need to specify the file name without '.h'. You can specify PDAF_ARCH in the make command line like `make PDAF_ARCH=<NAME>`. Alternatively, you can set the environment variable $PDAF_ARCH in the shell to the name of the include file (without ending .h). For a (t)csh shell one can set the variable by 
-`setenv PDAF_ARCH <NAME>`
-while for bash one uses 
-`export PDAF_ARCH=<NAME>`.
+The environment variable **PDAF_ARCH** specifies for which architecture you compile PDAF according to your choice above. You need to specify the file name without '.h'. You can specify PDAF_ARCH in the make command line like `make PDAF_ARCH=<NAME>`. Alternatively, you can set the environment variable $PDAF_ARCH in the shell to the name of the include file (without ending .h). For a bash shell one uses
+{{{
+export PDAF_ARCH=<NAME>
+}}}
+where <NAME> is the name of the file in `make.arch/` with out '.h'.
 
 
@@ -16 +17 @@
 == Compiling PDAF ==
 
-To compile PDAF, do the following:
+To compile PDAF, do the following in PDAF's main directory (denoted here PDAFROOT):
 
 {{{
@@ -22 +23 @@
 }}}
 
-The compilation with generate the PDAF library files '''PDAFROOT/lib/libpdaf-d.a''' and '''PDAFROOT/lib/libpdaf-var.a'''. In addition several Fortran module files `*.mod` are generated in the directory `PDAFROOT/include/`. These will be used when compiling the application program coupled to PDAF. The file '''PDAFROOT/lib/libpdaf-var.a''' provides the 3D-Var methods in addition to ensemble methods, while '''PDAFROOT/lib/libpdaf-d.a''' is the standard file without 3D-Var methods.
+The compilation with generate the PDAF library files `PDAFROOT/lib/libpdaf-d.a`and `PDAFROOT/lib/libpdaf-var.a`. In addition several Fortran module files `*.mod` are generated in the directory `PDAFROOT/include/`. These will be used when compiling the application program coupled to PDAF. The file `PDAFROOT/lib/libpdaf-d.a` is the standard library containing the ensemble-based fitler methods, while the file `PDAFROOT/lib/libpdaf-var.a` provides, in addition, the 3D-Var methods and solvers. 
 
 
@@ -28 +29 @@
 == Linking the PDAF library ==
 
-To point to the PDAF include directory to ensure that the modules `pdaf_interface_module.mod` and `PDAFomi.mod` are found, one should specificy
+To point to the PDAF include directory to ensure that the module `pdaf.mod` is found, one should specificy
 {{{
    -I${PDAFROOT}/include
 }}}
-Here `${PDAFROOT}` is the directory of the PDAF package. It can either be directly specified by replacing ${PDAFROOT} or one speficies PDAFROOT as a variable.
+Here `${PDAFROOT}` is the directory of the PDAF package. It can either be directly specified by replacing ${PDAFROOT} or one specifies PDAFROOT as a variable.
 
-For linking the PDAF library for the ensemble schemes use
+For linking the PDAF library for the ensemble-based filter methods use
 {{{
    -L${PDAFROOT}/lib -lpdaf-d
@@ -48 +49 @@
 == Notes ==
 
- * '''Note on parallelization:'''[[BR]] PDAF is generally intended for parallel computing using MPI. Before PDAF V2.0 it was also possible to compile PDAF without MPI by using a stub library that simulated the behavior for MPI for a single process that we provided with PDAF. With PDAF V2., we revised the MPI implementation and removed this option. Given that it is today extremely easy to install an MPI library (it is virtually always available as a package in any Linux distribution and standard on cluster computers) we prefer not to invest in maintaining and upgrading the MPI stub library.
+ * '''Note on parallelization:'''[[BR]] PDAF is generally intended for parallel computing using MPI. As such, it is required to compile PDAF with an MPI library. Such library, like the widely used OpenMPI, is today extremely easy to install (it is virtually always available as a package in any Linux distribution and standard on cluster computers).
 
  * '''Note on precision of floating point variables:'''[[BR]] PDAF is designed to use floating point variables of double precision. However, for flexibility the variables are decared in the source code without a 'KIND' specification. 
-  * For the compilation one has to specify that the compiler treats all 'real' variables with double precision accuracy. This is done, e.g. for gfortran by setting `-fdefault-real-8` or for ifort by setting `-r8`. In the provided include files in `make.arch/` these specifications are included. 
-  * PDAF also supports single precision. To enable it in PDAF, one has to use the preprocessor definition `-DSNGLPREC`. Then one has to compile without the double-precision settings.
+  * For the compilation one has to specify that the compiler treats all 'real' variables with double precision accuracy. This is done, e.g. for gfortran by setting `-fdefault-real-8` or for ifort by setting `-r8`. The provided include files in `make.arch/` include these specifications. 
+  * PDAF also supports single precision. To enable single prevision in PDAF, one has to use the preprocessor definition `-DSNGLPREC`. Then one has to compile without the double-precision settings.