Changeset 179

Timestamp:

03/26/12 11:35:23 (12 years ago)

Author:

pinsard

Message:

tropflux_nrt_ncdf is now a function

Location:

trunk

Files:

• docs/docs_dev/source/guides/generate_tropflux.rst (modified) (1 diff)
• src/tropflux.pro (modified) (1 diff)
• src/tropflux.sh (modified) (4 diffs)
• src/tropflux_nrt_ncdf.pro (moved) (moved from trunk/src/TropFlux_NRT_ncdf.pro) (17 diffs)
• src/tropflux_swr_blnd.pro (modified) (2 diffs)

trunk/docs/docs_dev/source/guides/generate_tropflux.rst

@@ -148 +148 @@
 tools :
  - :func:`cronin_gustiness_ncdf`
- - :func:`tropflux` (:func:`cor30a`), :ref:`TropFlux_NRT_ncdf.pro` 
+ - :func:`tropflux` (:func:`cor30a`), :func:`tropflux_nrt_ncdf` 
 
 After that step, there are 5 files: Tropflux :math:`T_{2m}`, :math:`q_{2m}`, SST, wind, and one file with the 4 components of the net flux (sensible, latent, SWR, LWR)

trunk/src/tropflux.pro

@@ -71 +71 @@
 ; :file:`${PROJECT_OD}/TropFlux_{yyyymmdd}_{yyyymmdd}_coarev3.nc`
 ; will be used by
-; :ref:`TropFlux_NRT_ncdf.pro`.
+; :func:`tropflux_nrt_ncdf`.
 ;
 ;     .. graphviz::

trunk/src/tropflux.sh

@@ -96 +96 @@
 # :func:`t2m_correction_ncdf`, :func:`ws_correction_ncdf`,
 # :func:`tropflux_swr_dt`, :func:`tropflux_swr_nrt`, :func:`tropflux_swr_blnd`,
+# :func:`tropflux_nrt_cdf`,
 # etc.
 #
@@ -117 +118 @@
 #
 # $URL$
+#
+# - pinsard 20120326
+#
+#   * TropFlux_NRT_ncdf replace by tropflux_nrt_ncdf which is now a function
 #
 # - pinsard 20120322
@@ -435 +440 @@
    exit
 ENDIF
-;.compile TropFlux_19890101_20091231
 result = tropflux(${yyyymmddb}, ${yyyymmdde})
 IF result < 0 THEN BEGIN
@@ -442 +446 @@
    exit
 ENDIF
-;.compile TropFlux_NRT_ncdf
-;tropflux_nrt_ncdf
+result = tropflux_nrt_ncf(${yyyymmddb}, ${yyyymmdde})
+IF result < 0 THEN BEGIN
+   msg = 'eee : pb after tropflux_nrt_ncdf' + string(result)
+   err = report(msg)
+   exit
+ENDIF
 end
 EOF

trunk/src/tropflux_nrt_ncdf.pro

@@ -1 +1 @@
 ;+
 ;
-; .. _TropFlux_NRT_ncdf.pro:
-;
 ; =====================
-; TropFlux_NRT_ncdf.pro
+; tropflux_nrt_ncdf.pro
 ; =====================
 ;
-; :file:`${PROJECT_OD}/TropFlux_swr_19890101_20091231_BLND.nc`
+; .. function:: tropflux_nrt_ncdf(yyyymmddb, yyyymmdde)
+;
+; :file:`${PROJECT_OD}/TropFlux_swr_{yyyymmdd}_{yyyymmdd}_BLND.nc`
 ; containing
 ; ws corrected on OAFLUX grid
@@ -13 +13 @@
 ; :func:`tropflux_swr_blnd`.
 ;
-; :file:`${PROJECT_OD}/TropFlux_lwr_19890101_20091231.nc`
+; :file:`${PROJECT_OD}/TropFlux_lwr_{yyyymmdd}_{yyyymmdd}.nc`
 ; containing
 ; lwr corrected on OAFLUX grid
@@ -19 +19 @@
 ; :func:`lwr_correction_ncdf`.
 ;
-; :file:`${PROJECT_OD}/TropFlux_19890101_20091231_coare3.nc`
+; :file:`${PROJECT_OD}/TropFlux_{yyyymmdd}_{yyyymmdd}_coare3.nc`
 ; containing
 ; ++
@@ -26 +26 @@
 ;
 ; ++ are written
-; in :file:`${PROJECT_OD}/TropFlux_19890101_20091231.nc`
+; in :file:`${PROJECT_OD}/TropFlux_{yyyymmdd}_{yyyymmdd}.nc`
 ; if this file not already exists.
 ;
@@ -33 +33 @@
 ;        digraph tropflux_nrt_ncdf {
 ;
-;           file_swr [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_swr_19890101_20091231_BLND.nc"];
-;           file_lwr [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_lwr_19890101_200912310.nc"];
-;           file_coare [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_19890101_20091231_coarev3.nc"];
-;           file_out [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_19890101_20091231.nc"];
+;           file_swr [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_swr_{yyyymmdd}_{yyyymmdd}_BLND.nc"];
+;           file_lwr [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_lwr_{yyyymmdd}_{yyyymmdd}.nc"];
+;           file_coare [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_{yyyymmdd}_{yyyymmdd}_coarev3.nc"];
+;           file_out [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_{yyyymmdd}_{yyyymmdd}.nc"];
 ;
 ;           tropflux_nrt_ncdf [shape=box,
 ;           fontname=Courier,
 ;           color=blue,
-;           URL="http://forge.ipsl.jussieu.fr/tropflux/browser/trunk/src/TropFlux_NRT_ncdf.pro",
-;           label="${PROJECT}/src/TropFlux_NRT_ncdf.pro" ];
+;           URL="http://forge.ipsl.jussieu.fr/tropflux/browser/trunk/src/tropflux_nrt_ncdf.pro",
+;           label="${PROJECT}/src/tropflux_nrt_ncdf.pro" ];
 ;
 ;           {file_swr file_lwr file_coare} -> {tropflux_nrt_ncdf} -> {file_out}
@@ -50 +50 @@
 ; SEE ALSO
 ; ========
+;
+; Used by :ref:`tropflux.sh`
+;
+; :ref:`project_profile.sh`
 ;
 ; :func:`initncdf <saxo:initncdf>`
@@ -62 +66 @@
 ; ::
 ;
-;  IDL> .compile TropFlux_NRT_ncdf
-;  IDL> tropflux_nrt_ncdf
+;  yyyymmddb = 20000101L
+;  yyyymmdde = 20001231L
+;  result = tropflux_nrt_ncdf(yyyymmddb, yyyymmdde)
+;  print, result
 ;
 ; TODO
 ; ====
 ;
+; handlind yyyymmdde > 20071231 see attributes also
+;
 ; coding rules
-;
-; get rid of uppercase to avoid compile
 ;
 ; create 4 files instead of one now
@@ -77 +83 @@
 ; ==========
 ;
-; $Id: TropFlux_NRT_ncdf.pro 88 2011-08-19 15:40:14Z pinsard $
+; $Id: tropflux_nrt_ncdf.pro 88 2011-08-19 15:40:14Z pinsard $
 ;
 ; $URL$
+;
+; - fplod 20120326
+;
+;   * pro -> func
+;   * rename with lower case TropFlux_NRT_ncdf.pro become tropflux_nrt_ncdf.pro
+;   * taking project_overwite into account
+;   * try to add compile_opt seems to be incompatible with ncdf_quickwrite
+;   * hard coded st and en replaced by yyyymmddb and yyyymmdde parameters
+;   * get rid of timegen
 ;
 ; - fplod 20110809T133815Z cratos (Linux)
@@ -100 +115 @@
 ;
 ;-
-pro TropFlux_NRT_ncdf
+function tropflux_nrt_ncdf $
+         , yyyymmddb $
+         , yyyymmdde
+;
+compile_opt idl2, strictarrsubs, logical_predicate
 ;
 @cm_4cal
@@ -108 +127 @@
 @cm_project
 ;
+; Return to caller if errors
+ON_ERROR, 2
+;
+result = -1
+;
+usage = 'result = tropflux_swr_dt(yyyymmddb, yyyymmdde)'
+nparam = N_PARAMS()
+IF (nparam NE 2) THEN BEGIN
+    ras = report(['Incorrect number of arguments.' $
+              + '!C' $
+              + 'Usage : ' + usage])
+    return, result
+ENDIF
+;
 ; test if ${PROJECT_OD} defined
 CASE project_od_env OF
@@ -113 +146 @@
          msg = 'eee : ${PROJECT_OD} is not defined'
          ras = report(msg)
-       STOP
+       return, result
        END
   ELSE: BEGIN
@@ -128 +161 @@
    msg = 'eee : the directory' + iodirout  + ' is not accessible.'
    ras = report(msg)
-   STOP
+   return, result
 ENDIF
 ;
@@ -135 +168 @@
     msg = 'eee : the directory' + iodirout  + ' was not found.'
     ras = report(msg)
-    STOP
+    return, result
 ENDIF
 ;
 ; build SWR blnd data filename
-filename_swr_blnd="TropFlux_swr_19890101_20091231_BLND.nc"
+filename_swr_blnd="TropFlux_swr_' +  string(yyyymmddb,format='(I8.8)') + '_' + string(yyyymmdde,format='(I8.8)') + '_BLND.nc"
 ;
 ; check if this file exists
@@ -148 +181 @@
    msg = 'eee : the file ' + fullfilename_swr_blnd + ' was not found.'
    ras = report(msg)
-   STOP
+   return, result
 ENDIF
 ;
 ; build LWR data filename
-filename_lwr="TropFlux_lwr_19890101_20091231.nc"
+filename_lwr="TropFlux_lwr_' +  string(yyyymmddb,format='(I8.8)') + '_' + string(yyyymmdde,format='(I8.8)') + '.nc"
 ;
 ; check if this file exists
@@ -161 +194 @@
    msg = 'eee : the file ' + fullfilename_lwr + ' was not found.'
    ras = report(msg)
-   STOP
+   return, result
 ENDIF
 ;
 ;  build COARE data filename
-filename_coare="TropFlux_19890101_20091231_coarev3.nc"
+filename_coare="TropFlux_' +  string(yyyymmddb,format='(I8.8)') + '_' + string(yyyymmdde,format='(I8.8)') + '_coarev3.nc"
 ;
 ; check if this file exists
@@ -174 +207 @@
    msg = 'eee : the file ' + fullfilename_coare + ' was not found.'
    ras = report(msg)
-   STOP
-ENDIF
-;
-filename_out='TropFlux_19890101_20091231.nc'
+   return, result
+ENDIF
+;
+filename_out='TropFlux_' +  string(yyyymmddb,format='(I8.8)') + '_' + string(yyyymmdde,format='(I8.8)') + '.nc'
 fullfilename_out = iodirout + filename_out
 ; in order to avoid unexpected overwritten
-IF (FILE_TEST(fullfilename_out) EQ 1) THEN BEGIN
+IF ((FILE_TEST(fullfilename_out) EQ 1)  AND (project_overwrite EQ 0)) THEN BEGIN
    msg = 'eee : the file ' + fullfilename_out  + ' already exists.'
    ras = report(msg)
-   STOP
-ENDIF
-;
-st=19800101
-en=20101231
+   return, result
+ENDIF
 ;
 initncdf, fullfilename_swr_blnd
 ;
-swr=read_ncdf("swr", st, en, file=fullfilename_swr_blnd,/nostr)
+swr=read_ncdf("swr", yyyymmddb - .5d, yyyymmdde, file=fullfilename_swr_blnd,/nostr)
+timein=24.d*(time-julday(1,1,1957,0,0,0))
+jpt=n_elements(timein)
+da=jul2date(time[0])
+cda0=string(da,format='(i8.8)')
+da=jul2date(time[jpt-1])
+cda1=string(da,format='(i8.8)')
+print, 'swr in tropflux_nrt_ncdf first date ', cda0
+print, 'swr in tropflux_nrt_ncdf last date ' , cda1
 ;
 initncdf, fullfilename_lwr
-lwr=read_ncdf("lwr", st, en, file=fullfilename_lwr,/nostr)
+lwr=read_ncdf("lwr", yyyymmddb - .5d, yyyymmdde, file=fullfilename_lwr,/nostr)
+timein=24.d*(time-julday(1,1,1957,0,0,0))
+jpt=n_elements(timein)
+da=jul2date(time[0])
+cda0=string(da,format='(i8.8)')
+da=jul2date(time[jpt-1])
+cda1=string(da,format='(i8.8)')
+print, 'lwr in tropflux_nrt_ncdf first date ', cda0
+print, 'lwr in tropflux_nrt_ncdf last date ' , cda1
 ;
 initncdf, fullfilename_coare
-lhf=read_ncdf("lhf", st, en, file=fullfilename_coare,/nostr)
-shf=read_ncdf("shf", st, en, file=fullfilename_coare,/nostr)
+lhf=read_ncdf("lhf", yyyymmddb - .5d, yyyymmdde, file=fullfilename_coare,/nostr)
+timein=24.d*(time-julday(1,1,1957,0,0,0))
+jpt=n_elements(timein)
+da=jul2date(time[0])
+cda0=string(da,format='(i8.8)')
+da=jul2date(time[jpt-1])
+cda1=string(da,format='(i8.8)')
+print, 'lhf in tropflux_nrt_ncdf first date ', cda0
+print, 'lhf in tropflux_nrt_ncdf last date ' , cda1
+;
+shf=read_ncdf("shf", yyyymmddb - .5d, yyyymmdde, file=fullfilename_coare,/nostr)
+timein=24.d*(time-julday(1,1,1957,0,0,0))
+jpt=n_elements(timein)
+da=jul2date(time[0])
+cda0=string(da,format='(i8.8)')
+da=jul2date(time[jpt-1])
+cda1=string(da,format='(i8.8)')
+print, 'shf in tropflux_nrt_ncdf first date ', cda0
+print, 'shf in tropflux_nrt_ncdf last date ' , cda1
 ;
 help, swr, lwr, lhf, shf
 ;
-time=timegen(7670, start=julday(1,1,1989,0), units='days')
-jpt=n_elements(time)
-;
-cda0=string(jul2date(time(0)),format='(i8.8)')
-cda1=string(jul2date(time(jpt-1)),format='(i8.8)')
-;
-time=time-julday(1,1,1950,00,00)
-;
-lat=reform(gphit(0,0:jpj-1))
-lon=reform(glamt(0:jpi-1,0))
+lat=reform(gphit[0,0:jpj-1])
+lon=reform(glamt[0:jpi-1,0])
 ;
 ncfile='!' + fullfilename_out
@@ -223 +278 @@
 lh_attr={units:'w/m^2',missing_value:1.e20,long_name:'Latent Heat Flux',short_name:'lhf',axis:'TYX'}
 ;
-ncfields = 'swr[longitude,latitude,time]=swr:sw_attr; ' $
-          +'lwr[longitude,latitude,time]=lwr:lw_attr; ' $
-          +'lhf[longitude,latitude,time]=lhf:lh_attr; ' $
-          +'shf[longitude,latitude,time]=shf:sh_attr; ' $
+ncfields = 'swr[longitude,latitude,*time]=swr:sw_attr; ' $
+          +'lwr[longitude,latitude,*time]=lwr:lw_attr; ' $
+          +'lhf[longitude,latitude,*time]=lhf:lh_attr; ' $
+          +'shf[longitude,latitude,*time]=shf:sh_attr; ' $
                       + 'longitude[]=lon:lon_attr; ' $
                       + 'latitude[]=lat:lat_attr; ' $
-                      + 'time[*time]=time:time_attr ' $
+                      + 'time[]=timein:time_attr ' $
                       + ' @ globattr'
 ;
 @ncdf_quickwrite
 ;
+result = 0
+return, result
+;
 end

trunk/src/tropflux_swr_blnd.pro

@@ -29 +29 @@
 ;
 ; This file will be used by
-; :ref:`TropFlux_NRT_ncdf.pro`.
+; :func:`tropflux_nrt_ncdf`.
 ;
 ;     .. graphviz::
@@ -66 +66 @@
 ; :func:`ncdf_quickwrite <saxo:ncdf_quickwrite>`
 ;
-; :ref:`Tropflux_NRT_ncdf.pro`
+; :func:`tropflux_nrt_ncdf`
 ;
 ; EXAMPLES