Changes between Version 2 and Version 3 of CompilingPdaf

Timestamp:

Jan 9, 2022, 4:13:35 PM (2 years ago)

Author:

lnerger

Comment:

--

CompilingPdaf

@@ -1 +1 @@
 = Compiling the PDAF library =
 
-The tutorial implementations in the directory `PDAFROOT/tutorial/` and the models implemented with PDAF in `PDAFROOT/models/` are setup to compile the PDAF library when the application is compiled. (Here `PDAFROOT/` is the directory of the PDAF package)
+The tutorial implementations in the directory `PDAFROOT/tutorial/` and the models implemented with PDAF in `PDAFROOT/models/` are setup to compile the PDAF library when the application is compiled. (Here `PDAFROOT/` is the root directory of the PDAF package)
 
 The PDAF library, thus the core routines of PDAF and PDAF-OMI, can also be compiled separately. This is the common approach when one implements PDAF with some models in the online-coupled setup (see e.g. the directory `modelbindings`).
@@ -30 +30 @@
 where `<ARCH>` is the filename of the computer-specific settings from the directory `PDAFROOT/make.arch/` without `.h`. A common choice is '''<ARCH>=linux_gfortran_openmpi'''.
 
-The compilation with generate the PDAF library file '''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 compilation with generate the PDAF library file '''PDAFROOT/lib/libpdaf-var.a'''. This library also includes the ensemble filters and smoothers.
+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.
+
+
+== Linking the PDAF library ==
+
+To point to the PDAF include directory to ensure that `pdaf_interface_module` and the `PDAFomi` module are 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.
+
+For linking the PDAF library for the ensemble schemes use
+{{{
+   -L${PDAFROOT}/lib -lpdaf-d
+}}}
+while in case of the PDAF library supporting the 3D-Var schemes use
+{{{
+   -L${PDAFROOT}/lib -lpdaf-var
+}}}
+
+Apart from the PDAF library, one also needs to specify the location of the BLAS and LAPACK libraries (for example by setting `-lblas -llapack` if the libraries are installed in standard directories)