source: lmdz_wrf/trunk/tools/documentation/generic/intro.html @ 2736

Last change on this file since 2736 was 1223, checked in by lfita, 8 years ago

Adding `generic'
Fixing some issues
File size: 3.5 KB
RevLine 
[1223]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  <BODY>
8    <DIV CLASS="valheader">
9      generic functions
10    </DIV>
11    <DIV CLASS="valintro">
12      In order to maximize the work done, an effort to make available also the generic functions is carried out with this script.
13      Most of them follow a similar structure:<BR>
14      <PRE><CODE>
15        $ python generic.py -o [operation] -S [values]
16      </CODE></PRE>
17      In most of the cases <SPAN CLASS="codetxt">[values]</SPAN> is a string which contains a list of values separated by a character <SPAN CLASS="codetxt">[sep]</SPAN>, becomming the value as:
18      <PRE><CODE>
19      [values]=[val1][sep][val2][sep][...[valN]]</CODE></PRE>
20      One can obtain all the list of operations and their instructions by demanding to the script:
21      <PRE><CODE>
22        $ python generic.py -o list_operations
23      </CODE></PRE>
24      For almost all operations, one can obtain all the help of a specific operation by:
25      <PRE><CODE>
26        $ python generic.py -o [operation] -S h
27      </CODE></PRE>
28      One should be able to obtain an example of execution by
29      <PRE><CODE>
30        $ cat generic.py | grep [operation] | grep 'e.g.'
31      </CODE></PRE>
32      Available operations:
33      <UL>
34       <LI><SPAN CLASS="codetxt">coincident_CFtimes:</SPAN> Function to make coincident times for two different sets of CFtimes
35       <LI><SPAN CLASS="codetxt">count_cond:</SPAN> Function to count values of a variable which attain a condition
36       <LI><SPAN CLASS="codetxt">datetimeStr_conversion:</SPAN> Function to transform a string date to an another date object
37       <LI><SPAN CLASS="codetxt">grid_combinations:</SPAN> Function to provide all the possible grid points combination for a given pair of values
38       <LI><SPAN CLASS="codetxt">  x,y= pair of grid points
39       <LI><SPAN CLASS="codetxt">interpolate_locs:</SPAN> Function to provide interpolate locations on a given axis
40       <LI><SPAN CLASS="codetxt">PolyArea:</SPAN> Function to compute the area of the polygon following 'Shoelace formula'
41       <LI><SPAN CLASS="codetxt">radial_points:</SPAN> Function to provide a number of grid point positions for a given angle
42       <LI><SPAN CLASS="codetxt">radius_dist:</SPAN> Function to generate a matrix with the distance at a given point
43       <LI><SPAN CLASS="codetxt">rmNOnum:</SPAN> Removing from a string all that characters which are not numbers
44       <LI><SPAN CLASS="codetxt">running_mean:</SPAN> Function to compute a running mean of a series of values
45       <LI><SPAN CLASS="codetxt">significant_decomposition:</SPAN> Function to decompose a given number by its signifcant potencies
46       <LI><SPAN CLASS="codetxt">squared_radial:</SPAN> Function to provide the series of radii as composite of pairs (x,y) of gid cells
47       <LI><SPAN CLASS="codetxt">  Npt= largest amount of grid points on x and y directions
48       <LI><SPAN CLASS="codetxt">table_tex_file:</SPAN> Function to write into a file a LaTeX tabular from a table of values
49       <LI><SPAN CLASS="codetxt">unitsDate:</SPAN> Function to know how many units of time are from a given pair of dates
50       <LI><SPAN CLASS="codetxt">variables_values:</SPAN> Function to provide values to plot the different variables values from ASCII file
51       <LI><SPAN CLASS="codetxt">wdismean:</SPAN> Function to compute the mean value weighted to its 4 distances
52      </UL>
53    </DIV>
54   
55  </BODY>
56</HTML>
57
Note: See TracBrowser for help on using the repository browser.