Changeset 83 for trunk/src

Timestamp:

08/17/11 11:00:48 (13 years ago)

Author:

pinsard

Message:

complete doc in new tools from PK

Location:

trunk/src

Files:

• time_axe_modif_tropflux_1d_1989_2010.pro (modified) (2 diffs)
• ws_tropflux_1d_to_1m_ncdf.pro (modified) (3 diffs)

trunk/src/time_axe_modif_tropflux_1d_1989_2010.pro

@@ +1 @@
+;+
+;
+; .. _time_axe_modif_tropflux_1d_1989_2010.pro:
+;
+; ========================================
+; time_axe_modif_tropflux_1d_1989_2010.pro
+; ========================================
+;
+;     .. graphviz::
+;
+;        digraph time_axe_modif_tropflux_1d_1989_2010 {
+;
+;           file_inout [shape=ellipse,fontname=Courier,label="/Volumes/PAYASAM/TropFlux/ERA_C_1989_2010/ws_tropflux_1d_1989_2010.nc"];
+;
+;           time_axe_modif_tropflux_1d_1989_2010 [shape=box,
+;           fontname=Courier,
+;           color=blue,
+;           URL="http://forge.ipsl.jussieu.fr/tropflux/browser/trunk/src/time_axe_modif_tropflux_1d_1989_2010.pro",
+;           label="${PROJECT}/src/time_axe_modif_tropflux_1d_1989_2010.pro"];
+;
+;           {file_inout} -> {time_axe_modif_tropflux_1d_1989_2010} -> {file_inout}
+;
+;        }
+;
+;
+; SEE ALSO
+; ========
+;
+; :func:`julday <saxo:julday>`
+;
+; :ref:`time_axe_modif_TropFlux.pro`
+;
+; EXAMPLES
+; ========
+;
+; ::
+;
+;  IDL> time_axe_modif_tropflux_1d_1989_2010
+;
+; TODO
+; ====
+;
+; if needed include in the whole process
+;
+; hard coded directory - usage of ${PROJECT_ID}
+;
+; coding rules
+;
+; EVOLUTIONS
+; ==========
+;
+; $Id$
+;
+; $URL$
+;
+; - fplod 20110817T084839Z aedon.locean-ipsl.upmc.fr (Darwin)
+;
+;   * minimal header
+;
+; - pk 20110815
+;
+;   * provided to fp
+;
+;-
 pro time_axe_modif_tropflux_1d_1989_2010
 
@@ -23 +87 @@
 ncdf_control, cdfid ,/REDEF ; put in define mode
 ;
-; reading attributs of time  
+; reading attributs of time
 ;
 varid=ncdf_varid(cdfid,'time')

trunk/src/ws_tropflux_1d_to_1m_ncdf.pro

@@ +1 @@
+;+
+;
+; .. _ws_tropflux_1d_to_1m_ncdf.pro:
+;
+; =============================
+; ws_tropflux_1d_to_1m_ncdf.pro
+; =============================
+;
+; DESCRIPTION
+; ===========
+;
+; convert wind daily file to monthly file
+;
+; :file:`${PROJECT_OD}/ws_tropflux_1d_1989_2010.nc`
+; containing daily ++
+; has been produced by ++
+;
+; Montly ++
+; is written in
+; :file:`${PROJECT_OD}/ws_tropflux_1m_1989_2010.nc`
+; if this file not already exists.
+;
+;     .. graphviz::
+;
+;        digraph ws_tropflux_1d_to_1m_ncdf {
+;
+;           file_1d [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/ws_tropflux_1d_1989_2010.nc"];
+;           file_1m [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/ws_tropflux_1m_1989_2010.nc"];
+;
+;           ws_tropflux_1d_to_1m_ncdf [shape=box,
+;           fontname=Courier,
+;           color=blue,
+;           URL="http://forge.ipsl.jussieu.fr/tropflux/browser/trunk/src/ws_tropflux_1d_to_1m_ncdf.pro",
+;           label="${PROJECT}/src/ws_tropflux_1d_to_1m_ncdf.pro"];
+;
+;           {file_1d} -> {ws_tropflux_1d_to_1m_ncdf} -> {file_1m}
+;
+;         }
+;
+; SEE ALSO
+; ========
+;
+; :ref:`project_profile.sh`
+;
+; EXAMPLES
+; ========
+;
+; ::
+;
+;  IDL> ws_tropflux_1d_to_1m_ncdf
+;
+; TODO
+; ====
+;
+; remove hard coded creation date
+;
+; include in the whole process
+;
+; any NCO or CDO equivalent ?
+;
+; EVOLUTIONS
+; ==========
+;
+; $Id$
+;
+; $URL$
+;
+; - fplod 20110817T084001Z aedon.locean-ipsl.upmc.fr (Darwin)
+;
+;   * usage of ${PROJECT_OD}
+;   * header
+;
+; - pk 20110815
+;
+;   * provided to fp
+;
+;-
 pro ws_tropflux_1d_to_1m_ncdf
-@common
-;-----------------------------------------------------------------------------
-file="/Volumes/PAYASAM/TropFlux/ERA_C_1989_2010/ws_tropflux_1d_1989_2010.nc"
-initncdf, file
+;
+@cm_4cal
+@cm_4data
+@cm_4mesh
+@cm_4data
+@cm_project
+;
+; test if ${PROJECT_OD} defined
+CASE project_od_env OF
+  '' : BEGIN
+         msg = 'eee : ${PROJECT_OD} is not defined'
+         ras = report(msg)
+       STOP
+       END
+  ELSE: BEGIN
+          msg = 'iii : ${PROJECT_OD} is ' + project_od_env
+          ras = report(msg)
+        END
+ ENDCASE
+;
+; check if output data will be possible
+iodirout = isadirectory(project_od_env)
+;
+; existence and protection for reading
+IF (FILE_TEST(iodirout, /DIRECTORY, /EXECUTABLE, /READ) EQ 0) THEN BEGIN
+   msg = 'eee : the directory' + iodirout  + ' is not accessible.'
+   ras = report(msg)
+   STOP
+ENDIF
+;
+; existence and protection for writing
+IF (FILE_TEST(iodirout, /DIRECTORY, /WRITE) EQ 0) THEN BEGIN
+    msg = 'eee : the directory' + iodirout  + ' was not found.'
+    ras = report(msg)
+    STOP
+ENDIF
+;
+; build 1d filename
+filename="ws_tropflux_1d_1989_2010.nc"
+;
+; check if this file exists
+fullfilename = isafile(iodirout + filename, NEW=0, /MUST_EXIST)
+IF fullfilename[0] EQ '' THEN BEGIN
+   msg = 'eee : the file ' + fullfilename + ' was not found.'
+   ras = report(msg)
+   STOP
+ENDIF
+;
+; build output filename
+filename_out = 'ws_tropflux_1m_1989_2010.nc'
+fullfilename_out = iodirout + filename_out
+; in order to avoid unexpected overwritten
+IF (FILE_TEST(fullfilename_out) EQ 1) THEN BEGIN
+   msg = 'eee : the file ' + fullfilename_out  + ' already exists.'
+   ras = report(msg)
+   STOP
+ENDIF
+;
+initncdf, fullfilename
 st=19890101 & en=20101231
-ws=read_ncdf("ws", st, en, file=file,/nostr)
+ws=read_ncdf("ws", st, en, file=fullfilename,/nostr)
 
 help, ws
@@ -33 +165 @@
 xlon=reform(glamt(firstxt:lastxt,0) ) & ylat=reform(gphit(0,firstyt:lastyt))
 
-ncfile='!/Volumes/PAYASAM/TropFlux/ERA_C_1989_2010/ws_tropflux_1m_1989_2010.nc'
+ncfile='!' + fullfilename_out
 
 lon_attr={units:'degrees_east',long_name:'Longitude'}
@@ -51 +183 @@
 @ncdf_quickwrite
 
-;------------------------------------------------------------
 return