source: geosplat/trunk/geosplat_source/for_usr_local/geosplat/doc/INSTALLATION.txt @ 274

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/geosplat/trunk/geosplat_source/for_usr_local/geosplat/doc/INSTALLATION.txt@274
Revision 274, 6.4 KB checked in by astephen, 16 years ago (diff)

* empty log message *

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1GeoSPlAT Installation Manual - Version 0.1.1
2============================================
3
4GeoSPlAT in 2 lines:
5====================
6A python-based simple plotting and animation tool designed for GeoSpatial
7datasets requiring a web-server and CDAT to run.
8
9===================
101. VERY QUICK START
11===================
12
13NOTE: You are very unlikely to be able to install geosplat
14without being root on your system as directories and files
15are being copied in various places.
16
171. Decompress the distribution file with:
18
19$ gunzip geosplat-0.1.1.tar.gz
20$ tar -xvf geosplat-0.1.1.tar
21
222. Change directory into the 'geosplat_source' directory.
23
243. Change the variables in the 'config.py' file to make sure the
25appropriate directories on your machine are pointed to. The minimum
26set of config variables you are likely to need to change is:
27
28- BASEDIR
29- USER_HOMEDIR
30- CGI_DIR
31- CGI_NAME
32- LOCAL_EXTRAS_DIR
33- OUTPUT_DIR
34- HTTP_OUTPUT_DIR
35- OUTPUT_FILE_USER
36- OUTPUT_FILE_GROUP
37- LOCAL_PYTHONPATH
38- CDAT_BIN_PATH
39
404. Run the setup script:
41
42$ python ./setup.py
43
445. Allow external hosts to contact the local xhost by typing:
45
46$ xhost +
47
486. Try running 'splatui.py' (or whatever you renamed it to) via a web-browser.
49The URL will be that which you defined in the CGI_NAME file in the 'config.py'
50file.
51
52Happy splatting!
53
54Alternatively...
55
56======================
572. MANUAL INSTALLATION
58======================
59
60If the automated setup did not work here is a more detailed explanation.
61
622.1 Requirements and dependencies
63
64You will need the following to run GeoSPlAT on your machine:
65Operating System:
66
67Unix/Linux (tested on RedHat 7.3 and SUSE 9.1).
68Webserver: Tested on Apache (comes as standard in Linux).
69CDAT-3.3 or greater: Includes Python and VCS visualisation package.
70
712.2 Where to get the GeoSPlAT package
72
73The GeoSPlAT package can be downloaded from the author's web
74site at:
75
76http://home.badc.rl.ac.uk/astephens/software/geosplat/
77
78You will be directed to the latest version in a gzipped tar
79file (.tar.gz).
80
812.3 Contents of the GeoSPlAT package
82
83When you (g)unzip and decompress (tar -xvf) the downloaded
84file you will find the following directories:
85
86i. geosplat_source/for_cgi_bin/ - this directory contains
87the one python module that controls the package and acts as
88a CGI script (normally splatui.py). This must be installed
89within the webserver's CGI area (or any directory visible via
90the web with read and execute permission for files).
91
92ii. geosplat_source/for_usr_local/ - this directory contains
93the actual GeoSPlAT package itself and is usually copied to
94/usr/local/dx/. These are all the modules that define the
95routines and objects called by the splatui.py CGI script.
96This directory also contain various sub-directories:
97    html/ - holds HTML page content for building a web interface.
98    plotTemplates/ - holds plot templates used by GeoSPlAT.
99    doc/ - holds documentation for GeoSPlAT.
100
101iii. geosplat_source/for_static_web/ - this directory contains
102the sub-directory dx_extra (from the dx sister package) which in
103turn holds the CSS style sheet for the web interface and the
104GeoSPlAT logo under the logos directory.
105
106*********THIS SECTION HAS NOT BEEN COMPLETED YET, SORRY!***********
107
108===================
1093. TROUBLE SHOOTING
110===================
111
112The following problems will probably occur quite often.
113
114Problem: The web interface works but just stops when it tries
115to produce a plot or animation.
116
117Solution: You need to set up your local x-server host to allow
118other machines to generate output on the local host. This is
119done by typing:
120 
121$ xhost +
122
123You may have to do this as root and leave that terminal window
124open whilst the web-server is running.
125
126Problem: The interface does not work at all.
127
128Solution: Check the paths in the config.py file are all correct.
129Check that the main interface module (normally splatui.py) is
130in a directory that has read and execute permissions (normally
131cgi-bin). Check that the apache webserver is running. You might
132be able to run it using: /usr/sbin/apache2ctl -k start
133
134Problem: Plots and animations have the top 20% cropped from the
135image. This was observed when tested on SUSE Linux 9.1.
136
137Solution: Search for the following line in module plotClasses.py
138and uncomment it as follows:
139CURRENT LINE:   # self.canvas.open()
140REPLACE WITH:   self.canvas.open()
141
142Problem: A python shelve error occurs such as:
143Traceback (most recent call last):
144  File "<stdin>", line 1, in ?
145  File "/usr/local/cdat-3.3/lib/python2.2/shelve.py", line 158, in open
146    return DbfilenameShelf(filename, flag)
147  File "/usr/local/cdat-3.3/lib/python2.2/shelve.py", line 148, in __init__
148    Shelf.__init__(self, anydbm.open(filename, flag))
149  File "/usr/local/cdat-3.3/lib/python2.2/anydbm.py", line 86, in open
150    return mod.open(file, flag, mode)
151gdbm.error: (2, 'No such file or directory')
152
153Solution: In the interface module (normally splatui.py) add a
154line after the 'sys' module has been imported:
155sys.path.append('usr/lib/python2.2/lib-dynload')
156If this does not work try locating the directory 'lib-dynload' under
157any python installation you have. Then add that diredtory path
158instead of that above.
159
160Problem: Errors occur saying that modules cannot be found.
161
162Solution: Check that all the paths are correct in the config.py module.
163
164===============
1654. FUTURE PLANS
166===============
167
168* geosplat should know when two datasets have been differenced (maybe
169in a variable attribute or just a varname 'xxx_minus_yyy') so it can
170say this is a differenced variable.
171
172* geosplat should know the length of the variable name and move the
173title across a bit if required on the plot.
174
175* analyse data in geosplat for feature instances.
176
177* allow 2 variables to go into geosplat so that scatterplot and vector
178plot capabilities can be exploited.
179
180* geosplat should allow multiple plots per page
181
182* understand how to plot trajectories etc in vcs, how easily could we
183put that functionality (currently in IDL) under geosplat.
184
185* dx should be able to take a complete query from B-metadata selection
186(such as search term, geo and temporal constraints) and a result set
187(of URIs). It should be flexible enough to work out what it doesn't
188have and get the user to provide that before delivering.
189
190* introduce long version of templates in case they don't exist.
191
192===========
1935. FEEDBACK
194===========
195
196Please help make GeoSPlAT better by sending me your mods,
197extensions, comments etc.
198
199Ag Stephens (<a.stephens@rl.ac.uk>), BADC, 15th September 2004.
Note: See TracBrowser for help on using the repository browser.