source: TI03-DataExtractor/branches/old_stuff/dx/doc/userInterface.html @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx/doc/userInterface.html@793
Revision 793, 8.2 KB checked in by astephen, 13 years ago (diff)

Put all the old code in the old_stuff branch.

  • Property svn:executable set to *
Line 
1
2<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module userInterface</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>userInterface</strong></big></big></font></td
10><td align=right valign=bottom
11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/dx-0.1.1/userInterface.py">/usr/local/dx-0.1.1/userInterface.py</a></font></td></tr></table>
12    <p><tt>userInterface.py<br>
13================<br>
14&nbsp;<br>
15Output&nbsp;module&nbsp;for&nbsp;the&nbsp;data&nbsp;extractor&nbsp;package.<br>
16&nbsp;<br>
17This&nbsp;module&nbsp;holds&nbsp;the&nbsp;<a href="#UserInterface">UserInterface</a>&nbsp;class&nbsp;that&nbsp;is&nbsp;used<br>
18to&nbsp;write&nbsp;HTML&nbsp;output&nbsp;from&nbsp;the&nbsp;data&nbsp;extractor&nbsp;package.</tt></p>
19<p>
20<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
21<tr bgcolor="#aa55cc">
22<td colspan=3 valign=bottom>&nbsp;<br>
23<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
24   
25<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
26<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br>
27</td><td width="25%" valign=top><a href="smtplib.html">smtplib</a><br>
28</td><td width="25%" valign=top><a href="string.html">string</a><br>
29</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
30</td></tr></table></td></tr></table><p>
31<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
32<tr bgcolor="#ee77aa">
33<td colspan=3 valign=bottom>&nbsp;<br>
34<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
35   
36<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
37<td width="100%"><dl>
38<dt><font face="helvetica, arial"><a href="userInterface.html#UserInterface">UserInterface</a>
39</font></dt></dl>
40 <p>
41<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
42<tr bgcolor="#ffc8d8">
43<td colspan=3 valign=bottom>&nbsp;<br>
44<font color="#000000" face="helvetica, arial"><a name="UserInterface">class <strong>UserInterface</strong></a></font></td></tr>
45   
46<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
47<td colspan=2><tt><a href="#UserInterface">UserInterface</a>&nbsp;class&nbsp;-&nbsp;used&nbsp;to&nbsp;generate&nbsp;interactive&nbsp;output&nbsp;based&nbsp;on&nbsp;user&nbsp;requests<br>
48and&nbsp;available&nbsp;datasets.&nbsp;Typically&nbsp;steps&nbsp;through&nbsp;the&nbsp;following&nbsp;stages:<br>
491.&nbsp;datasetGroup&nbsp;page<br>
502.&nbsp;dataset&nbsp;page<br>
513.&nbsp;variables&nbsp;page<br>
524.&nbsp;domain&nbsp;page<br>
53Current&nbsp;version&nbsp;only&nbsp;creates&nbsp;HTML&nbsp;output.<br>&nbsp;</tt></td></tr>
54<tr><td>&nbsp;</td>
55<td width="100%">Methods defined here:<br>
56<dl><dt><a name="UserInterface-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>__init__&nbsp;method&nbsp;-&nbsp;prints&nbsp;the&nbsp;http&nbsp;header.</tt></dd></dl>
57
58<dl><dt><a name="UserInterface-writeDomainOptions"><strong>writeDomainOptions</strong></a>(self, request)</dt></dl>
59
60<dl><dt><a name="UserInterface-writeFooter"><strong>writeFooter</strong></a>(self, footfile<font color="#909090">='/usr/local/dx_wv/html/footer.html'</font>)</dt><dd><tt>writeFooter&nbsp;method&nbsp;-&nbsp;writes&nbsp;the&nbsp;footer&nbsp;section&nbsp;present&nbsp;on&nbsp;all&nbsp;<br>
61output&nbsp;pages&nbsp;of&nbsp;the&nbsp;dx.</tt></dd></dl>
62
63<dl><dt><a name="UserInterface-writeForm"><strong>writeForm</strong></a>(self, request, stage<font color="#909090">=0</font>)</dt></dl>
64
65<dl><dt><a name="UserInterface-writeHeader"><strong>writeHeader</strong></a>(self, headfile<font color="#909090">='/usr/local/dx_wv/html/header.html'</font>)</dt><dd><tt>writeHeader&nbsp;method&nbsp;-&nbsp;writes&nbsp;the&nbsp;header&nbsp;section&nbsp;present&nbsp;on&nbsp;all<br>
66output&nbsp;pages&nbsp;of&nbsp;the&nbsp;dx.</tt></dd></dl>
67
68<dl><dt><a name="UserInterface-writeOutputPage"><strong>writeOutputPage</strong></a>(self)</dt></dl>
69
70<dl><dt><a name="UserInterface-writePage"><strong>writePage</strong></a>(self, request, stage)</dt></dl>
71
72<dl><dt><a name="UserInterface-writeRequestInfo"><strong>writeRequestInfo</strong></a>(self, request, stage<font color="#909090">=0</font>)</dt></dl>
73
74<dl><dt><a name="UserInterface-writeResults"><strong>writeResults</strong></a>(self, request)</dt></dl>
75
76</td></tr></table></td></tr></table><p>
77<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
78<tr bgcolor="#55aa55">
79<td colspan=3 valign=bottom>&nbsp;<br>
80<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
81   
82<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
83<td width="100%"><strong>ADMIN_MAIL_ADDRESS</strong> = 'badc@rl.ac.uk'<br>
84<strong>ADMIN_NOTIFICATION</strong> = 0<br>
85<strong>BASEDIR</strong> = '/usr/local/dx_wv'<br>
86<strong>CDAT_BIN_PATH</strong> = '/usr/local/cdat/bin'<br>
87<strong>CF_METADATA_GLOBAL_ATTRIBUTES</strong> = ['Conventions', 'title', 'source', 'institution', 'history', 'references', 'comment']<br>
88<strong>CGI_NAME</strong> = 'http://localhost/cgi-bin/dxui-0.1.1.py'<br>
89<strong>DATASETS</strong> = {'Test Data Group 1': (('Test Dataset 1', '/usr/local/dx_wv/testdata/testdata1.xml', 'dataset1-unused-code'),), 'Test Data Group 2': (('Test Dataset 2', '/usr/local/dx_wv/testdata/testdata2.xml', 'dataset2-unused-code'),), 'Test Data Group 3': (('Test Dataset 3', '/usr/local/dx_wv/testdata/testdata3.xml', 'dataset3-unused-code'),)}<br>
90<strong>DATASET_GROUPS</strong> = {'Test Data Group 1': None, 'Test Data Group 2': None, 'Test Data Group 3': None}<br>
91<strong>DEBUG</strong> = 1<br>
92<strong>DOMAIN_PARAMS</strong> = ('start_time', 'end_time', 'time_interval', 'horiz_domain', 'resolution', 'vertical_units', 'vertical_domain', 'output_type')<br>
93<strong>EXTRAS_DIR</strong> = '/dx_extra'<br>
94<strong>HORIZ_KEYS</strong> = ('northernExtent', 'easternExtent', 'southernExtent', 'westernExtent')<br>
95<strong>HTML_DIR</strong> = '/usr/local/dx_wv/html'<br>
96<strong>HTTP_HEADER</strong> = 'Content-Type: text/html<font color="#c040c0">\n\n</font>'<br>
97<strong>HTTP_OUTPUT_DIR</strong> = 'http://localhost/output'<br>
98<strong>LEFT_LOGO</strong> = 'dx_logo.jpg'<br>
99<strong>LOCAL_CGI_NAME</strong> = '/srv/www/cgi-bin/dxui-0.1.1.py'<br>
100<strong>LOCAL_MAIL_HOST</strong> = 'outbox.rl.ac.uk'<br>
101<strong>LOCAL_PYTHONPATH</strong> = ['/usr/local/badcdat/lib', '/usr/local/badcdat/lib/python', '/home/tornado/internal/badc/software/pythonlib/badc', '/usr/local/cdat/lib/python2.3', '/usr/local/cdat/lib/python2.3/site-packages', '/usr/local/cdat/lib/python2.3/site-packages/Numeric']<br>
102<strong>LOCAL_RULES</strong> = 0<br>
103<strong>LOGO_DIR</strong> = '/dx_extra/logos'<br>
104<strong>MAP_APPLET</strong> = '/dx_extra/LiveMap_30/extractorMap.html'<br>
105<strong>MESSAGE_TO_USERS</strong> = 'This is a test version of the Data Extractor so ...error occurs so that we can improve this service.'<br>
106<strong>OUTPUT_DIR</strong> = '/srv/www/htdocs/output'<br>
107<strong>OUTPUT_DIR_PERMISSION</strong> = 488<br>
108<strong>OUTPUT_FILE_GROUP</strong> = 'users'<br>
109<strong>OUTPUT_FILE_PERMISSION</strong> = 416<br>
110<strong>OUTPUT_FILE_USER</strong> = 'wwwrun'<br>
111<strong>OUTPUT_FORMATS</strong> = ['NetCDF']<br>
112<strong>PACKAGE_NAME</strong> = 'Data Extractor'<br>
113<strong>REGISTRATION_PAGE</strong> = 'http://badc.nerc.ac.uk/data/list_all_datasets.html?source=home'<br>
114<strong>REQUEST_DIR</strong> = '/usr/local/dx_wv/requests'<br>
115<strong>REQUEST_SIZE_LIMIT</strong> = 100<br>
116<strong>RESTRICTED_DATA</strong> = 0<br>
117<strong>RIGHT_LOGO</strong> = 'dx_logo.jpg'<br>
118<strong>STAGES</strong> = ['DatasetGroupPage', 'DatasetPage', 'VariablesPage', 'DomainPage', 'ResultsPage']<br>
119<strong>TIME_KEYS</strong> = ('year', 'month', 'day', 'hour', 'min', 'sec')<br>
120<strong>TIMING_SCALE_FACTOR</strong> = 0.001<br>
121<strong>USER_HOMEDIR</strong> = '/var/lib/wwwrun'<br>
122<strong>VISUALISOR_NAME</strong> = '/cgi-bin/splatui-0.1.1.py'</td></tr></table>
123</body></html>
Note: See TracBrowser for help on using the repository browser.