Changeset 1279 in lmdz_wrf for trunk/tools

Timestamp:

Nov 8, 2016, 2:36:14 PM (8 years ago)

Author:

lfita

Message:

Adding right description of variable slice

File:

• trunk/tools/drawing.py (modified) (9 diffs)

trunk/tools/drawing.py

@@ -108 +108 @@
         [vnamefs]: Name in the figure of the variable to be shaded
         [dimvals]: ',' list of [dimname]|[value] telling at which dimension of the 
-          variable a given value is required (-1, all the length)
+          variable a given value is required:
+            * [integer]: which value of the dimension
+            * -1: all along the dimension
+            * -9: last value of the dimension
+            * [beg]@[end]@[inc] slice from [beg] to [end] every [inc]
+            * NOTE, no dim name all the dimension size
         [dimx/yvn]: name of the variables with the values of the final dimensions (x,y)
         [dimxyfmt]=[dxs],[dxf],[Ndx],[ordx],[dys],[dyf],[Ndy],[ordx]: format of the values at each axis (or 'auto')
@@ -291 +296 @@
         [vnamefs]: Name in the figure of the variable to be shaded
         [dimvals]: ',' list of [dimname]|[value] telling at which dimension of the 
-          variable a given value is required (-1, all the length, [beg]@[end] for an interval)
+          variable a given value is required:
+            * [integer]: which value of the dimension
+            * -1: all along the dimension
+            * -9: last value of the dimension
+            * [beg]@[end]@[inc] slice from [beg] to [end] every [inc]
+            * NOTE, no dim name all the dimension size
         [dimx/yvn]: name of the variables with the values of the final dimensions (x,y)  ('WRFtime' for WRF times)
         [dimvfmt]=[dvs],[dvf],[Ndv],[ordv]: format of the values for the non-temporal axis (or 'auto')
@@ -523 +533 @@
         [vnamefs],[vnamefc]: Name in the figure of the shaded and the contour variables
         [dimvals/c]: list of [dimname]|[value] telling at which dimension of the 
-          variable a given value is required (no dimension name, all the length)
+          variable a given value is required:
+            * [integer]: which value of the dimension
+            * -1: all along the dimension
+            * -9: last value of the dimension
+            * [beg]@[end]@[inc] slice from [beg] to [end] every [inc]
+            * NOTE, no dim name all the dimension size
         [dimx/yvn]: names of the variables with the values of the dimensions for the plot
         [dimxyfmt]=[dxf],[Ndx],[dyf],[Ndy]: format of the values at each axis
@@ -786 +801 @@
         [vnamefs],[vnamefc]: Name in the figure of the shaded and the contour variables
         [dimvals/c]: list of [dimname]|[value] telling at which dimension of the 
-          variable a given value is required (no dimension name, all the length)
+          variable a given value is required:
+            * [integer]: which value of the dimension
+            * -1: all along the dimension
+            * -9: last value of the dimension
+            * [beg]@[end]@[inc] slice from [beg] to [end] every [inc]
+            * NOTE, no dim name all the dimension size
         [dimxvn]: name of the variables with the values of the dimension of the x-axis ('WRFtime' for WRF times)
         [dimyvn]: name of the variables with the values of the dimension of the y-axis ('WRFtime' for WRF times)
@@ -1073 +1093 @@
         [vnamefl]: Name in the figure of the variable to be lined
         [dimvals]: ',' list of [dimname]|[value] telling at which dimension of the 
-          variable a given value is required (-1, all the length)
+          variable a given value is required:
+            * [integer]: which value of the dimension
+            * -1: all along the dimension
+            * -9: last value of the dimension
+            * [beg]@[end]@[inc] slice from [beg] to [end] every [inc]
+            * NOTE, no dim name all the dimension size
         [dimx/yvn]: name of the variables with the values of the final dimensions (x,y)
         [dimxyfmt]=[dxs],[dxf],[Ndx],[ordx],[dys],[dyf],[Ndy],[ordx]: format of the values at each axis (or 'auto')
@@ -1292 +1317 @@
         [vnamefl]: Name in the figure of the variable to be lined
         [dimvals]: ',' list of [dimname]|[value] telling at which dimension of the 
-          variable a given value is required (-1, all the length)
+          variable a given value is required:
+            * [integer]: which value of the dimension
+            * -1: all along the dimension
+            * -9: last value of the dimension
+            * [beg]@[end]@[inc] slice from [beg] to [end] every [inc]
+            * NOTE, no dim name all the dimension size
         [dimx/yvn]: name of the variables with the values of the final dimensions (x,y)
         [dimxyfmt]=[dxs],[dxf],[Ndx],[ordx],[dys],[dyf],[Ndy],[ordx]: format of the values at each axis (or 'auto')
@@ -2962 +2992 @@
         [dimval]: '@' list of [dimn]|[dimval] to get the values for [varn]
           [dimn]: name of the dimension
-          [dimval]: value of the dimension (no value all range)
+          [dimval]: value of the dimension variable a given value is required:
+            * [integer]: which value of the dimension
+            * -1: all along the dimension
+            * -9: last value of the dimension
+            * [beg]@[end]@[inc] slice from [beg] to [end] every [inc]
+            * NOTE, no dim name all the dimension size
         [vargn]: name of the variable in the graph
         [min]: minimum value for the extra variable
@@ -3770 +3805 @@
           [dimname]: name of the dimension in the file
           [vardimname]: name of the variable with the values for the dimension in the file
-          [value]: which value of the given dimension (-1, all; [ibeg]@[iend], i-range beginning, end)
+          [value]: which value of the given dimension is required:
+            * [integer]: which value of the dimension
+            * -1: all along the dimension
+            * -9: last value of the dimension
+            * [beg]:[end] slice from [beg] to [end]
+            * NOTE, no dim name all the dimension size
           No value takes all the range of the dimension
         [vecvals]= [frequency],[color],[length]
@@ -4190 +4230 @@
           [dimname]: name of the dimension in the file
           [vardimname]: name of the variable with the values for the dimension in the file
-          [value]: which value of the given dimension (-1, all; [ibeg]@[iend], i-range beginning, end)
+          [value]: which value of the given dimension is required:
+            * [integer]: which value of the dimension
+            * -1: all along the dimension
+            * -9: last value of the dimension
+            * [beg]:[end] slice from [beg] to [end]
+            * NOTE, no dim name all the dimension size
           No value takes all the range of the dimension
         [basinsvals]= [colorline]