Changeset 18 for trunk/src

Timestamp:

12/17/10 12:11:29 (13 years ago)

Author:

pinsard

Message:

improve oaflux_mask_30N30S.pro documenation

File:

• trunk/src/oaflux_mask_30N30S.pro (modified) (2 diffs)

trunk/src/oaflux_mask_30N30S.pro

@@ -3 +3 @@
 ; .. _oaflux_mask_30N30S.pro:
 ;
-; ======================
-; oaflux_mask_30N30S.pro
-; ======================
-;
-; Produce a NetCDF file with  OAFLUX mask over global tropical oceans 
-;
-;     .. graphviz::
-;
-;        digraph oaflux_mask_30N30S {
-;           graph [
-;           rankdir="LR",
-;           ]
-;           file_oaflux [shape=ellipse,fontname=Courier,label="${TROPFLUX_ID}/lh_oaflux_2004.nc"];
-;           mask [shape=ellipse,fontname=Courier,label="${TROPFLUX_OD}/mask_oaflux_30N30S.nc"];
-;
-;           oaflux_mask_30N30S [shape=box,
-;           fontname=Courier,
-;           color=blue,
-;           URL="http://forge.ipsl.jussieu.fr/tropflux/browser/trunk/src/oaflux_mask_30N30S.pro",
-;           label="${TROPFLUX}/src/oaflux_mask_30N30S.pro"];
-;
-;           {file_oaflux} -> {oaflux_mask_30N30S} -> {mask}
-;
-;          }
+; =================================================================
+; oaflux_mask_30N30S.pro -- OAFLUX mask over global tropical oceans
+; =================================================================
+;
+; Produce a NetCDF file with OAFLUX mask over global tropical oceans (30N-30S)
+;
+; .. note::
+;
+;    Longitude range [30.5,379.5] was choosen in order not to make any cut in
+;    the Atlantic Ocean.
+;    Otherwise if we choose longitude range to [0.5,359.5], Atlantic Ocean
+;    will be split to two and will appear on right and left sides of the map.
+;
+; .. graphviz::
+;
+;    digraph oaflux_mask_30N30S {
+;       graph [
+;       rankdir="LR",
+;       ]
+;       file_oaflux [shape=ellipse,fontname=Courier,label="${TROPFLUX_ID}/lh_oaflux_2004.nc"];
+;       mask [shape=ellipse,fontname=Courier,label="${TROPFLUX_OD}/mask_oaflux_30N30S.nc"];
+;
+;       oaflux_mask_30N30S [shape=box,
+;       fontname=Courier,
+;       color=blue,
+;       URL="http://forge.ipsl.jussieu.fr/tropflux/browser/trunk/src/oaflux_mask_30N30S.pro",
+;       label="${TROPFLUX}/src/oaflux_mask_30N30S.pro"];
+;
+;       {file_oaflux} -> {oaflux_mask_30N30S} -> {mask}
+;
+;      }
 ;
 ; SEE ALSO
 ; ========
 ;
+; :ref:`guide Gather data <gather_data>`
+;
 ; :ref:`guide data OAFLUX <data_in_oaflux>`
 ;
 ; :ref:`tropflux_profile.sh`
 ;
-; :func:`report`
-; :func:`initncdf`
-; :func:`ncdf_lec`
-; :ref:`ncdf_quickwrite`
-; :func:`isadirectory`
+; :func:`report <saxo:report>`
+; :func:`initncdf <saxo:initncdf>`
+; :func:`ncdf_lec <saxo:ncdf_lec>`
+; :ref:`ncdf_quickwrite <saxo:ncdf_quickwrite>`
+; :func:`isadirectory <saxo:isadirectory>`
 ;
 ; EXAMPLES
@@ -57 +66 @@
 ; pro -> function
 ;
-; NetCDF CF (may be area_type) 
-; 
+; NetCDF CF (may be area_type)
+;
 ; global attributes corrections :
 ;  - written now : OAFLUX mask over the Indian Ocean: 40E-120E, 30S-30N