Changeset a9d33f6 in flex_extract.git for For_developers/Sphinx/source/Documentation

Timestamp:

Jun 1, 2020, 7:58:31 PM (4 years ago)

Author:

Petra Seibert <petra.seibert [at) univie.ac.at>

Branches:

master, ctbto, dev

Children:

5bee29a

Parents:

5920b7f

Message:

changes related to makefile, structure and names of top-level sections

Location:

For_developers/Sphinx/source/Documentation

Files:

• Input/fortran_makefile.rst (modified) (2 diffs)
• Input/jobscript.rst (modified) (1 diff)
• Input/setup.rst (modified) (1 diff)
• disagg.rst (modified) (3 diffs)

For_developers/Sphinx/source/Documentation/Input/fortran_makefile.rst

@@ -16 +16 @@
 | Files to be used as they are!
     
-    | **makefile_ecgate**: For  use on ECMWF's server **ecgate**.
-    | **makefile_cray**:   For  use on ECMWF's server **cca/ccb**. 
+    | **makefile_ecgate**: For  use on the ECMWF server **ecgate**.
+    | **makefile_cray**:   For  use on the ECMWF servers **cca/ccb**. 
     
 | **Local mode**
@@ -24 +24 @@
     | **makefile_fast**:  For use with the gfortran compiler and optimisation mode.
     | **makefile_debug**: For use with the gfortran compiler and debugging mode. Primarily for developers.
+    | **makefile_local_gfortran**: Linked to makefile_fast. Default value.
+
+They can be found at ``flex_extract_vX.X/Source/Fortran/``, where ``vX.X`` should be substituted by the current flex_extract version number.
+
+.. caution::   
+   It is necessary to adapt **ECCODES_INCLUDE_DIR** and **ECCODES_LIB** in these
+   ``makefiles`` if other than standard paths are used.
+
+Thus, go to the ``Fortran`` source directory and open the ``makefile`` of your 
+choice, and check / modify with an editor of your choice:
+
+.. code-block:: bash 
+
+   cd flex_extract_vX.X/Source/Fortran
+   nedit makefile_fast
+ 
+Set the paths to the ``eccodes`` library on your local machine, if necessary.
+
+.. caution::
+   This can vary from system to system. 
+   It is suggested to use a command like 
+
+   .. code-block:: bash
+
+      # for the ECCODES_INCLUDE_DIR path do:
+      $ dpkg -L libeccodes-dev | grep eccodes.mod
+      # for the ECCODES_LIB path do:
+      $ dpkg -L libeccodes-dev | grep libeccodes.so
+      
+   to find out the path to the ``eccodes`` library.
+   
+Assign these paths to the parameters **ECCODES_INCLUDE_DIR**
+and **ECCODES_LIB** in the makefile, and save it.
+
+.. code-block:: bash
+
+   # these are the paths on Debian Buster:
+   ECCODES_INCLUDE_DIR=/usr/lib/x86_64-linux-gnu/fortran/gfortran-mod-15/
+   ECCODES_LIB= -L/usr/lib -leccodes_f90 -leccodes -lm  
+   
 
 If you want to use another compiler than gfortran locally, you can still take ``makefile_fast``,
 and adapt everything that is compiler-specific in this file.
-
-For instructions on how to adapt the ``makefile`` (local application mode only),
-please see :ref:`ref-install-local`.
 
    

For_developers/Sphinx/source/Documentation/Input/jobscript.rst

@@ -139 +139 @@
     mailfail ${USER} 
     mailops ${USER} 
-    makefile Makefile.gfortran
     marsclass EP
     maxstep 0

For_developers/Sphinx/source/Documentation/Input/setup.rst

@@ -174 +174 @@
                             Valid targets: local | ecgate | cca , the latter two
                             are at ECMWF (default: None)
-      --makefile MAKEFILE   Name of Makefile to use for compiling the Fortran
-                            program (default: None)
+      --makefile MAKEFILE   Name of makefile to compile the Fortran
+                            code. (default depends on `target`: local - makefile_local_gfortran,
+                            ecgate - makefile_ecgate, cca - makefile_cray)
       --ecuid ECUID         The user id at ECMWF. (default: None)
       --ecgid ECGID         The group id at ECMWF. (default: None)

For_developers/Sphinx/source/Documentation/disagg.rst

@@ -17 +17 @@
     :widths: 5,15,5,10
     
-    LSP,  "large-scale precipitation",          ":math:`m`",          "modified linear interpolation"
-    CP,   "convective precipitation",           ":math:`m`",          "modified linear interpolation"
-    SSHF, "surface sensible heat flux",         ":math:`J m^{-2}`",   "bicubic interpolation"
-    EWSS, "eastward turbulent surface stress",  ":math:`N m^{-2} s`", "bicubic interpolation"
-    NSSS, "northward turbulent surface stress", ":math:`N m^{-2} s`", "bicubic interpolation"
-    SSR,  "surface net solar radiation",        ":math:`J m^{-2}`",   "bicubic interpolation"
+    LSP,  "large-scale precipitation",          "m",          "modified linear interpolation"
+    CP,   "convective precipitation",           "m",          "modified linear interpolation"
+    SSHF, "surface sensible heat flux",         "J m:math:`^{-2}`",   "bicubic interpolation"
+    EWSS, "eastward turbulent surface stress",  "N m:math:`^{-2}` s", "bicubic interpolation"
+    NSSS, "northward turbulent surface stress", "N m:math:`^{-2}` s", "bicubic interpolation"
+    SSR,  "surface net solar radiation",        "J m:math:`^{-2}`",   "bicubic interpolation"
     
 
@@ -62 +62 @@
 
 
-Disaggregation is done for four adjacent timespans (:math:`a_0, a_1, a_2, a_3`) which generates a new, disaggregated value which is output at the central point of the four adjacent timespans. 
+Disaggregation is done for four adjacent time intervals (:math:`a_0, a_1, a_2, a_3`) which generates a new, disaggregated value which is output at the central point of the four adjacent time intervals. 
 
 .. math::
 
-       p_{ac} &= 0.5 * a_1\\
+       p_{ac} &= 0.5  a_1\\
             m &= a_0 + a_2 > 0.\\
-    p_{ac}(m) &= a_1(m) * a_2(m) / (a_0(m) + a_2(m))\\
+    p_{ac}(m) &= a_1(m) a_2(m) / (a_0(m) + a_2(m))\\
        p_{bd} &= 0.5 * a_2\\
             m &= a_1 + a_3 > 0.\\
-    p_{bd}(m) &= a_1(m) * a_2(m) / (a_1(m) + a_3(m))\\
+    p_{bd}(m) &= a_1(m)  a_2(m) / (a_1(m) + a_3(m))\\
 
 
-This new point :math:`p` is used for linear interpolation of the complete timeseries afterwards. If one of the four original timespans has a value below 0, it is set to 0 prior to the calculation.
+This new point :math:`p` is used for linear interpolation of the complete timeseries afterwards. If one of the four original time intervals has a value below 0, it is set to 0 prior to the calculation.
     
 .. math::
@@ -162 +162 @@
 The accumulated values for the other variables are first divided by the number of hours and
 then interpolated to the exact times using a bicubic interpolation which conserves the integrals of the fluxes within each timespan.
-Disaggregation is done for four adjacent timespans (:math:`p_a, p_b, p_c, p_d`) which produces a new, disaggregated value that is the output at the central point of the four adjacent timespans.
+Disaggregation is done for four adjacent time intervals (:math:`p_a, p_b, p_c, p_d`) which produces a new, disaggregated value that is the output at the central point of the four adjacent time intervals.
 
 .. math::