source: lmdz_wrf/trunk/tools/documentation/plotting/2lines_time.html @ 1873

Last change on this file since 1873 was 1515, checked in by lfita, 8 years ago

Adding documentation for `2lines_time'
File size: 4.3 KB
Line 
1<HTML>
2  <HEAD>
3    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=utf-8"/>
4    <LINK REL="stylesheet" TYPE="text/css" HREF="../PyNCplot.css"/>
5  </HEAD>
6
7  </HEAD>
8  <BODY>
9    <DIV CLASS="valheader">
10      draw_2lines_time:
11    </DIV>
12    <DIV CLASS="valimg">
13      Function to plot two time-lines in different axes (x/x2 or y/y2)
14      <IMG WIDTH="100%" SRC="figs/forcing_Amazonia_tas-wss.png"></IMG>
15    </DIV>
16    <DIV CLASS="valhelp">
17     draw_2lines_time(ncfiles, values, varnames)<BR>
18     &nbsp;&nbsp;values= [timevardim]:[varangeA]:[varangeB]:[timeaxisfmt]:[timeaxis]:[figvarns]:[colors]:<BR>
19     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[widths]:[styles]:[sizemarks]:[marks]:[graphtitle]:[labelaxis]:[legvals]:[figname]:[figkind]:[close]<BR>
20     &nbsp;&nbsp;&nbsp;&nbsp;[timevardim]: name of the common variable-dimension time<BR>
21     &nbsp;&nbsp;&nbsp;&nbsp;[varangeA]: ',' separated list of range (min,max) for A values ('None', automatic from<BR>     
22     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'variables_values'; 'Extrs' from values extremes)<BR>
23     &nbsp;&nbsp;&nbsp;&nbsp;[varangeB]: ',' separated list of range (min,max) for B values ('None', automatic from<BR> 
24     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'variables_values'; 'Extrs' from values extremes)<BR>
25     &nbsp;&nbsp;&nbsp;&nbsp;[timeaxisfmt]=[tkind];[tfmt]: format of the ticks for the time axis:<BR>
26     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[kind]: kind of time to appear in the graph<BR>
27     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'Nval': according to a given number of values as 'Nval',[Nval]<BR>
28     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'exct': according to an exact time unit as 'exct',[tunit]; <BR>
29     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tunit= [Nunits],[tu]; [tu]= 'c': centuries, 'y': year, 'm': month,<BR>
30     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'w': week, 'd': day, 'h': hour, 'i': minute, 's': second, <BR>
31     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'l': milisecond<BR>
32     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[tfmt]; desired format<BR>
33     &nbsp;&nbsp;&nbsp;&nbsp;[timeaxis]: which is the time axis in the plot ('x' or 'y')<BR>
34     &nbsp;&nbsp;&nbsp;&nbsp;[figvarns]: ',' separated list of names of the variables in the  plot<BR>
35     &nbsp;&nbsp;&nbsp;&nbsp;[colors]: ',' list with color names of the lines for the variables ('None', automatic)<BR>
36     &nbsp;&nbsp;&nbsp;&nbsp;[widths]: ',' list with widths of the lines for the variables ('None', automatic)<BR>
37     &nbsp;&nbsp;&nbsp;&nbsp;[styles]: ',' list with the styles of the lines ('None', automatic)<BR>
38     &nbsp;&nbsp;&nbsp;&nbsp;[sizemarks]: ',' list with the size of the markers of the lines ('None', for 2.,2.)<BR>
39     &nbsp;&nbsp;&nbsp;&nbsp;[marks]: ';' list with the markers of the lines ('None', automatic)<BR>
40     &nbsp;&nbsp;&nbsp;&nbsp;[graphtitle]: title of the figure ('!' for spaces)<BR>
41     &nbsp;&nbsp;&nbsp;&nbsp;[labelaxis]: label in the figure of the common axis ('!' for spaces)<BR>
42     &nbsp;&nbsp;&nbsp;&nbsp;[legvals]=[locleg]|[fontsize]: <BR>
43     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[locleg]: location of the legend (0, autmoatic)<BR>
44     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1: 'upper right', 2: 'upper left', 3: 'lower left', 4: 'lower right',<BR>
45     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;5: 'right', 6: 'center left', 7: 'center right', 8: 'lower center',<BR>
46     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;9: 'upper center', 10: 'center'<BR>
47     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[fontsize]: font size for the legend (auto for 12)<BR>
48     &nbsp;&nbsp;&nbsp;&nbsp;[figname]: name of the figure<BR>
49     &nbsp;&nbsp;&nbsp;&nbsp;[figkind]: kind of figure<BR>
50     &nbsp;&nbsp;&nbsp;&nbsp;[close]: Whether figure should be finished or not<BR>
51     &nbsp;&nbsp;ncfiles= ',' separated list of files to use<BR>
52     &nbsp;&nbsp;varnames=  ',' separated list of variables names in the files to plot<BR>
53R>
54    </DIV>
55    <DIV CLASS="valins">
56      $ python ${pyHOME}/drawing.py -f forcing_Amazonia.nc,forcing_Amazonia.nc -o draw_2lines_time -S 'tstep:Excts:Excts:exct,5,y;%Y:x:tas,wss:r,b:2.:-,-:None:,;,:WFD!forcing!evolution!at!Amazonia:year:0|12:forcing_Amazonia_tas-wss:png:yes' -v Tair,Wind
57    </DIV>
58  </BODY>
59</HTML>
60
Note: See TracBrowser for help on using the repository browser.